Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MDCLineRipple

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • root: Element
    • Optional foundation: FoundationType
    • Rest ...args: Array<unknown>

    Returns MDCLineRipple

Properties

Protected foundation_

foundation_: MDCLineRippleFoundation

Protected root_

root_: Element

Methods

activate

  • activate(): void

deactivate

  • deactivate(): void

destroy

  • destroy(): void

  • Returns void

emit

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

  • 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

initialSyncWithDOM

  • initialSyncWithDOM(): void

  • Returns void

initialize

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

  • Parameters

    • Rest ..._args: Array<unknown>

    Returns void

listen

  • Wrapper method to add an event listener to the component's root element. This is most useful when listening for custom events.

    Type parameters

    Parameters

    Returns void

  • Type parameters

    • E: Event

    Parameters

    Returns void

setRippleCenter

  • setRippleCenter(xCoordinate: number): void

  • Sets the transform origin given a user's click location. The rippleCenter is the x-coordinate of the middle of the ripple.

    Parameters

    • xCoordinate: number

    Returns void

unlisten

  • Wrapper method to remove an event listener to the component's root element. This is most useful when unlistening for custom events.

    Type parameters

    Parameters

    Returns void

  • Type parameters

    • E: Event

    Parameters

    Returns void

Static attachTo

Generated using TypeDoc