Interface: UserSettingToggleControlProps<T, K>
Component props for UserSettingToggleControl.
Type parameters
| Name | Type |
|---|---|
T | extends UserSettingRecord |
K | extends keyof UserSettingValueFilter<T, boolean> & string |
Hierarchy
UserSettingControlProps<T,K>↳
UserSettingToggleControlProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
UserSettingControlProps.children
Defined in
sdk/components/FSComponent.ts:122
class
• Optional class: string
The CSS class(es) to apply to the root of the component.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:19
falseText
• Optional falseText: string
The text representation of the false setting value. Defaults to 'false'.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingToggleControl.tsx:11
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
sdk/components/FSComponent.ts:125
registerFunc
• registerFunc: (ctrl: UiControl<UiControlProps>, unregister?: boolean) => void
The function to use to register the UI control(s) used by the component.
Type declaration
▸ (ctrl, unregister?): void
The function to use to register the UI control(s) used by the component.
Parameters
| Name | Type |
|---|---|
ctrl | UiControl<UiControlProps> |
unregister? | boolean |
Returns
void
Inherited from
UserSettingControlProps.registerFunc
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:16
settingManager
• settingManager: UserSettingManager<T>
The setting manager associated with the controlled setting.
Inherited from
UserSettingControlProps.settingManager
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:10
settingName
• settingName: K
The name of the controlled setting.
Inherited from
UserSettingControlProps.settingName
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:13
trueText
• Optional trueText: string
The text representation fo the true setting value. Defaults to 'true'.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingToggleControl.tsx:14