Class: SoftKey
Defined in: src/garminsdk/softkey/SoftKey.tsx:26
An individual Garmin softkey tab display.
Extends
DisplayComponent<SoftKeyProps>
Constructors
Constructor
new SoftKey(
props):SoftKey
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
| Parameter | Type | Description |
|---|---|---|
props | SoftKeyProps | The propertis of the component. |
Returns
SoftKey
Inherited from
DisplayComponent<SoftKeyProps>.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:
SoftKeyProps&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/softkey/SoftKey.tsx:178
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/softkey/SoftKey.tsx:58
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/softkey/SoftKey.tsx:156
Renders the component.
Returns
VNode
The rendered component VNode.
Overrides
DisplayComponent.render