Class: SoftKeyBar
A Garmin softkey bar display. Each softkey bar has 12 softkey tabs. The behavior and display of each softkey tab is defined by the current softkey menu of the display's softkey menu system.
Hierarchy
DisplayComponent<SoftKeyBarProps>↳
SoftKeyBar
Constructors
constructor
• new SoftKeyBar(props): SoftKeyBar
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | SoftKeyBarProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<SoftKeyBarProps>.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: SoftKeyBarProps & 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/softkey/SoftKeyBar.tsx:71
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/softkey/SoftKeyBar.tsx:33
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
Renders the component.
Returns
VNode
The rendered component.
Overrides
DisplayComponent.render
Defined in
src/garminsdk/softkey/SoftKeyBar.tsx:45