MDCTab | material-components-web

Hierarchy

MDCComponent<MDCTabFoundation>
- MDCTab

Implements

MDCRippleCapableSurface

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

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 MDCTab

Properties

Protected foundation_

foundation_: MDCTabFoundation

id

id: string

root_

root_: HTMLElement

Accessors

active

get active(): boolean

- Defined in mdc-tab/component.ts:108
Getter for the active state of the tab

Returns boolean

focusOnActivate

set focusOnActivate(focusOnActivate: boolean): void

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

Methods

activate

activate(computeIndicatorClientRect?: ClientRect): void

- Defined in mdc-tab/component.ts:119
Activates the tab

Parameters
- Optional computeIndicatorClientRect: ClientRect
Returns void

computeDimensions

computeDimensions(): MDCTabDimensions

- Defined in mdc-tab/component.ts:137
Returns MDCTabDimensions

computeIndicatorClientRect

computeIndicatorClientRect(): ClientRect

- Defined in mdc-tab/component.ts:133
Returns the indicator's client rect

Returns ClientRect

deactivate

deactivate(): void

- Defined in mdc-tab/component.ts:126
Deactivates the tab

Returns void

destroy

destroy(): void

Overrides MDCComponent.destroy
- Defined in mdc-tab/component.ts:76
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

focus

focus(): void

- Defined in mdc-tab/component.ts:144
Focuses the tab

Returns void

getDefaultFoundation

getDefaultFoundation(): MDCTabFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-tab/component.ts:82
Returns MDCTabFoundation

initialSyncWithDOM

initialSyncWithDOM(): void

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

initialize

initialize(rippleFactory?: MDCRippleFactory, tabIndicatorFactory?: MDCTabIndicatorFactory): void

Overrides MDCComponent.initialize
- Defined in mdc-tab/component.ts:51
Parameters
- Default value rippleFactory: MDCRippleFactory = (el, foundation) => new MDCRipple(el, foundation)
- Default value tabIndicatorFactory: MDCTabIndicatorFactory = (el) => new MDCTabIndicator(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

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): MDCTab

Overrides MDCComponent.attachTo
- Defined in mdc-tab/component.ts:37
Parameters
- root: Element
Returns MDCTab

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCTab

Properties

Protected foundation_

id

root_

Accessors

active

Returns boolean

focusOnActivate

Parameters

focusOnActivate: boolean

Returns void

Methods

activate

Parameters

Optional computeIndicatorClientRect: ClientRect

Returns void

computeDimensions

Returns MDCTabDimensions

computeIndicatorClientRect

Returns ClientRect

deactivate

Returns void

destroy

Returns void

emit

Type parameters

T: object

Parameters

evtType: string

evtData: T

Default value shouldBubble: boolean = false

Returns void

focus

Returns void

getDefaultFoundation

Returns MDCTabFoundation

initialSyncWithDOM

Returns void

initialize

Parameters

Default value rippleFactory: MDCRippleFactory = (el, foundation) => new MDCRipple(el, foundation)

Default value tabIndicatorFactory: MDCTabIndicatorFactory = (el) => new MDCTabIndicator(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

unlisten

Type parameters

K: EventType

Parameters

evtType: K

handler: SpecificEventListener<K>

Returns void

Type parameters

E: Event

Parameters