Back to Material Components Web

Progress Indicators

packages/mdc-progress-indicator/README.md

14.0.02.0 KB
Original Source
<!--docs: title: "Progress Indicator" layout: detail section: components excerpt: "Material Design-styled progress indicators." iconId: progress_linear path: /catalog/progress-indicator/ -->

Progress Indicators

The MDC Progress Indicator component exposes common foundation and component interfaces for a progress indicator. Components that implement these interfaces include linear progress and circular progress. Material Design progress & activity requirements.

Installation

npm install @material/progress-indicator

Basic Usage

MDCProgressIndicatorFoundation API

MDC Progress Indicator Foundation exposes the following methods:

Method SignatureDescription
setDeterminate(value: boolean) => voidToggles the component between the determinate and indeterminate state.
isDeterminate() => booleanWhether or not the component is in determinate state.
setProgress(value: number) => voidSets the progress to this value. Value should be between [0, 1].
getProgress() => numberThe current progress value in the interval [0,1].
open() => voidPuts the component in the open state.
close() => voidPuts the component in the closed state.
isClosed() => booleanWhether or not the progress indicator is closed.

MDCProgressIndicator Component API

MDC Progress Indicator exposes the following API:

Method SignatureDescription
determinate: booleanWhether the indicator is in the determinate or indeterminate state.
progress: numberThe current progress. Value should be between [0, 1].
open() => voidPuts the component in the open state.
close() => voidPuts the component in the closed state.