Class MenuInputLabels

Hierarchy (View Summary)

MenuLabels
- MenuInputLabels

Index

Constructors

Methods

getPlaceholder setPlaceholder toJson getAnswer setAnswer getQuestion setQuestion getTitle setTitle getSuccess setSuccess getError setError

Properties

placeholder? answer? question? title? success? error?

Constructors

constructor

new MenuInputLabels(data: MenuInputLabelsJson): MenuInputLabels
Creates a new MenuInputLabels (extends MenuLabels) with optional placeholder.
Parameters
- data: MenuInputLabelsJson
  JSON object with optional question, title, success, error, answer, and placeholder translation keys.
Returns MenuInputLabels
Overrides MenuLabels.constructor
- Defined in menus/input/labels.ts:15

Methods

getPlaceholder

getPlaceholder(): Label | undefined
Returns the placeholder label, or undefined if not set.

Returns Label | undefined
- Defined in menus/input/labels.ts:21

setPlaceholder

setPlaceholder(placeholder: Label): this
Sets the placeholder label from a Label instance or a translation key string.
Parameters
- placeholder: Label
  Label instance or translation key.
Returns this
- Defined in menus/input/labels.ts:30
setPlaceholder(
    placeholder: string,
    callback?: (
        value: string | undefined,
        translate: (value: string) => string | undefined,
    ) => string,
): this
Sets the placeholder label from a Label instance or a translation key string.
Parameters
- placeholder: string
  Label instance or translation key.
- Optionalcallback: (
  value: string | undefined,
  translate: (value: string) => string | undefined,
  ) => string
  Optional interpolation callback forwarded to the Label.
Returns this
- Defined in menus/input/labels.ts:32

toJson

toJson(): MenuInputLabelsJson
Serialises the input labels to a plain JSON-compatible object.

Returns MenuInputLabelsJson
Overrides MenuLabels.toJson
- Defined in menus/input/labels.ts:48

getAnswer

getAnswer(name?: string): Label | undefined
Returns the answer label. When a name suffix is provided, a new Label is derived by appending .name to the base key.
Parameters
- Optionalname: string
  Optional suffix appended to the label's translation key.
Returns Label | undefined
Inherited from MenuLabels.getAnswer
- Defined in menus/labels.ts:35

setAnswer

setAnswer(answer: Label): this
Sets the answer label from a Label instance or a translation key string.
Parameters
- answer: Label
  Label instance or translation key.
Returns this
Inherited from MenuLabels.setAnswer
- Defined in menus/labels.ts:52
setAnswer(
    answer: string,
    callback?: (
        value: string | undefined,
        translate: (value: string) => string | undefined,
    ) => string,
): this
Sets the answer label from a Label instance or a translation key string.
Parameters
- answer: string
  Label instance or translation key.
- Optionalcallback: (
  value: string | undefined,
  translate: (value: string) => string | undefined,
  ) => string
  Optional interpolation callback forwarded to the Label.
Returns this
Inherited from MenuLabels.setAnswer
- Defined in menus/labels.ts:54

getQuestion

getQuestion(): Label | undefined
Returns the question label, or undefined if not set.

Returns Label | undefined
Inherited from MenuLabels.getQuestion
- Defined in menus/labels.ts:70

setQuestion

setQuestion(question: Label): this
Sets the question label from a Label instance or a translation key string.
Parameters
- question: Label
  Label instance or translation key.
Returns this
Inherited from MenuLabels.setQuestion
- Defined in menus/labels.ts:79
setQuestion(
    question: string,
    callback?: (
        value: string | undefined,
        translate: (value: string) => string | undefined,
    ) => string,
): this
Sets the question label from a Label instance or a translation key string.
Parameters
- question: string
  Label instance or translation key.
- Optionalcallback: (
  value: string | undefined,
  translate: (value: string) => string | undefined,
  ) => string
  Optional interpolation callback forwarded to the Label.
Returns this
Inherited from MenuLabels.setQuestion
- Defined in menus/labels.ts:81

getTitle

getTitle(): Label | undefined
Returns the title label, or undefined if not set.

Returns Label | undefined
Inherited from MenuLabels.getTitle
- Defined in menus/labels.ts:97

setTitle

setTitle(title: Label): this
Sets the title label from a Label instance or a translation key string.
Parameters
- title: Label
  Label instance or translation key.
Returns this
Inherited from MenuLabels.setTitle
- Defined in menus/labels.ts:106
setTitle(
    title: string,
    callback?: (
        value: string | undefined,
        translate: (value: string) => string | undefined,
    ) => string,
): this
Sets the title label from a Label instance or a translation key string.
Parameters
- title: string
  Label instance or translation key.
- Optionalcallback: (
  value: string | undefined,
  translate: (value: string) => string | undefined,
  ) => string
  Optional interpolation callback forwarded to the Label.
Returns this
Inherited from MenuLabels.setTitle
- Defined in menus/labels.ts:108

getSuccess

getSuccess(): Label | undefined
Returns the success label, or undefined if not set.

Returns Label | undefined
Inherited from MenuLabels.getSuccess
- Defined in menus/labels.ts:122

setSuccess

setSuccess(success: Label): this
Sets the success label from a Label instance or a translation key string.
Parameters
- success: Label
  Label instance or translation key.
Returns this
Inherited from MenuLabels.setSuccess
- Defined in menus/labels.ts:131
setSuccess(
    success: string,
    callback?: (
        value: string | undefined,
        translate: (value: string) => string | undefined,
    ) => string,
): this
Sets the success label from a Label instance or a translation key string.
Parameters
- success: string
  Label instance or translation key.
- Optionalcallback: (
  value: string | undefined,
  translate: (value: string) => string | undefined,
  ) => string
  Optional interpolation callback forwarded to the Label.
Returns this
Inherited from MenuLabels.setSuccess
- Defined in menus/labels.ts:133

getError

getError(): Label | undefined
Returns the error label, or undefined if not set.

Returns Label | undefined
Inherited from MenuLabels.getError
- Defined in menus/labels.ts:149

setError

setError(error: Label): this
Sets the error label from a Label instance or a translation key string.
Parameters
- error: Label
  Label instance or translation key.
Returns this
Inherited from MenuLabels.setError
- Defined in menus/labels.ts:158
setError(
    error: string,
    callback?: (
        value: string | undefined,
        translate: (value: string) => string | undefined,
    ) => string,
): this
Sets the error label from a Label instance or a translation key string.
Parameters
- error: string
  Label instance or translation key.
- Optionalcallback: (
  value: string | undefined,
  translate: (value: string) => string | undefined,
  ) => string
  Optional interpolation callback forwarded to the Label.
Returns this
Inherited from MenuLabels.setError
- Defined in menus/labels.ts:160

Properties

`Protected` `Optional`placeholder

placeholder?: Label

`Protected` `Optional`answer

answer?: Label

`Protected` `Optional`question

question?: Label

`Protected` `Optional`title

title?: Label

`Protected` `Optional`success

success?: Label

`Protected` `Optional`error

error?: Label

Class MenuInputLabels

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns MenuInputLabels

Methods

getPlaceholder

Returns Label | undefined

setPlaceholder

Parameters

Returns this

Parameters

Returns this

toJson

Returns MenuInputLabelsJson

getAnswer

Parameters

Returns Label | undefined

setAnswer

Parameters

Returns this

Parameters

Returns this

getQuestion

Returns Label | undefined

setQuestion

Parameters

Returns this

Parameters

Returns this

getTitle

Returns Label | undefined

setTitle

Parameters

Returns this

Parameters

Returns this

getSuccess

Returns Label | undefined

setSuccess

Parameters

Returns this

Parameters

Returns this

getError

Returns Label | undefined

setError

Parameters

Returns this

Parameters

Returns this

Properties

Protected Optionalplaceholder

Protected Optionalanswer

Protected Optionalquestion

Protected Optionaltitle

Protected Optionalsuccess

Protected Optionalerror

Settings

On This Page

`Protected` `Optional`placeholder

`Protected` `Optional`answer

`Protected` `Optional`question

`Protected` `Optional`title

`Protected` `Optional`success

`Protected` `Optional`error