@material/linear-progress

  • Version 13.0.0
  • Published
  • 301 kB
  • 7 dependencies
  • MIT license

Install

npm i @material/linear-progress
yarn add @material/linear-progress
pnpm add @material/linear-progress

Overview

The Material Components for the web linear progress indicator component

Index

Variables

variable animationDimensionPercentages

const animationDimensionPercentages: {
PRIMARY_HALF: number;
PRIMARY_FULL: number;
SECONDARY_QUARTER: number;
SECONDARY_HALF: number;
SECONDARY_FULL: number;
};

    variable cssClasses

    const cssClasses: {
    CLOSED_CLASS: string;
    CLOSED_ANIMATION_OFF_CLASS: string;
    INDETERMINATE_CLASS: string;
    REVERSED_CLASS: string;
    ANIMATION_READY_CLASS: string;
    };
    • Copyright 2017 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.

    variable strings

    const strings: {
    ARIA_HIDDEN: string;
    ARIA_VALUEMAX: string;
    ARIA_VALUEMIN: string;
    ARIA_VALUENOW: string;
    BUFFER_BAR_SELECTOR: string;
    FLEX_BASIS: string;
    PRIMARY_BAR_SELECTOR: string;
    };

      Classes

      class MDCLinearProgress

      class MDCLinearProgress
      extends MDCComponent<MDCLinearProgressFoundation>
      implements MDCProgressIndicator {}

        method attachTo

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

          method close

          close: () => void;

            method getDefaultFoundation

            getDefaultFoundation: () => MDCLinearProgressFoundation;

              method initialSyncWithDOM

              initialSyncWithDOM: () => void;

                method open

                open: () => void;

                  class MDCLinearProgressFoundation

                  class MDCLinearProgressFoundation
                  extends MDCFoundation<MDCLinearProgressAdapter>
                  implements MDCProgressIndicatorFoundation {}

                    constructor

                    constructor(adapter?: Partial<MDCLinearProgressAdapter>);

                      property cssClasses

                      static readonly cssClasses: {
                      CLOSED_CLASS: string;
                      CLOSED_ANIMATION_OFF_CLASS: string;
                      INDETERMINATE_CLASS: string;
                      REVERSED_CLASS: string;
                      ANIMATION_READY_CLASS: string;
                      };

                        property defaultAdapter

                        static readonly defaultAdapter: MDCLinearProgressAdapter;

                          property strings

                          static readonly strings: {
                          ARIA_HIDDEN: string;
                          ARIA_VALUEMAX: string;
                          ARIA_VALUEMIN: string;
                          ARIA_VALUENOW: string;
                          BUFFER_BAR_SELECTOR: string;
                          FLEX_BASIS: string;
                          PRIMARY_BAR_SELECTOR: string;
                          };

                            method close

                            close: () => void;

                              method destroy

                              destroy: () => void;

                                method getBuffer

                                getBuffer: () => number;

                                  method getProgress

                                  getProgress: () => number;

                                    method handleTransitionEnd

                                    handleTransitionEnd: () => void;
                                    • Handles the transitionend event emitted after close() is called and the opacity fades out. This is so that animations are removed only after the progress indicator is completely hidden.

                                    method init

                                    init: () => void;

                                      method isClosed

                                      isClosed: () => boolean;

                                        method isDeterminate

                                        isDeterminate: () => boolean;

                                          method open

                                          open: () => void;

                                            method restartAnimation

                                            restartAnimation: () => void;

                                              method setBuffer

                                              setBuffer: (value: number) => void;

                                                method setDeterminate

                                                setDeterminate: (isDeterminate: boolean) => void;

                                                  method setProgress

                                                  setProgress: (value: number) => void;

                                                    Interfaces

                                                    interface MDCLinearProgressAdapter

                                                    interface MDCLinearProgressAdapter {}

                                                      method addClass

                                                      addClass: (className: string) => void;

                                                        method attachResizeObserver

                                                        attachResizeObserver: (
                                                        callback: MDCResizeObserverCallback
                                                        ) => MDCResizeObserver | null;
                                                        • If available, creates a ResizeObserver object, invokes the #observe method on the root element. This is used for an optional performance gains for the indeterminate animation on modern browsers.

                                                          Parameter callback

                                                          The callback to apply to the constructor of the ResizeObserver Returns a ResizeObserver that has had observe called on the root element with the given callback. null if ResizeObserver is not implemented or polyfilled.

                                                        method forceLayout

                                                        forceLayout: () => void;

                                                          method getWidth

                                                          getWidth: () => number;
                                                          • The width of the root element.

                                                          method hasClass

                                                          hasClass: (className: string) => boolean;

                                                            method removeAttribute

                                                            removeAttribute: (name: string) => void;

                                                              method removeClass

                                                              removeClass: (className: string) => void;

                                                                method setAttribute

                                                                setAttribute: (name: string, value: string) => void;

                                                                  method setBufferBarStyle

                                                                  setBufferBarStyle: (styleProperty: string, value: string) => void;

                                                                    method setPrimaryBarStyle

                                                                    setPrimaryBarStyle: (styleProperty: string, value: string) => void;

                                                                      method setStyle

                                                                      setStyle: (styleProperty: string, value: string) => void;
                                                                      • Sets the inline style on the root element.

                                                                        Parameter styleProperty

                                                                        The style property to set.

                                                                        Parameter value

                                                                        The value the style property should be set to.

                                                                      interface MDCResizeObserver

                                                                      interface MDCResizeObserver {}

                                                                        method disconnect

                                                                        disconnect: () => void;

                                                                          method observe

                                                                          observe: (target: Element) => void;

                                                                            construct signature

                                                                            new (callback: MDCResizeObserverCallback): MDCResizeObserver;

                                                                              interface MDCResizeObserverEntry

                                                                              interface MDCResizeObserverEntry {}
                                                                              • Copyright 2021 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.

                                                                              property contentRect

                                                                              contentRect: DOMRectReadOnly;

                                                                                interface WithMDCResizeObserver

                                                                                interface WithMDCResizeObserver {}

                                                                                  property ResizeObserver

                                                                                  ResizeObserver: MDCResizeObserver;

                                                                                    Type Aliases

                                                                                    type MDCResizeObserverCallback

                                                                                    type MDCResizeObserverCallback = (
                                                                                    entries: MDCResizeObserverEntry[],
                                                                                    observer: MDCResizeObserver
                                                                                    ) => void;

                                                                                      Package Files (6)

                                                                                      Dependencies (7)

                                                                                      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/linear-progress.

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