MDCRipple | material-components-web

Hierarchy

MDCComponent<MDCRippleFoundation>
- MDCRipple

Implements

MDCRippleCapableSurface

Index

Constructors

constructor

Properties

Accessors

unbounded

Methods

Constructors

constructor

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

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 MDCRipple

Properties

disabled

disabled: boolean = false

Protected foundation_

foundation_: MDCRippleFoundation

root_

root_: Element

Accessors

unbounded

get unbounded(): boolean
set unbounded(unbounded: boolean): void

- Defined in mdc-ripple/component.ts:75
Returns boolean
- Defined in mdc-ripple/component.ts:79
Parameters
- unbounded: boolean
Returns void

Methods

activate

activate(): void

- Defined in mdc-ripple/component.ts:84
Returns void

deactivate

deactivate(): void

- Defined in mdc-ripple/component.ts:88
Returns void

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(): MDCRippleFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-ripple/component.ts:96
Returns MDCRippleFoundation

initialSyncWithDOM

initialSyncWithDOM(): void

Overrides MDCComponent.initialSyncWithDOM
- Defined in mdc-ripple/component.ts:100
Returns void

initialize

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

Inherited from MDCComponent.initialize
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:54
Parameters
- Rest ..._args: Array<unknown>
Returns void

layout

layout(): void

- Defined in mdc-ripple/component.ts:92
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, opts?: MDCRippleAttachOpts): MDCRipple

Overrides MDCComponent.attachTo
- Defined in mdc-ripple/component.ts:34
Parameters
- root: Element
- Default value opts: MDCRippleAttachOpts = {isUnbounded: undefined}
Returns MDCRipple

Static createAdapter

createAdapter(instance: MDCRippleCapableSurface): MDCRippleAdapter

- Defined in mdc-ripple/component.ts:43
Parameters
- instance: MDCRippleCapableSurface
Returns MDCRippleAdapter

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCRipple

Properties

disabled

Protected foundation_

root_

Accessors

unbounded

Returns boolean

Parameters

unbounded: boolean

Returns void

Methods

activate

Returns void

deactivate

Returns void

destroy

Returns void

emit

Type parameters

T: object

Parameters

evtType: string

evtData: T

Default value shouldBubble: boolean = false

Returns void

getDefaultFoundation

Returns MDCRippleFoundation

initialSyncWithDOM

Returns void

initialize

Parameters

Rest ..._args: Array<unknown>

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

Default value opts: MDCRippleAttachOpts = {isUnbounded: undefined}

Returns MDCRipple