Class: ToggleStatusBar
Defined in: src/garminsdk/components/common/ToggleStatusBar.tsx:20
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.
Extends
DisplayComponent<ToggleStatusBarProps>
Constructors
Constructor
new ToggleStatusBar(
props):ToggleStatusBar
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
| Parameter | Type | Description |
|---|---|---|
props | ToggleStatusBarProps | The propertis of the component. |
Returns
ToggleStatusBar
Inherited from
DisplayComponent<ToggleStatusBarProps>.constructor
Properties
context?
optionalcontext: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
DisplayComponent.context
contextType?
readonlyoptionalcontextType: readonly [] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
props
props:
ToggleStatusBarProps&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/components/common/ToggleStatusBar.tsx:55
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
getContext()
protectedgetContext(context):never
Defined in: src/sdk/components/FSComponent.ts:106
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():
void
Defined in: src/garminsdk/components/common/ToggleStatusBar.tsx:27
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
onBeforeRender()
onBeforeRender():
void
Defined in: src/sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
render()
render():
VNode
Defined in: src/garminsdk/components/common/ToggleStatusBar.tsx:38
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render