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_: Element

Accessors

focusOnActivate

set focusOnActivate(focusOnActivate: boolean): void

- Defined in mdc-tab-bar/component.ts:48
Parameters
- focusOnActivate: boolean
Returns void

useAutomaticActivation

set useAutomaticActivation(useAutomaticActivation: boolean): void

- Defined in mdc-tab-bar/component.ts:52
Parameters
- useAutomaticActivation: boolean
Returns void

Methods

activateTab

activateTab(index: number): void

- Defined in mdc-tab-bar/component.ts:140
Activates the tab at the given index

Parameters
- index: number
  
  The index of the tab
Returns void

destroy

destroy(): void

Overrides MDCComponent.destroy
- Defined in mdc-tab-bar/component.ts:79
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-tab-bar/component.ts:90
Returns MDCTabBarFoundation

initialSyncWithDOM

initialSyncWithDOM(): void

Overrides MDCComponent.initialSyncWithDOM
- Defined in mdc-tab-bar/component.ts:64
Returns void

initialize

initialize(tabFactory?: MDCTabFactory, tabScrollerFactory?: MDCTabScrollerFactory): void

Overrides MDCComponent.initialize
- Defined in mdc-tab-bar/component.ts:56
Parameters
- Default value tabFactory: MDCTabFactory = (el) => new MDCTab(el)
- Default value tabScrollerFactory: MDCTabScrollerFactory = (el) => new MDCTabScroller(el)
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

scrollIntoView

scrollIntoView(index: number): void

- Defined in mdc-tab-bar/component.ts:148
Scrolls the tab at the given index into view

Parameters
- index: number
  
  THe index of the tab
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-tab-bar/component.ts:39
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

focusOnActivate

Parameters

focusOnActivate: boolean

Returns void

useAutomaticActivation

Parameters

useAutomaticActivation: boolean

Returns void

Methods

activateTab

Parameters

index: number

Returns void

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)

Default value tabScrollerFactory: MDCTabScrollerFactory = (el) => new MDCTabScroller(el)

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

scrollIntoView

Parameters

index: number

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