Skip to main content

Interface: SoftKeyMenuItem

Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:8

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

Properties​

cssClass​

readonly cssClass: SetSubject<string>

Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:28

CSS classes to apply to the root element of this menu item.


disabled​

readonly disabled: Subject<boolean>

Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:16

Whether this menu item is disabled.


handler()?​

optional handler: (menu) => void

Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:13

The handler to invoke when this menu item is pressed.

Parameters​

ParameterType
menuSoftKeyMenu

Returns​

void


highlighted​

readonly highlighted: Subject<boolean>

Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:25

Whether this menu item is highlighted.


label​

readonly label: Subject<string>

Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:10

The label for this menu item.


pressed​

readonly pressed: SubEvent<SoftKeyMenu, void>

Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:19

An event that fires when this menu item is pressed.


value​

readonly value: Subject<string | boolean | undefined>

Defined in: src/garminsdk/softkey/SoftKeyMenu.ts:22

The value of this menu item, if any.