Class: RadioBox
The RadioBox component.
Hierarchy
DisplayComponent<RadioBoxProps>↳
RadioBox
Constructors
constructor
• new RadioBox(props): RadioBox
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | RadioBoxProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<RadioBoxProps>.constructor
Defined in
sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
Defined in
sdk/components/FSComponent.ts:67
isEnabled
• Readonly isEnabled: Subject<boolean>
Defined in
workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:27
props
• props: RadioBoxProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
Defined in
sdk/components/FSComponent.ts:98
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
DisplayComponent.getContext
Defined in
sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:49
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:62
setIsChecked
▸ setIsChecked(checked): void
Sets the checkmark in the RadioBox.
Parameters
| Name | Type | Description |
|---|---|---|
checked | boolean | The boolean indicating whether the box should be checked. |
Returns
void
Defined in
workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:44
setIsEnabled
▸ setIsEnabled(enabled): void
Sets the ability to check this box.
Parameters
| Name | Type | Description |
|---|---|---|
enabled | boolean | The boolean indicating whether the box should be checkable. |
Returns
void
Defined in
workingtitle-instruments-wt21/shared/Menus/Components/Radiobox.tsx:36