Class StopButton

Bind for button that stops pagination.

Hierarchy

  • default
    • StopButton

Constructors

constructor

Accessors

action builtComponent data switch

Methods

setAction setData setSwitch toJSON _doAction _switch

Constructors

constructor

  • Bind for button that stop pagination.

    Parameters

    • Optional style: default

      Styling for button.

    Returns StopButton

Accessors

action

  • get action(): ButtonAction

  • Returns

    Action that is called after the button is pressed.

    Returns ButtonAction

builtComponent

  • get builtComponent(): ButtonBuilder

  • Returns

    Ready button builder.

    Returns ButtonBuilder

data

  • get data(): Partial<default>

  • Returns

    Button's styling.

    Returns Partial<default>

switch

  • get switch(): ButtonSwitch

  • Returns

    Action that is called to switch button's state.

    Returns ButtonSwitch

Methods

setAction

  • Sets action that is called after the button is pressed.

    Returns

    Parameters

    • action: ButtonAction

      Action that is called after the button is pressed.

    Returns StopButton

setData

  • Sets buttons data.

    Returns

    Parameters

    • data: default | Partial<default>

      Either an interface for button styling or the class to be built from.

    Returns StopButton

setSwitch

  • Sets action that is called to switch button's state.

    Returns

    Parameters

    • switchFunction: ButtonSwitch

      Action that is called to switch button's state.

    Returns StopButton

toJSON

  • Converts button styling to JSON-like object.

    Returns

    JSON-like object.

    Returns default

Static Private _doAction

  • _doAction(pagination: default): void

  • Action that stops pagination.

    Returns

    Parameters

    • pagination: default

      Pagination.

    Returns void

Static Private _switch

  • _switch(): false

  • Switch that never disables the button.

    Returns

    Returns false

Settings

Member Visibility

Theme

Generated using TypeDoc