Class: ToggleStatusBar
A status bar which depicts an on/off state.
The root element of the status bar contains the toggle-status-bar CSS class by default. The root element also
conditionally contains the toggle-status-bar-on class when the status bar's bound state is on.
Hierarchy
DisplayComponent<ToggleStatusBarProps>↳
ToggleStatusBar
Constructors
constructor
• new ToggleStatusBar(props): ToggleStatusBar
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | ToggleStatusBarProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<ToggleStatusBarProps>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
src/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
src/sdk/components/FSComponent.ts:67
props
• props: ToggleStatusBarProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/garminsdk/components/common/ToggleStatusBar.tsx:55
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
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
src/garminsdk/components/common/ToggleStatusBar.tsx:27
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/garminsdk/components/common/ToggleStatusBar.tsx:38