Class Button

Button UI component

Hierarchy

UIComponent
- Button

Index

Constructors

Properties

element isEnabled isVisible

Methods

disable enable getElement getIsEnabled getIsVisible getText hide setText show

Constructors

constructor

new Button(config: ButtonConfig): Button
Parameters
- config: ButtonConfig
Returns Button
Overrides UIComponent.constructor
- Defined in Button.ts:35

Properties

`Protected`element

element: HTMLElement

`Protected`isEnabled

isEnabled: boolean = true

`Protected`isVisible

isVisible: boolean = true

Methods

disable

disable(): this
Disable the component

Returns this
Inherited from UIComponent.disable
- Defined in UIComponent.ts:49

enable

enable(): this
Enable the component

Returns this
Inherited from UIComponent.enable
- Defined in UIComponent.ts:36

getElement

getElement(): HTMLElement
Get the underlying DOM element

Returns HTMLElement
Inherited from UIComponent.getElement
- Defined in UIComponent.ts:62

getIsEnabled

getIsEnabled(): boolean
Check if the component is enabled

Returns boolean
Inherited from UIComponent.getIsEnabled
- Defined in UIComponent.ts:76

getIsVisible

getIsVisible(): boolean
Check if the component is visible

Returns boolean
Inherited from UIComponent.getIsVisible
- Defined in UIComponent.ts:69

getText

getText(): string
Get the current button text

Returns string
- Defined in Button.ts:114

hide

hide(): this
Hide the component

Returns this
Inherited from UIComponent.hide
- Defined in UIComponent.ts:27

setText

setText(text: string): this
Update the button text
Parameters
- text: string
Returns this
- Defined in Button.ts:105

show

show(): this
Show the component

Returns this
Inherited from UIComponent.show
- Defined in UIComponent.ts:18