Class TabApi

Hierarchy

ContainerBladeApi<TabController>
- TabApi

Implements

EventListenable<TabApiEvents>

Index

Accessors

disabled element hidden pages

Methods

addPage dispose exportState importState off on refresh removePage

Accessors

disabled

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

element

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

hidden

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

Methods

importState

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

off

off<EventName>(eventName: EventName, handler: ((ev: TabApiEvents[EventName]) => void)): TabApi
Type Parameters
- EventName extends keyof TabApiEvents
Parameters
- eventName: EventName
- handler: ((ev: TabApiEvents[EventName]) => void)
  - - (ev: TabApiEvents[EventName]): void
    - Parameters
      
      ev: TabApiEvents[EventName]
      
      Returns void
Returns TabApi
Implementation of EventListenable.off
- Defined in core/src/blade/tab/api/tab.ts:93

on

on<EventName>(eventName: EventName, handler: ((ev: TabApiEvents[EventName]) => void)): TabApi
Type Parameters
- EventName extends keyof TabApiEvents
Parameters
- eventName: EventName
- handler: ((ev: TabApiEvents[EventName]) => void)
  - - (ev: TabApiEvents[EventName]): void
    - Parameters
      
      ev: TabApiEvents[EventName]
      
      Returns void
Returns TabApi
Implementation of EventListenable.on
- Defined in core/src/blade/tab/api/tab.ts:76

refresh

refresh(): void
Refreshes the target.

Returns void
Inherited from ContainerBladeApi.refresh
- Defined in core/src/blade/common/api/container-blade.ts:25

removePage

removePage(index: number): void
Parameters
- index: number
Returns void
- Defined in core/src/blade/tab/api/tab.ts:72

Class TabApi

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

pages

Returns TabPageApi[]

Methods

addPage

Parameters

params: TabPageParams

Returns TabPageApi

dispose

Returns void

exportState

Returns BladeState

importState

Parameters

state: BladeState

Returns boolean

off

Type Parameters

EventName extends keyof TabApiEvents

Parameters

eventName: EventName

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

Parameters

ev: TabApiEvents[EventName]

Returns void

Returns TabApi

on

Type Parameters

EventName extends keyof TabApiEvents

Parameters

eventName: EventName

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

Parameters

ev: TabApiEvents[EventName]

Returns void

Returns TabApi

refresh

Returns void

removePage

Parameters

index: number

Returns void

Settings

Member Visibility

Theme