material-web/packages/circular-progress
Brian Taylor Vann e398743cab v0.25.2
2021-10-11 21:48:48 +00:00
..
images docs: update component READMEs with a global css properties section 2020-09-02 12:08:04 -07:00
test chore: just import 'lit', it's cleaner 2021-09-27 11:28:08 -07:00
_circular-progress-theme.scss Docs: change license header to SPDX short form 2021-05-17 16:48:25 -07:00
_circular-progress.scss Docs: change license header to SPDX short form 2021-05-17 16:48:25 -07:00
_index.scss Docs: change license header to SPDX short form 2021-05-17 16:48:25 -07:00
.npmignore chore: ignore source typescript files from npm packages (#1742) 2020-08-28 18:24:21 -07:00
mwc-circular-progress-base.ts chore: just import 'lit', it's cleaner 2021-09-27 11:28:08 -07:00
mwc-circular-progress.scss Docs: change license header to SPDX short form 2021-05-17 16:48:25 -07:00
mwc-circular-progress.ts chore: just import 'lit', it's cleaner 2021-09-27 11:28:08 -07:00
package.json v0.25.2 2021-10-11 21:48:48 +00:00
README.md (chore) Update demo links in README for new repo name 2021-08-12 15:39:36 -07:00
tsconfig.json chore: remove src folder from packages in GitHub (#1706) 2020-08-17 17:59:35 -07:00

<mwc-circular-progress> Published on npm

IMPORTANT: The Material Web Components are a work in progress and subject to major changes until 1.0 release.

Progress indicators express an unspecified wait time or display the length of a process.

Material Design Guidelines: Progress Indicators

Demo

Example usage

Determinate

<script type="module">
  import '@material/mwc-circular-progress';
</script>
<mwc-circular-progress progress="0.7"></mwc-circular-progress>

Indeterminate

<mwc-circular-progress indeterminate></mwc-circular-progress>

Styled

<style>
  mwc-circular-progress {
    --mdc-theme-primary: red;
  }
</style>
<mwc-circular-progress indeterminate></mwc-circular-progress>

API

Slots

None

Properties/Attributes

Name Type Default Description
indeterminate boolean false Sets the circular-progress into its indeterminate state.
progress number 0 Sets the progress bar's value. Value should be between [0, 1].
density number 0 Sets the progress indicator's sizing based on density scale. Minimum value is -8. Each unit change in density scale corresponds to 4px change in side dimensions. The stroke width adjusts automatically.
closed boolean false Sets the progress indicator to the closed state. Sets content opacity to 0. Typically should be set to true when loading has finished.

Methods

Name Description
open() => void Sets CircularProgress.closed to false;
close() => void Sets CircularProgress.closed to true;

Events

None

CSS Custom Properties

Name Default Description
--mdc-circular-progress-track-color transparent Sets the track color of the determinate progress bar.

Global Custom Properties

This component exposes the following global theming custom properties.

Name Description
--mdc-theme-primary Sets the color of primary progress bar.