Class MenuField

Hierarchy (View Summary)

Menu
- MenuField

Constructors

constructor

new MenuField(data: MenuFieldJson): MenuField
Creates a new field menu (composite choice+input menu) from JSON.
Parameters
- data: MenuFieldJson
  Menu JSON including name, type, optional choice/input values and configs.
Returns MenuField
Overrides Menu.constructor
- Defined in menus/field/index.ts:34

Methods

getChoice

getChoice(): MenuChoice | undefined
Returns the underlying choice menu if configured, or undefined.

Returns MenuChoice | undefined
- Defined in menus/field/index.ts:65

getInput

getInput(): MenuInput | undefined
Returns the underlying input menu if configured, or undefined.

Returns MenuInput | undefined
- Defined in menus/field/index.ts:70

hasChoices

hasChoices(): boolean
Returns true when a choice menu has been configured.

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

hasInput

hasInput(): boolean
Returns true when an input menu has been configured.

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

getOption

getOption(name: string): MenuFieldOption | undefined
Returns an option by name from the choice menu, or undefined if not found.
Parameters
- name: string
  Option value/name to look up.
Returns MenuFieldOption | undefined
- Defined in menus/field/index.ts:92

getOptions

getOptions(sorted?: boolean): MenuFieldOption[]
Returns the option list from the choice menu, optionally sorted for display.
Parameters
- sorted: boolean = false
  When true, applies the display-order sorting algorithm.
Returns MenuFieldOption[]
- Defined in menus/field/index.ts:100

getSelectedValues

getSelectedValues(): string[]
Returns the currently selected option names from the choice menu.

Returns string[]
- Defined in menus/field/index.ts:105

addOption

addOption(value: Action | Menu | MenuFieldOption | MenuChoiceJsonValue): this
Adds an option to the choice menu.
Parameters
- value: Action | Menu | MenuFieldOption | MenuChoiceJsonValue
  The option to add (Menu, Action, MenuFieldOption, or raw JSON value).
Returns this
- Defined in menus/field/index.ts:113

getGlobalChoices

getGlobalChoices(): (Separator | Choice)[]
Returns the global sidebar choices rendered alongside the menu.

Returns (Separator | Choice)[]
- Defined in menus/field/index.ts:123

setGlobalChoices

setGlobalChoices(choices: (Separator | Choice)[]): this
Replaces the global sidebar choices.
Parameters
- choices: (Separator | Choice)[]
  Array of Choice or Separator items.
Returns this
- Defined in menus/field/index.ts:131

toJson

toJson(): MenuFieldJson
Serialises this field menu to a plain JSON-compatible object.

Returns MenuFieldJson
Overrides Menu.toJson
- Defined in menus/field/index.ts:139

run

run(language?: string): Promise<string | string[]>
Renders and runs the field menu (choice + optional input).
Parameters
- Optionallanguage: string
  Optional language override for label translation.
Returns Promise<string | string[]>
Overrides Menu.run
- Defined in menus/field/index.ts:161

getName

getName(): string
Returns the menu's unique name.

Returns string
Inherited from Menu.getName
- Defined in menus/menu.ts:53

getType

getType(): "input" | "field" | "choice" | "editor"
Returns the menu type: "choice", "input", "field", or "editor".

Returns "input" | "field" | "choice" | "editor"
Inherited from Menu.getType
- Defined in menus/menu.ts:58

getPlugin

getPlugin(): string | undefined
Returns the plugin namespace this menu belongs to, or undefined for the default plugin.

Returns string | undefined
Inherited from Menu.getPlugin
- Defined in menus/menu.ts:63

setPlugin

setPlugin(plugin: string | undefined): this
Sets the plugin namespace for this menu.
Parameters
- plugin: string | undefined
  Plugin name string.
Returns this
Inherited from Menu.setPlugin
- Defined in menus/menu.ts:71

getIndex

getIndex(): number | undefined
Returns the display order index, or undefined if not set.

Returns number | undefined
Inherited from Menu.getIndex
- Defined in menus/menu.ts:77

setIndex

setIndex(index: number | undefined): this
Sets the display order index.
Parameters
- index: number | undefined
  Numeric sort position.
Returns this
Inherited from Menu.setIndex
- Defined in menus/menu.ts:85

getParents

getParents(): string[]
Returns all registered parent names as a flat array.

Returns string[]
Inherited from Menu.getParents
- Defined in menus/menu.ts:91

getParent

getParent(name: string): string | undefined
Returns the parent entry matching the given name, or undefined.
Parameters
- name: string
  Parent name to look up.
Returns string | undefined
Inherited from Menu.getParent
- Defined in menus/menu.ts:99

addParent

addParent(name: string): this
Registers a parent menu name.
Parameters
- name: string
  Parent name to add.
Returns this
Inherited from Menu.addParent
- Defined in menus/menu.ts:107

isGlobal

isGlobal(): boolean
Returns true when this menu is accessible from every context.

Returns boolean
Inherited from Menu.isGlobal
- Defined in menus/menu.ts:113

isAnchorGlobal

isAnchorGlobal(): boolean
Returns true when this menu is the anchor point of a wizard/flow. Global actions that target this menu will be hidden in this menu and in all its descendants, resolved through the regular parents chain.

Returns boolean
Inherited from Menu.isAnchorGlobal
- Defined in menus/menu.ts:122

getStyles

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

Returns MenuStyles
Inherited from Menu.getStyles
- Defined in menus/menu.ts:127

setStyles

setStyles(styles: MenuStyles): this
Sets the styles for this menu from an instance or a plain JSON object.
Parameters
- styles: MenuStyles
  MenuStyles instance or compatible JSON.
Returns this
Inherited from Menu.setStyles
- Defined in menus/menu.ts:135
setStyles(styles: MenuStylesJson): this
Sets the styles for this menu from an instance or a plain JSON object.
Parameters
- styles: MenuStylesJson
  MenuStyles instance or compatible JSON.
Returns this
Inherited from Menu.setStyles
- Defined in menus/menu.ts:136

getLabels

getLabels(): MenuLabels
Returns the labels container for this menu.

Returns MenuLabels
Inherited from Menu.getLabels
- Defined in menus/menu.ts:143

setLabels

setLabels(labels: MenuLabels): this
Sets the labels for this menu from an instance or a plain JSON object.
Parameters
- labels: MenuLabels
  MenuLabels instance or compatible JSON.
Returns this
Inherited from Menu.setLabels
- Defined in menus/menu.ts:151
setLabels(labels: MenuLabelsJson): this
Sets the labels for this menu from an instance or a plain JSON object.
Parameters
- labels: MenuLabelsJson
  MenuLabels instance or compatible JSON.
Returns this
Inherited from Menu.setLabels
- Defined in menus/menu.ts:152

Properties

`Protected`type

type: "input" | "field" | "choice" | "editor" = "field"

`Protected` `Optional`choice

choice?: MenuChoice

`Protected` `Optional`input

input?: MenuInput

`Protected`globalChoices

globalChoices: (Separator | Choice)[] = []

`Protected`name

name: string

`Protected` `Optional`plugin

plugin?: string

`Protected`parents

parents: Record<string, Exclude<MenuJson["parents"], undefined>[number]> = {}

`Protected`index

index: number | undefined

`Protected`global

global: boolean

`Protected`anchorGlobal

anchorGlobal: boolean

`Protected`styles

styles: MenuStyles

`Protected`labels

labels: MenuLabels

Class MenuField

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns MenuField

Methods

getChoice

Returns MenuChoice | undefined

getInput

Returns MenuInput | undefined

hasChoices

Returns boolean

hasInput

Returns boolean

getOption

Parameters

Returns MenuFieldOption | undefined

getOptions

Parameters

Returns MenuFieldOption[]

getSelectedValues

Returns string[]

addOption

Parameters

Returns this

getGlobalChoices

Returns (Separator | Choice)[]

setGlobalChoices

Parameters

Returns this

toJson

Returns MenuFieldJson

run

Parameters

Returns Promise<string | string[]>

getName

Returns string

getType

Returns "input" | "field" | "choice" | "editor"

getPlugin

Returns string | undefined

setPlugin

Parameters

Returns this

getIndex

Returns number | undefined

setIndex

Parameters

Returns this

getParents

Returns string[]

getParent

Parameters

Returns string | undefined

addParent

Parameters

Returns this

isGlobal

Returns boolean

isAnchorGlobal

Returns boolean

getStyles

Returns MenuStyles

setStyles

Parameters

Returns this

Parameters

Returns this

getLabels

Returns MenuLabels

setLabels

Parameters

Returns this

Parameters

Returns this

`Protected`type

`Protected` `Optional`choice

`Protected` `Optional`input

`Protected`globalChoices

`Protected`name

`Protected` `Optional`plugin

`Protected`parents

`Protected`index

`Protected`global

`Protected`anchorGlobal

`Protected`styles

`Protected`labels