Class ButtonWrapper

Class that wraps button's functionality.

Hierarchy

ButtonWrapper

Index

Constructors

Properties

_action _data _switch

Accessors

action builtComponent data switch

Methods

setAction setData setSwitch toJSON

Constructors

constructor

new ButtonWrapper(data?: ButtonWrapper | Partial<ButtonData>): ButtonWrapper
Class that wraps button's functionality.
Parameters
- Optional data: ButtonWrapper | Partial<ButtonData>
  
  Either an interface for button styling or the class to be built from.
Returns ButtonWrapper

Properties

`Private` _action

_action: ButtonAction

`Private` _data

_data: Partial<ButtonData>

`Private` _switch

_switch: ButtonSwitch

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<ButtonData>
Returns
Button's styling.

Returns Partial<ButtonData>

switch

get switch(): ButtonSwitch
Returns
Action that is called to switch button's state.

Returns ButtonSwitch

Methods

setAction

setAction(action: ButtonAction): ButtonWrapper
Sets action that is called after the button is pressed.

Returns
Parameters
- action: ButtonAction
  
  Action that is called after the button is pressed.
Returns ButtonWrapper

setData

setData(data: ButtonWrapper | Partial<ButtonData>): ButtonWrapper
Sets buttons data.

Returns
Parameters
- data: ButtonWrapper | Partial<ButtonData>
  
  Either an interface for button styling or the class to be built from.
Returns ButtonWrapper

setSwitch

setSwitch(switchFunction: ButtonSwitch): ButtonWrapper
Sets action that is called to switch button's state.

Returns
Parameters
- switchFunction: ButtonSwitch
  
  Action that is called to switch button's state.
Returns ButtonWrapper

toJSON

toJSON(): ButtonData
Converts button styling to JSON-like object.

Returns
JSON-like object.

Returns ButtonData

Generated using TypeDoc