Skip to main content

Interface: SoftKeyProps

Defined in: src/garminsdk/softkey/SoftKey.tsx:9

Component props for SoftKey.

Extends​

  • ComponentProps

Properties​

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

ComponentProps.children

class?​

optional class: string | SubscribableSet<string>

Defined in: src/garminsdk/softkey/SoftKey.tsx:20

CSS class(es) to apply to the softkey's root element.

menuItem: Subscribable<null | SoftKeyMenuItem>

Defined in: src/garminsdk/softkey/SoftKey.tsx:11

The menu item to bind to the softkey.

pressedDuration?​

optional pressedDuration: number

Defined in: src/garminsdk/softkey/SoftKey.tsx:17

The amount of time, in milliseconds, to display the softkey pressed animation after the softkey has been pressed. Defaults to SoftKey.DEFAULT_PRESSED_DURATION.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref