Class MenuInput

Hierarchy (View Summary)

Menu
- MenuInput

Constructors

constructor

new MenuInput(data: MenuInputJson): MenuInput
Creates a new input menu with optional pre-configured value and callbacks.
Parameters
- data: MenuInputJson
  Menu JSON including name, type, optional value, and input-specific configs.
Returns MenuInput
Overrides Menu.constructor
- Defined in menus/input/index.ts:26

Methods

getValue

getValue(): string
Returns the current input value (the user's last answer).

Returns string
- Defined in menus/input/index.ts:50

setValue

setValue(v: string): this
Overrides the stored input value.
Parameters
- v: string
  New value string.
Returns this
- Defined in menus/input/index.ts:58

getGlobalChoices

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

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

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/input/index.ts:74

getConfigs

getConfigs(): MenuInputConfigs
Returns the configs object for this input menu.

Returns MenuInputConfigs
- Defined in menus/input/index.ts:82

setConfigs

setConfigs(data: MenuInputConfigs): this
Sets the configs from an instance or a plain JSON object.
Parameters
- data: MenuInputConfigs
  MenuInputConfigs instance or compatible JSON.
Returns this
- Defined in menus/input/index.ts:90
setConfigs(data: MenuInputConfigsJson): this
Sets the configs from an instance or a plain JSON object.
Parameters
- data: MenuInputConfigsJson
  MenuInputConfigs instance or compatible JSON.
Returns this
- Defined in menus/input/index.ts:91

getLabels

getLabels(): MenuInputLabels
Returns the input-specific labels (extends MenuLabels with placeholder).

Returns MenuInputLabels
Overrides Menu.getLabels
- Defined in menus/input/index.ts:100

getPlaceholder

getPlaceholder(language?: string): string | undefined
Returns the translated placeholder string, or undefined if not set.
Parameters
- Optionallanguage: string
  Optional language override.
Returns string | undefined
- Defined in menus/input/index.ts:108

getValidate

getValidate(): ((value: string) => string | boolean) | undefined
Returns the validation function, or undefined if not configured.

Returns ((value: string) => string | boolean) | undefined
- Defined in menus/input/index.ts:113

getCallback

getCallback(): | (
    (
        data: {
            menu: MenuInput;
            value: string;
            language?: string;
            parent?: string;
        },
    ) => Promise<void>
)
| undefined
Returns the submission callback, or undefined if not configured.

Returns
    | (
        (
            data: {
                menu: MenuInput;
                value: string;
                language?: string;
                parent?: string;
            },
        ) => Promise<void>
    )
    | undefined
- Defined in menus/input/index.ts:118

toJson

toJson(): MenuInputJson
Serialises this input menu to a plain JSON-compatible object.

Returns MenuInputJson
Overrides Menu.toJson
- Defined in menus/input/index.ts:125

run

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

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

`Protected`labels

labels: MenuInputLabels

`Protected`value

value: string = ""

`Protected`configs

configs: MenuInputConfigs = ...

`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

Class MenuInput

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns MenuInput

Methods

getValue

Returns string

setValue

Parameters

Returns this

getGlobalChoices

Returns (Separator | Choice)[]

setGlobalChoices

Parameters

Returns this

getConfigs

Returns MenuInputConfigs

setConfigs

Parameters

Returns this

Parameters

Returns this

getLabels

Returns MenuInputLabels

getPlaceholder

Parameters

Returns string | undefined

getValidate

Returns ((value: string) => string | boolean) | undefined

getCallback

Returns | ( ( data: { menu: MenuInput; value: string; language?: string; parent?: string; }, ) => Promise<void> ) | undefined

toJson

Returns MenuInputJson

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

setLabels

Parameters

Returns this

Parameters

Returns this

Returns
| (
(
data: {
menu: MenuInput;
value: string;
language?: string;
parent?: string;
},
) => Promise<void>
)
| undefined

`Protected`type

`Protected`labels

`Protected`value

`Protected`configs

`Protected`globalChoices

`Protected`name

`Protected` `Optional`plugin

`Protected`parents

`Protected`index

`Protected`global

`Protected`anchorGlobal

`Protected`styles