Class MenuEditor

Hierarchy (View Summary)

Menu
- MenuEditor

Index

Constructors

constructor

new MenuEditor(data: MenuEditorJson): MenuEditor
Creates a new editor menu that opens the system $EDITOR with pre-populated content.
Parameters
- data: MenuEditorJson
  Menu JSON including name, type, optional default content (static or dynamic), and editor-specific configs.
Returns MenuEditor
Overrides Menu.constructor
- Defined in menus/editor/index.ts:29

Methods

getValue

getValue(): string
Returns the last submitted editor content, or empty string if never run.

Returns string
- Defined in menus/editor/index.ts:40

getDefault

getDefault(): string
Resolves the default content: evaluates the function if dynamic, returns the string if static.

Returns string
- Defined in menus/editor/index.ts:47

setDefault

setDefault(v: string | MenuEditorDefaultFn): this
Sets the default content pre-populated in the editor. Accepts a static string or a function evaluated each time the editor opens.
Parameters
- v: string | MenuEditorDefaultFn
  Static string or dynamic function.
Returns this
- Defined in menus/editor/index.ts:60

getConfigs

getConfigs(): MenuEditorConfigs
Returns the configs object for this editor menu.

Returns MenuEditorConfigs
- Defined in menus/editor/index.ts:68

setConfigs

setConfigs(data: MenuEditorConfigs): this
Sets the configs from an instance or a plain JSON object.
Parameters
- data: MenuEditorConfigs
  MenuEditorConfigs instance or compatible JSON.
Returns this
- Defined in menus/editor/index.ts:76
setConfigs(data: MenuEditorConfigsJson): this
Sets the configs from an instance or a plain JSON object.
Parameters
- data: MenuEditorConfigsJson
  MenuEditorConfigs instance or compatible JSON.
Returns this
- Defined in menus/editor/index.ts:77

getLabels

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

Returns MenuLabels
Overrides Menu.getLabels
- Defined in menus/editor/index.ts:86

toJson

toJson(): MenuEditorJson
Serialises this editor menu to a plain JSON-compatible object.

Returns MenuEditorJson
Overrides Menu.toJson
- Defined in menus/editor/index.ts:93

run

run(language?: string): Promise<string>
Opens the system $EDITOR with the default content pre-populated. Returns the edited content string.
Parameters
- Optionallanguage: string
  Optional language override for label translation.
Returns Promise<string>
Overrides Menu.run
- Defined in menus/editor/index.ts:110

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

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" = "editor"

`Protected`labels

labels: MenuLabels

`Protected`default

default: string | MenuEditorDefaultFn = ""

`Protected`value

value: string = ""

`Protected`configs

configs: MenuEditorConfigs = ...

`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

Class MenuEditor

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns MenuEditor

Methods

getValue

Returns string

getDefault

Returns string

setDefault

Parameters

Returns this

getConfigs

Returns MenuEditorConfigs

setConfigs

Parameters

Returns this

Parameters

Returns this

getLabels

Returns MenuLabels

toJson

Returns MenuEditorJson

run

Parameters

Returns Promise<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

setLabels

Parameters

Returns this

Parameters

Returns this

Properties

Protectedtype

Protectedlabels

Protecteddefault

Protectedvalue

Protectedconfigs

Protectedname

Protected Optionalplugin

Protectedparents

Protectedindex

`Protected`type

`Protected`labels

`Protected`default

`Protected`value

`Protected`configs

`Protected`name

`Protected` `Optional`plugin

`Protected`parents

`Protected`index

`Protected`global

`Protected`anchorGlobal

`Protected`styles