Skip to main content

Abstract Class: Modal<P>

Defined in: workingtitle-instruments-epic2/shared/Modals/Modal.tsx:16

The Modal component.

Extends​

Extended by​

Type Parameters​

Type ParameterDefault type
P extends ModalPropsModalProps

Constructors​

Constructor​

new Modal<P>(props): Modal<P>

Defined in: sdk/components/FSComponent.ts:76

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsPThe propertis of the component.

Returns​

Modal<P>

Inherited from​

DisplayComponent.constructor

Properties​

context?​

optional context: [] = undefined

Defined in: sdk/components/FSComponent.ts:67

The context on this component, if any.

Inherited from​

DisplayComponent.context


contextType?​

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:70

The type of context for this component, if any.

Inherited from​

DisplayComponent.contextType


props​

props: P & ComponentProps

Defined in: sdk/components/FSComponent.ts:64

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

close()​

protected close(): void

Defined in: workingtitle-instruments-epic2/shared/Modals/Modal.tsx:33

Closes this modal.

Returns​

void


destroy()​

destroy(): void

Defined in: sdk/components/FSComponent.ts:101

Destroys this component.

Returns​

void

Inherited from​

DisplayComponent.destroy


getContext()​

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:109

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
contextneverThe context to get the subscription for.

Returns​

never

The requested context.

Throws​

An error if no data for the specified context type could be found.

Inherited from​

DisplayComponent.getContext


onAfterRender()​

onAfterRender(): void

Defined in: workingtitle-instruments-epic2/shared/Modals/Modal.tsx:18

A callback that is called after the component is rendered.

Returns​

void

Overrides​

DisplayComponent.onAfterRender


onBeforeRender()​

onBeforeRender(): void

Defined in: sdk/components/FSComponent.ts:83

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DisplayComponent.onBeforeRender


onPause()​

onPause(): void

Defined in: workingtitle-instruments-epic2/shared/Modals/Modal.tsx:28

Called when modal is closed.

Returns​

void


onResume()​

onResume(): void

Defined in: workingtitle-instruments-epic2/shared/Modals/Modal.tsx:23

Called when modal is opened.

Returns​

void


render()​

abstract render(): VNode | null

Defined in: sdk/components/FSComponent.ts:96

Renders the component.

Returns​

VNode | null

A JSX element to be rendered.

Inherited from​

DisplayComponent.render