Class MDCComponent<FoundationType>

Type parameters

FoundationType: MDCFoundation

Hierarchy

MDCComponent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in mdc-base/component.ts:37
Parameters
- root: Element
- Optional foundation: FoundationType
- Rest ...args: Array<unknown>
Returns MDCComponent

Properties

Protected foundation_

foundation_: FoundationType

Protected root_

root_: Element

Methods

destroy

destroy(): void

- Defined in mdc-base/component.ts:74
Returns void

emit

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

- Defined in mdc-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(): FoundationType

- Defined in mdc-base/component.ts:60
Returns FoundationType

initialSyncWithDOM

initialSyncWithDOM(): void

- Defined in mdc-base/component.ts:67
Returns void

initialize

initialize(..._args: Array<unknown>): void

- Defined in mdc-base/component.ts:54
Parameters
- Rest ..._args: Array<unknown>
Returns void

listen

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

- Defined in mdc-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
- Defined in mdc-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

- Defined in mdc-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
- Defined in mdc-base/component.ts:95
Type parameters
- E: Event
Parameters
- evtType: string
- handler: CustomEventListener<E>
Returns void

Static attachTo

attachTo(root: Element): MDCComponent<MDCFoundation<__type>>

- Defined in mdc-base/component.ts:28
Parameters
- root: Element
Returns MDCComponent<MDCFoundation<__type>>

Generated using TypeDoc