Class ButtonApi

Hierarchy

BladeApi<ButtonBladeController>
- ButtonApi

Implements

EventListenable<ButtonApiEvents>

Index

Accessors

disabled element hidden label title

Methods

dispose exportState importState off on

Accessors

disabled

get disabled(): boolean
Returns boolean
Inherited from BladeApi.disabled
- Defined in core/src/blade/common/api/blade.ts:21
set disabled(disabled: boolean): void
Parameters
- disabled: boolean
Returns void
Inherited from BladeApi.disabled
- Defined in core/src/blade/common/api/blade.ts:25

element

get element(): HTMLElement
Returns HTMLElement
Inherited from BladeApi.element
- Defined in core/src/blade/common/api/blade.ts:17

hidden

get hidden(): boolean
Returns boolean
Inherited from BladeApi.hidden
- Defined in core/src/blade/common/api/blade.ts:29
set hidden(hidden: boolean): void
Parameters
- hidden: boolean
Returns void
Inherited from BladeApi.hidden
- Defined in core/src/blade/common/api/blade.ts:33

label

get label(): undefined | null | string
Returns undefined | null | string
- Defined in core/src/blade/button/api/button.ts:14
set label(label: undefined | null | string): void
Parameters
- label: undefined | null | string
Returns void
- Defined in core/src/blade/button/api/button.ts:18

title

get title(): string
Returns string
- Defined in core/src/blade/button/api/button.ts:22
set title(title: string): void
Parameters
- title: string
Returns void
- Defined in core/src/blade/button/api/button.ts:26

Methods

dispose

dispose(): void
Returns void
Inherited from BladeApi.dispose
- Defined in core/src/blade/common/api/blade.ts:37

exportState

exportState(): BladeState
Returns BladeState
Inherited from BladeApi.exportState
- Defined in core/src/blade/common/api/blade.ts:45

importState

importState(state: BladeState): boolean
Parameters
- state: BladeState
Returns boolean
Inherited from BladeApi.importState
- Defined in core/src/blade/common/api/blade.ts:41

off

off<EventName>(eventName: EventName, handler: ((ev: ButtonApiEvents[EventName]) => void)): ButtonApi
Type Parameters
- EventName extends "click"
Parameters
- eventName: EventName
- handler: ((ev: ButtonApiEvents[EventName]) => void)
  - - (ev: ButtonApiEvents[EventName]): void
    - Parameters
      
      ev: ButtonApiEvents[EventName]
      
      Returns void
Returns ButtonApi
Implementation of EventListenable.off
- Defined in core/src/blade/button/api/button.ts:42

on

on<EventName>(eventName: EventName, handler: ((ev: ButtonApiEvents[EventName]) => void)): ButtonApi
Type Parameters
- EventName extends "click"
Parameters
- eventName: EventName
- handler: ((ev: ButtonApiEvents[EventName]) => void)
  - - (ev: ButtonApiEvents[EventName]): void
    - Parameters
      
      ev: ButtonApiEvents[EventName]
      
      Returns void
Returns ButtonApi
Implementation of EventListenable.on
- Defined in core/src/blade/button/api/button.ts:30

Class ButtonApi

Hierarchy

Implements

Index

Accessors

Methods

Accessors

disabled

Returns boolean

Parameters

disabled: boolean

Returns void

element

Returns HTMLElement

hidden

Returns boolean

Parameters

hidden: boolean

Returns void

label

Returns undefined | null | string

Parameters

label: undefined | null | string

Returns void

title

Returns string

Parameters

title: string

Returns void

Methods

dispose

Returns void

exportState

Returns BladeState

importState

Parameters

state: BladeState

Returns boolean

off

Type Parameters

EventName extends "click"

Parameters

eventName: EventName

handler: ((ev: ButtonApiEvents[EventName]) => void)

Parameters

ev: ButtonApiEvents[EventName]

Returns void

Returns ButtonApi

on

Type Parameters

EventName extends "click"

Parameters

eventName: EventName

handler: ((ev: ButtonApiEvents[EventName]) => void)

Parameters

ev: ButtonApiEvents[EventName]

Returns void

Returns ButtonApi

Settings

Member Visibility

Theme