Skip to main content

Class: SoftKeyBar

Defined in: src/garminsdk/softkey/SoftKeyBar.tsx:24

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.

Extends

Constructors

Constructor

new SoftKeyBar(props): SoftKeyBar

Defined in: src/sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsSoftKeyBarPropsThe propertis of the component.

Returns

SoftKeyBar

Inherited from

DisplayComponent<SoftKeyBarProps>.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context


contextType?

readonly optional contextType: 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: SoftKeyBarProps & 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/SoftKeyBar.tsx:71

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy


getContext()

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
contextneverThe 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/SoftKeyBar.tsx:33

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/SoftKeyBar.tsx:45

Renders the component.

Returns

VNode

The rendered component.

Overrides

DisplayComponent.render