Skip to main content

Interface: SoftKeyProps

Component props for SoftKey.

Hierarchy​

  • ComponentProps

    ↳ SoftKeyProps

Properties​

children​

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from​

ComponentProps.children

Defined in​

src/sdk/components/FSComponent.ts:122

class​

• Optional class: string | SubscribableSet<string>

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

Defined in​

src/garminsdk/softkey/SoftKey.tsx:20

• menuItem: Subscribable<null | SoftKeyMenuItem>

The menu item to bind to the softkey.

Defined in​

src/garminsdk/softkey/SoftKey.tsx:11

pressedDuration​

• Optional pressedDuration: number

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

Defined in​

src/garminsdk/softkey/SoftKey.tsx:17

ref​

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from​

ComponentProps.ref

Defined in​

src/sdk/components/FSComponent.ts:125