MDCTabBar | material-components-web

Hierarchy

MDCComponent<MDCTabBarFoundation>
- MDCTabBar

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MDCTabBar(root: Element, foundation?: FoundationType, ...args: Array<unknown>): MDCTabBar

Inherited from MDCComponent.__constructor
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:37
Parameters
- root: Element
- Optional foundation: FoundationType
- Rest ...args: Array<unknown>
Returns MDCTabBar

Properties

Protected foundation_

foundation_: MDCTabBarFoundation

Protected root_

root_: HTMLElement

Accessors

activeTab

get activeTab(): MDCTab
set activeTab(tab: MDCTab): void

- Defined in mdc-tabs/tab-bar/component.ts:44
Returns MDCTab
- Defined in mdc-tabs/tab-bar/component.ts:49
Parameters
- tab: MDCTab
Returns void

activeTabIndex

get activeTabIndex(): number
set activeTabIndex(index: number): void

- Defined in mdc-tabs/tab-bar/component.ts:53
Returns number
- Defined in mdc-tabs/tab-bar/component.ts:57
Parameters
- index: number
Returns void

tabs

get tabs(): MDCTab[]

- Defined in mdc-tabs/tab-bar/component.ts:40
Returns MDCTab[]

Methods

destroy

destroy(): void

Inherited from MDCComponent.destroy
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:74
Returns void

emit

emit<T>(evtType: string, evtData: T, shouldBubble?: boolean): void

Inherited from MDCComponent.emit
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:103
Fires a cross-browser-compatible custom event from the component root of the given type, with the given data.

Type parameters
- T: object
Parameters
- evtType: string
- evtData: T
- Default value shouldBubble: boolean = false
Returns void

getDefaultFoundation

getDefaultFoundation(): MDCTabBarFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-tabs/tab-bar/component.ts:76
Returns MDCTabBarFoundation

initialSyncWithDOM

initialSyncWithDOM(): void

Inherited from MDCComponent.initialSyncWithDOM
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:67
Returns void

initialize

initialize(tabFactory?: MDCTabFactory): void

Overrides MDCComponent.initialize
- Defined in mdc-tabs/tab-bar/component.ts:67
Parameters
- Default value tabFactory: MDCTabFactory = (el) => new MDCTab(el)
Returns void

layout

layout(): void

- Defined in mdc-tabs/tab-bar/component.ts:110
Returns void

listen

listen<K>(evtType: K, handler: SpecificEventListener<K>): void
listen<E>(evtType: string, handler: CustomEventListener<E>): void

Inherited from MDCComponent.listen
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:84
Wrapper method to add an event listener to the component's root element. This is most useful when listening for custom events.

Type parameters
- K: EventType
Parameters
- evtType: K
- handler: SpecificEventListener<K>
Returns void
Inherited from MDCComponent.listen
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:85
Type parameters
- E: Event
Parameters
- evtType: string
- handler: CustomEventListener<E>
Returns void

unlisten

unlisten<K>(evtType: K, handler: SpecificEventListener<K>): void
unlisten<E>(evtType: string, handler: CustomEventListener<E>): void

Inherited from MDCComponent.unlisten
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:94
Wrapper method to remove an event listener to the component's root element. This is most useful when unlistening for custom events.

Type parameters
- K: EventType
Parameters
- evtType: K
- handler: SpecificEventListener<K>
Returns void
Inherited from MDCComponent.unlisten
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:95
Type parameters
- E: Event
Parameters
- evtType: string
- handler: CustomEventListener<E>
Returns void

Static attachTo

attachTo(root: Element): MDCTabBar

Overrides MDCComponent.attachTo
- Defined in mdc-tabs/tab-bar/component.ts:36
Parameters
- root: Element
Returns MDCTabBar

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCTabBar

Properties

Protected foundation_

Protected root_

Accessors

activeTab

Returns MDCTab

Parameters

tab: MDCTab

Returns void

activeTabIndex

Returns number

Parameters

index: number

Returns void

tabs

Returns MDCTab[]

Methods

destroy

Returns void

emit

Type parameters

T: object

Parameters

evtType: string

evtData: T

Default value shouldBubble: boolean = false

Returns void

getDefaultFoundation

Returns MDCTabBarFoundation

initialSyncWithDOM

Returns void

initialize

Parameters

Default value tabFactory: MDCTabFactory = (el) => new MDCTab(el)

Returns void

layout

Returns void

listen

Type parameters

K: EventType

Parameters

evtType: K

handler: SpecificEventListener<K>

Returns void

Type parameters

E: Event

Parameters

evtType: string

handler: CustomEventListener<E>

Returns void

unlisten

Type parameters

K: EventType

Parameters

evtType: K

handler: SpecificEventListener<K>

Returns void

Type parameters

E: Event

Parameters

evtType: string

handler: CustomEventListener<E>

Returns void

Static attachTo

Parameters

root: Element

Returns MDCTabBar