Class CustomButton

Button with custom set of scripts.

Hierarchy

Constructors

constructor

Accessors

action disableWhen style

Methods

_setAction _setDisableWhen _setupCustomData setAction setDisableWhen setStyle

Constructors

constructor

Accessors

action

  • get action(): null | ButtonAction

  • Represents an action that should be completed after the button is pressed.

    Either a number of a page or a function that determines number of a page.

    Returns null | ButtonAction

disableWhen

  • get disableWhen(): null | ButtonDisableWhen

  • Represents a condition of disabling button.

    Either a number of a page or a function that determines number of a page.

    Returns null | ButtonDisableWhen

style

  • get style(): null | MessageButton

  • Style of this button.

    Returns null | MessageButton

Methods

Protected _setAction

Protected _setDisableWhen

Private _setupCustomData

  • _setupCustomData(data: CustomButton): void

  • Setups action and disableWhen from ButtonData.

    Returns

    Parameters

    Returns void

setAction

  • Sets an action that should be completed when the button is pressed.

    Returns

    Button data.

    Parameters

    • action: ButtonAction

      Either a number of a page or a function that determines number of a page.

    Returns CustomButton

setDisableWhen

setStyle

Settings

Member Visibility

Theme

Generated using TypeDoc