@material/animation

  • Version 11.0.0
  • Published
  • 71.2 kB
  • 1 dependency
  • MIT license

Install

npm i @material/animation
yarn add @material/animation
pnpm add @material/animation

Overview

Animation Variables and Mixins used by Material Components for the web

Index

Namespaces

namespace @material/animation

module '@material/animation' {}

    function getCorrectEventName

    getCorrectEventName: (
    windowObj: Window,
    eventType: StandardJsEventType
    ) => StandardJsEventType | PrefixedJsEventType;

      function getCorrectPropertyName

      getCorrectPropertyName: (
      windowObj: Window,
      cssProperty: StandardCssPropertyName
      ) => StandardCssPropertyName | PrefixedCssPropertyName;

        class AnimationFrame

        class AnimationFrame {}
        • AnimationFrame provides a user-friendly abstraction around requesting and canceling animation frames.

        method cancel

        cancel: (key: string) => void;
        • Cancels a queued callback with the given key.

          Parameter key

          The key for this callback.

        method cancelAll

        cancelAll: () => void;
        • Cancels all queued callback.

        method getQueue

        getQueue: () => string[];
        • Returns the queue of unexecuted callback keys.

        method request

        request: (key: string, callback: FrameRequestCallback) => void;
        • Requests an animation frame. Cancels any existing frame with the same key.

          Parameter key

          The key for this callback.

          Parameter callback

          The callback to be executed.

        interface CssVendorProperty

        interface CssVendorProperty {}

          property prefixed

          prefixed: PrefixedCssPropertyName;

            property standard

            standard: StandardCssPropertyName;

              interface JsVendorProperty

              interface JsVendorProperty {}

                property cssProperty

                cssProperty: StandardCssPropertyName;

                  property prefixed

                  prefixed: PrefixedJsEventType;

                    property standard

                    standard: StandardJsEventType;

                      type CssVendorPropertyMap

                      type CssVendorPropertyMap = {
                      [K in StandardCssPropertyName]: CssVendorProperty;
                      };

                        type JsVendorPropertyMap

                        type JsVendorPropertyMap = {
                        [K in StandardJsEventType]: JsVendorProperty;
                        };

                          type PrefixedCssPropertyName

                          type PrefixedCssPropertyName =
                          | '-webkit-animation'
                          | '-webkit-transform'
                          | '-webkit-transition';

                            type PrefixedJsEventType

                            type PrefixedJsEventType =
                            | 'webkitAnimationEnd'
                            | 'webkitAnimationIteration'
                            | 'webkitAnimationStart'
                            | 'webkitTransitionEnd';

                              type StandardCssPropertyName

                              type StandardCssPropertyName = 'animation' | 'transform' | 'transition';
                              • Copyright 2019 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.

                              type StandardJsEventType

                              type StandardJsEventType =
                              | 'animationend'
                              | 'animationiteration'
                              | 'animationstart'
                              | 'transitionend';

                                namespace @material/animation.util

                                namespace @material/animation.util {}

                                  function getCorrectEventName

                                  getCorrectEventName: (
                                  windowObj: Window,
                                  eventType: StandardJsEventType
                                  ) => StandardJsEventType | PrefixedJsEventType;

                                    function getCorrectPropertyName

                                    getCorrectPropertyName: (
                                    windowObj: Window,
                                    cssProperty: StandardCssPropertyName
                                    ) => StandardCssPropertyName | PrefixedCssPropertyName;

                                      namespace @material/animation/animationframe

                                      module '@material/animation/animationframe' {}

                                        class AnimationFrame

                                        class AnimationFrame {}
                                        • AnimationFrame provides a user-friendly abstraction around requesting and canceling animation frames.

                                        method cancel

                                        cancel: (key: string) => void;
                                        • Cancels a queued callback with the given key.

                                          Parameter key

                                          The key for this callback.

                                        method cancelAll

                                        cancelAll: () => void;
                                        • Cancels all queued callback.

                                        method getQueue

                                        getQueue: () => string[];
                                        • Returns the queue of unexecuted callback keys.

                                        method request

                                        request: (key: string, callback: FrameRequestCallback) => void;
                                        • Requests an animation frame. Cancels any existing frame with the same key.

                                          Parameter key

                                          The key for this callback.

                                          Parameter callback

                                          The callback to be executed.

                                        namespace @material/animation/types

                                        module '@material/animation/types' {}

                                          interface CssVendorProperty

                                          interface CssVendorProperty {}

                                            property prefixed

                                            prefixed: PrefixedCssPropertyName;

                                              property standard

                                              standard: StandardCssPropertyName;

                                                interface JsVendorProperty

                                                interface JsVendorProperty {}

                                                  property cssProperty

                                                  cssProperty: StandardCssPropertyName;

                                                    property prefixed

                                                    prefixed: PrefixedJsEventType;

                                                      property standard

                                                      standard: StandardJsEventType;

                                                        type CssVendorPropertyMap

                                                        type CssVendorPropertyMap = {
                                                        [K in StandardCssPropertyName]: CssVendorProperty;
                                                        };

                                                          type JsVendorPropertyMap

                                                          type JsVendorPropertyMap = {
                                                          [K in StandardJsEventType]: JsVendorProperty;
                                                          };

                                                            type PrefixedCssPropertyName

                                                            type PrefixedCssPropertyName =
                                                            | '-webkit-animation'
                                                            | '-webkit-transform'
                                                            | '-webkit-transition';

                                                              type PrefixedJsEventType

                                                              type PrefixedJsEventType =
                                                              | 'webkitAnimationEnd'
                                                              | 'webkitAnimationIteration'
                                                              | 'webkitAnimationStart'
                                                              | 'webkitTransitionEnd';

                                                                type StandardCssPropertyName

                                                                type StandardCssPropertyName = 'animation' | 'transform' | 'transition';
                                                                • Copyright 2019 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.

                                                                type StandardJsEventType

                                                                type StandardJsEventType =
                                                                | 'animationend'
                                                                | 'animationiteration'
                                                                | 'animationstart'
                                                                | 'transitionend';

                                                                  namespace @material/animation/util

                                                                  module '@material/animation/util' {}

                                                                    function getCorrectEventName

                                                                    getCorrectEventName: (
                                                                    windowObj: Window,
                                                                    eventType: StandardJsEventType
                                                                    ) => StandardJsEventType | PrefixedJsEventType;

                                                                      function getCorrectPropertyName

                                                                      getCorrectPropertyName: (
                                                                      windowObj: Window,
                                                                      cssProperty: StandardCssPropertyName
                                                                      ) => StandardCssPropertyName | PrefixedCssPropertyName;

                                                                        Package Files (1)

                                                                        Dependencies (1)

                                                                        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/animation.

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