Class: FloatingRadioItem
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioItem.tsx:19
Extends
DisplayComponent
<FloatingRadioItemProps
>
Constructors
Constructor
new FloatingRadioItem(
props
):FloatingRadioItem
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | FloatingRadioItemProps | The propertis of the component. |
Returns
FloatingRadioItem
Inherited from
DisplayComponent<FloatingRadioItemProps>.constructor
Properties
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
DisplayComponent.context
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
isEnabled
isEnabled:
Subject
<boolean
>
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioItem.tsx:20
props
props:
FloatingRadioItemProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
getContext()
protected
getContext(context
):never
Defined in: sdk/components/FSComponent.ts:106
Gets a context data subscription from the context collection.
Parameters
Parameter | 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
DisplayComponent.getContext
onAfterRender()
onAfterRender(
node
):void
Defined in: sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
DisplayComponent.onAfterRender
onBeforeRender()
onBeforeRender():
void
Defined in: sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
render()
render():
null
|VNode
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioItem.tsx:43
Returns
null
| VNode
Inherit Doc
Overrides
DisplayComponent.render
setIsChecked()
setIsChecked(
value
):void
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioItem.tsx:38
Sets whether the radio item is checked
Parameters
Parameter | Type | Description |
---|---|---|
value | boolean | the value to set |
Returns
void
setIsEnabled()
setIsEnabled(
value
):void
Defined in: workingtitle-instruments-wt21/shared/Menus/Components/FloatingRadioItem.tsx:29
Sets whether the radio item is enabled
Parameters
Parameter | Type | Description |
---|---|---|
value | boolean | the value to set |
Returns
void