Class MenuFieldOption

Index

Constructors

Methods

getValue setValue isMulti getIndex getItem getLabels setLabels getStyles setStyles toJson

Properties

value labels multi styles

Constructors

constructor

new MenuFieldOption(
    value: string | Action | Menu,
    multi?: boolean,
    labels?: MenuFieldOptionLabelsJson,
    styles?: MenuStylesJson,
): MenuFieldOption
Creates a new menu field option from a value (string, Menu, or Action).
Parameters
- value: string | Action | Menu
  String label, Menu instance, or Action instance.
- Optionalmulti: boolean
  Optional flag for multi-line display.
- Optionallabels: MenuFieldOptionLabelsJson
  Optional label customizations.
- Optionalstyles: MenuStylesJson
  Optional style customizations.
Returns MenuFieldOption
- Defined in menus/field/option/index.ts:26

Methods

getValue

getValue(): string
Returns the display value: string label or the referenced Menu/Action name.

Returns string
- Defined in menus/field/option/index.ts:41

setValue

setValue(value: string | Action | Menu): this
Replaces the underlying value.
Parameters
- value: string | Action | Menu
  String label, Menu instance, or Action instance.
Returns this
- Defined in menus/field/option/index.ts:49

isMulti

isMulti(): boolean
Returns true when this option is flagged for multi-line rendering.

Returns boolean
- Defined in menus/field/option/index.ts:55

getIndex

getIndex(): number | undefined
Returns the display index if the value is a Menu or Action, or undefined for string values.

Returns number | undefined
- Defined in menus/field/option/index.ts:60

getItem

getItem(): Action | Menu | undefined
Returns the underlying Menu or Action instance, or undefined if this is a string value.

Returns Action | Menu | undefined
- Defined in menus/field/option/index.ts:65

getLabels

getLabels(): MenuFieldOptionLabels
Returns the labels container for this option.

Returns MenuFieldOptionLabels
- Defined in menus/field/option/index.ts:70

setLabels

setLabels(labels: MenuFieldOptionLabelsJson | MenuFieldOptionLabels): this
Sets the labels from an instance or a plain JSON object.
Parameters
- labels: MenuFieldOptionLabelsJson | MenuFieldOptionLabels
  MenuFieldOptionLabels instance or compatible JSON.
Returns this
- Defined in menus/field/option/index.ts:78

getStyles

getStyles(): MenuStyles
Returns the styles container for this option.

Returns MenuStyles
- Defined in menus/field/option/index.ts:84

setStyles

setStyles(styles: MenuStylesJson | MenuStyles): this
Sets the styles from an instance or a plain JSON object.
Parameters
- styles: MenuStylesJson | MenuStyles
  MenuStyles instance or compatible JSON.
Returns this
- Defined in menus/field/option/index.ts:92

toJson

toJson(): MenuFieldOptionJson
Serialises this option to a plain JSON-compatible object.

Returns MenuFieldOptionJson
- Defined in menus/field/option/index.ts:98

Properties

`Protected`value

value: string | Action | Menu

`Protected`labels

labels: MenuFieldOptionLabels

`Protected`multi

multi: boolean

`Protected`styles

styles: MenuStyles