# Circular Progress
The MDC Circular Progress component is a spec-aligned circular progress indicator component adhering to the
[Material Design progress & activity requirements](https://material.io/go/design-progress-indicators).
## Design & API Documentation
## Installation
```
npm install @material/circular-progress
```
## Basic Usage
### HTML Structure
```html
```
### Accessibility
Progress bars conform to the [WAI-ARIA Progressbar Specification](https://www.w3.org/TR/wai-aria/#progressbar). The supported ARIA attributes for this progress bar are:
| Attribute | Description |
| --------- | ----------- |
| `aria-label` | Label indicating how the progress bar should be announced to the user. |
| `aria-valuemin` | The minimum numeric value of the progress bar, which should always be `0`. |
| `aria-valuemax` | The maximum numeric value of the progress bar, which should always be `1`. |
| `aria-valuenow` | A numeric value between `aria-valuemin` and `aria-valuemax` indicating the progress value of the primary progress bar. This attribute is removed in indeterminate progress bars. |
Note that `aria-label`, `aria-valuemin`, and `aria-valuemax` are static and must be configured in the HTML. `aria-valuenow` is updated dynamically by the foundation when the progress value is updated in determinate progress bars.
### Styles
```scss
@use "@material/circular-progress/mdc-circular-progress";
```
### JavaScript Instantiation
```js
import { MDCCircularProgress } from '@material/circular-progress';
const circularProgress = new MDCCircularProgress(document.querySelector('.mdc-circular-progress'));
```
> See [Importing the JS component](../../docs/importing-js.md) for more information on how to import JavaScript.
## Variants
### Sizing
To set the stroke-width and container size strictly to one of three sizes defined by guidelines, replace the templates with the following.
#### Large (48px)
See [baseline template](#HTML-Structure) above.
#### Medium (36px)
```html
```
#### Small (24px)
```html
```
### Four-Colored
You may choose to have the indicator in inderminate state animate through 4 colors. The template for the four-colored indicator is like that of the [baseline](#HTML-Structure), except the spinner layer is replicated 4 times, 1 for each color. See [Sass-Mixins](#Sass-Mixins) for how to customize the four colors.
This is done instead of animating the color property to reduce browser repaints.
```html
```
## Style Customization
### CSS Classes
CSS Class | Description
--------- | -------------
`mdc-circular-progress` | Mandatory. The root element.
`mdc-circular-progress--indeterminate` | Optional. Puts the circular progress indicator in an indeterminate state. |
`mdc-circular-progress--closed` | Optional. Hides the circular progress indicator. |
`mdc-circular-progress__determinate-container` | Mandatory. Contains the determinate progress indicator.
`mdc-circular-progress__indeterminate-container` | Mandatory. Contains the indeterminate progress indicator.
`mdc-circular-progress__determinate-circle-graphic` | Mandatory. The determinate SVG.
`mdc-circular-progress__determinate-track` | Mandatory. The determinate SVG track.
`mdc-circular-progress__determinate-circle` | Mandatory. The determinate SVG circle.
`mdc-circular-progress__spinner-layer` | Mandatory. Another wrapper around the indeterminate indicator.
`mdc-circular-progress__indeterminate-circle-graphic` | Mandatory. An indeterminate SVG (there are three of these in total).
`mdc-circular-progress__circle-clipper` | Mandatory. Clips an indeterminate SVG circle so that only a section of it is visible.
`mdc-circular-progress__circle-left` | Mandatory. One of two circle sections that when combined are animated to form the full indeterminate progress indicator.
`mdc-circular-progress__circle-right` | Mandatory. One of two circle sections that when combined are animated to form the full indeterminate progress indicator.
`mdc-circular-progress__gap-patch` | Mandatory. A tiny little sliver of an SVG circle used to patch a gap between the circle-left and the circle-right.
> _NOTE_: Ensure the correct inner SVG templates for each size are used to ensure optimal ratio of the stroke width to container size as specified in Material Design guidelines.
### Sass Mixins
Mixin | Description
----- | ------------
`color($color)` | Customizes the stroke-color of the indicator. Applies to the determinate variant, and also the indeterminate variant unless the four-color mixin is applied.
`track-color($color)` | Customizes the track color of the indicator. Applies to the determinate variant only.
`indeterminate-colors($colors)` | Applies four animated stroke-colors to the indeterminate indicator. Applicable to the indeterminate variant only and overrides any single color currently set. Takes a list of exacty four colors.
## `MDCCircularProgress` Properties and Methods
Property | Value Type | Description
-------- | ---------- | --------------
`determinate` | `boolean` (write-only) | Toggles the component between the determinate and indeterminate state.
`progress` | `number` (write-only) | Sets the progress bar to this value. Value should be between 0 and 1.
Method Signature | Description |
---------------- | ----------- |
`open() => void` | Puts the component in the open state. |
`close() => void` | Puts the component in the closed state. |
## Usage within Web Frameworks
### `MDCCircularProgressAdapter`
Method Signature | Description
---------------- | -----------
`addClass(className: string) => void` | Adds a class to the root element.
`getDeterminateCircleAttribute(attributeName: string) => void` | Gets the specified attribute from the determinate circle element.
`hasClass(className: string) => boolean` | Returns boolean indicating whether the root element has a given class.
`removeClass(className: string) => void` | Removes a class from the root element.
`removeAttribute(attributeName: string) => void` | Removes the specified attribute from the root element.
`setAttribute(attributeName: string, value: string) => void` | Sets the specified attribute on the root element.
`setDeterminateCircleAttribute(attributeName: string, value: string) => void` | Sets the specified attribute on the determinate circle element.
### `MDCCircularProgressFoundation`
Method Signature | Description
---------------- | ---
`setDeterminate(value: boolean) => void` | Toggles the component between the determinate and indeterminate state.
`isDeterminate() => boolean` | Whether or not the component is in determinate state.
`setProgress(value: number) => void` | Sets the progress bar to this value. Value should be between [0, 1].
`getProgress() => number` | The current progress value in the interval [0,1].
`open() => void` | Puts the component in the open state.
`close() => void` | Puts the component in the closed state.
`isClosed() => boolean` | Whether or not the progress indicator is closed.