Class ButtonData

Class for storing and modifying button data.

Hierarchy

Constructors

constructor

Properties

_action _disableWhen _style

Accessors

action disableWhen style

Methods

_setAction _setDisableWhen _setup setStyle

Constructors

constructor

  • Class for storing and modifying button data.

    Parameters

    • Optional data: MessageButton | ButtonData

      Data from which to build ButtonData.

    Returns ButtonData

Properties

Private _action

_action: ButtonAction

Private _disableWhen

_disableWhen: ButtonDisableWhen

Private _style

_style: MessageButton

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

  • _setAction(action: ButtonAction): ButtonData

  • 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 ButtonData

Protected _setDisableWhen

Private _setup

  • _setup(data: MessageButton | ButtonData): void

  • Setups class from style or ButtonData.

    Returns

    Parameters

    Returns void

setStyle

  • Sets button style.

    Returns

    Button data.

    Parameters

    • style: MessageButton

      Button style.

    Returns ButtonData

Settings

Member Visibility

Theme

Generated using TypeDoc