Class: DurationDisplay
A component which displays duration values.
Hierarchy
DisplayComponent<DurationDisplayProps>↳
DurationDisplay
Constructors
constructor
• new DurationDisplay(props): DurationDisplay
Parameters
| Name | Type |
|---|---|
props | DurationDisplayProps |
Returns
Inherit Doc
Overrides
Defined in
src/sdk/components/common/DurationDisplay.tsx:119
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:67
props
• props: DurationDisplayProps & ComponentProps
The properties of the component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:61
DEFAULT_OPTIONS
▪ Static Readonly DEFAULT_OPTIONS: Readonly<DurationDisplayOptions>
Default formatting options.
Defined in
src/sdk/components/common/DurationDisplay.tsx:93
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Overrides
Defined in
src/sdk/components/common/DurationDisplay.tsx:267
getContext
▸ getContext(context): never
Gets a context data subscription from the context collection.
Parameters
| Name | Type | Description |
|---|---|---|
context | never | The 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
Defined in
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
A callback that is called after the component is rendered.
Returns
void
Overrides
DisplayComponent.onAfterRender
Defined in
src/sdk/components/common/DurationDisplay.tsx:135
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Renders the component.
Returns
A JSX element to be rendered.
Overrides
Defined in
src/sdk/components/common/DurationDisplay.tsx:260