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