Skip to main content

Interface: SoftKeyMenuItem

A Garmin softkey menu item. Defines the display and behavior of a softkey.

Properties​

disabled​

• Readonly disabled: Subject<boolean>

Whether this menu item is disabled.

Defined in​

src/garminsdk/softkey/SoftKeyMenu.ts:17

handler​

• Optional handler: (menu: SoftKeyMenu) => void

The handler to invoke when this menu item is pressed.

Type declaration​

▸ (menu): void

The handler to invoke when this menu item is pressed.

Parameters​
NameType
menuSoftKeyMenu
Returns​

void

Defined in​

src/garminsdk/softkey/SoftKeyMenu.ts:14

highlighted​

• Readonly highlighted: Subject<boolean>

Whether this menu item is highlighted.

Defined in​

src/garminsdk/softkey/SoftKeyMenu.ts:26

label​

• Readonly label: Subject<string>

The label for this menu item.

Defined in​

src/garminsdk/softkey/SoftKeyMenu.ts:11

pressed​

• Readonly pressed: SubEvent<SoftKeyMenu, void>

An event that fires when this menu item is pressed.

Defined in​

src/garminsdk/softkey/SoftKeyMenu.ts:20

value​

• Readonly value: Subject<undefined | string | boolean>

The value of this menu item, if any.

Defined in​

src/garminsdk/softkey/SoftKeyMenu.ts:23