Class: UserSettingToggleControl<T, K, P>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingToggleControl.tsx:20

A component which controls the value of a boolean setting using an ArrowToggle.

Extends

• DisplayComponent<P>

Type Parameters

Type Parameter	Default type
T extends UserSettingRecord	-
K extends keyof UserSettingValueFilter<T, boolean> & string	-
P extends UserSettingToggleControlProps<T, K>	UserSettingToggleControlProps<T, K>

Constructors

Constructor

new UserSettingToggleControl<T, K, P>(props): UserSettingToggleControl<T, K, P>

Defined in: sdk/components/FSComponent.ts:76

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	P	The propertis of the component.

Returns

UserSettingToggleControl<T, K, P>

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

Defined in: sdk/components/FSComponent.ts:67

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:70

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

props

props: P & ComponentProps

Defined in: sdk/components/FSComponent.ts:64

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: sdk/components/FSComponent.ts:101

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:109

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:90

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:83

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

render()

render(): VNode

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingToggleControl.tsx:26

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render