Linear Progress

The MDC Linear Progress component is a spec-aligned linear progress indicator component adhering to the Material Design progress & activity requirements.

Design & API Documentation

• Guidelines
• Demo

Installation

npm install @material/linear-progress

Usage

<div role="progressbar" class="mdc-linear-progress">
  <div class="mdc-linear-progress__buffering-dots"></div>
  <div class="mdc-linear-progress__buffer"></div>
  <div class="mdc-linear-progress__bar mdc-linear-progress__primary-bar">
    <span class="mdc-linear-progress__bar-inner"></span>
  </div>
  <div class="mdc-linear-progress__bar mdc-linear-progress__secondary-bar">
    <span class="mdc-linear-progress__bar-inner"></span>
  </div>
</div>

CSS Modifiers

The provided modifiers are:

Class	Description
mdc-linear-progress--indeterminate	Puts the linear progress indicator in an indeterminate state.
mdc-linear-progress--reversed	Reverses the direction of the linear progress indicator.
mdc-linear-progress--closed	Hides the linear progress indicator.

Sass Mixins

Mixin	Description
mdc-linear-progress-bar-color($color)	Sets the color of the progress bar
mdc-linear-progress-buffer-color($color)	Sets the color of the buffer bar and dots

Using the Foundation Class

MDC Linear Progress ships with an MDCLinearProgressFoundation class that external frameworks and libraries can use to integrate the component. As with all foundation classes, an adapter object must be provided. The adapter for linear progress must provide the following functions, with correct signatures:

Method Signature	Description
addClass(className: string) => void	Adds a class to the root element.
removeClass(className: string) => void	Removes a class from the root element.
hasClass(className: string) => boolean	Returns boolean indicating whether the root element has a given class.
getPrimaryBar() => Element	Returns the primary bar element.
getBuffer() => Element	Returns the buffer element.
setStyle(el: Element, styleProperty: string, value: string) => void	Sets the inline style on the given element.

MDCLinearProgressFoundation API

MDC Linear Progress Foundation exposes the following methods:

Method Signature	Description
setDeterminate(value: boolean) => void	Toggles the component between the determinate and indeterminate state.
setProgress(value: number) => void	Sets the progress bar to this value. Value should be between [0, 1].
setBuffer(value: number) => void	Sets the buffer bar to this value. Value should be between [0, 1].
setReverse(value: boolean) => void	Reverses the direction of the linear progress indicator.
open() => void	Puts the component in the open state.
close() => void	Puts the component in the closed state.

MDCLinearProgress API

MDC Linear Progress exposes the following methods:

Method Signature	Description
set determinate(value: boolean) => void	Toggles the component between the determinate and indeterminate state.
set progress(value: number) => void	Sets the progress bar to this value. Value should be between [0, 1].
set buffer(value: number) => void	Sets the buffer bar to this value. Value should be between [0, 1].
set reverse(value: boolean) => void	Reverses the direction of the linear progress indicator.
open() => void	Puts the component in the open state.
close() => void	Puts the component in the closed state.