Logo for jsDocs.io

@material/line-ripple

  • Version 14.0.0
  • Published
  • 122 kB
  • 5 dependencies
  • MIT license

Install

npm i @material/line-ripple
yarn add @material/line-ripple
pnpm add @material/line-ripple

Overview

The Material Components for the web line-ripple component

Index

Variables

Classes

Interfaces

Type Aliases

Variables

variable cssClasses

const cssClasses: { LINE_RIPPLE_ACTIVE: string; LINE_RIPPLE_DEACTIVATING: string };

  • Copyright 2018 Google Inc.

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Classes

class MDCLineRipple

class MDCLineRipple extends MDCComponent<MDCLineRippleFoundation> {}

    method activate

    activate: () => void;

    • Activates the line ripple

    method attachTo

    static attachTo: (root: Element) => MDCLineRipple;

      method deactivate

      deactivate: () => void;

      • Deactivates the line ripple

      method getDefaultFoundation

      getDefaultFoundation: () => MDCLineRippleFoundation;

        method 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.

        class MDCLineRippleFoundation

        class MDCLineRippleFoundation extends MDCFoundation<MDCLineRippleAdapter> {}

          constructor

          constructor(adapter?: Partial<MDCLineRippleAdapter>);

            property cssClasses

            static readonly cssClasses: {
                LINE_RIPPLE_ACTIVE: string;
                LINE_RIPPLE_DEACTIVATING: string;
            };

              property defaultAdapter

              static readonly defaultAdapter: MDCLineRippleAdapter;

              method activate

              activate: () => void;

                method deactivate

                deactivate: () => void;

                  method destroy

                  destroy: () => void;

                    method handleTransitionEnd

                    handleTransitionEnd: (evt: TransitionEvent) => void;

                      method init

                      init: () => void;

                        method setRippleCenter

                        setRippleCenter: (xCoordinate: number) => void;

                          Interfaces

                          interface MDCLineRippleAdapter

                          interface MDCLineRippleAdapter {}

                          • Defines the shape of the adapter expected by the foundation. Implement this adapter for your framework of choice to delegate updates to the component in your framework of choice. See architecture documentation for more details. https://github.com/material-components/material-components-web/blob/master/docs/code/architecture.md

                          method addClass

                          addClass: (className: string) => void;

                          • Adds a class to the line ripple element.

                          method deregisterEventHandler

                          deregisterEventHandler: <K extends EventType>(
                              evtType: K,
                              handler: SpecificEventListener<K>
                          ) => void;

                          • Deregisters an event listener on the line ripple element for a given event.

                          method hasClass

                          hasClass: (className: string) => boolean;

                            method registerEventHandler

                            registerEventHandler: <K extends EventType>(
                                evtType: K,
                                handler: SpecificEventListener<K>
                            ) => void;

                            • Registers an event listener on the line ripple element for a given event.

                            method removeClass

                            removeClass: (className: string) => void;

                            • Removes a class from the line ripple element.

                            method setStyle

                            setStyle: (propertyName: string, value: string) => void;

                            • Sets the style property with propertyName to value on the root element.

                            Type Aliases

                            type MDCLineRippleFactory

                            type MDCLineRippleFactory = (
                                el: Element,
                                foundation?: MDCLineRippleFoundation
                            ) => MDCLineRipple;

                              Package Files (5)

                              Dependencies (5)

                              Dev Dependencies (0)

                              No dev dependencies.

                              Peer Dependencies (0)

                              No peer dependencies.

                              Badge

                              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@material/line-ripple.

                              • Markdown
                                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@material/line-ripple)
                              • HTML
                                <a href="https://www.jsdocs.io/package/@material/line-ripple"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>