Skip to content

(docs): change progress-circle to progress-spinner #2313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 21, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ High level items planned for December 2016:
| list | Available | [README][8] | [#107][0107] |
| grid-list | Available | [README][9] | - |
| icon | Available | [README][10] | - |
| progress-circle | Available | [README][11] | - |
| progress-spinner | Available | [README][11] | - |
| progress-bar | Available | [README][12] | - |
| tabs | Available | [README][13] | - |
| slide-toggle | Available | [README][14] | - |
Expand Down Expand Up @@ -95,7 +95,7 @@ High level items planned for December 2016:
[8]: https://github.com/angular/material2/blob/master/src/lib/list/README.md
[9]: https://github.com/angular/material2/blob/master/src/lib/grid-list/README.md
[10]: https://github.com/angular/material2/blob/master/src/lib/icon/README.md
[11]: https://github.com/angular/material2/blob/master/src/lib/progress-circle/README.md
[11]: https://github.com/angular/material2/blob/master/src/lib/progress-spinner/README.md
[12]: https://github.com/angular/material2/blob/master/src/lib/progress-bar/README.md
[13]: https://github.com/angular/material2/blob/master/src/lib/tabs/README.md
[14]: https://github.com/angular/material2/blob/master/src/lib/slide-toggle/README.md
Expand Down
18 changes: 9 additions & 9 deletions src/lib/progress-spinner/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# md-progress-circle
# md-progress-spinner

`md-progress-circle` is a component for indicating progress and activity, matching the spec of
`md-progress-spinner` is a component for indicating progress and activity, matching the spec of
[Material Design Progress & Activity](https://www.google.com/design/spec/components/progress-activity.html).

### Progress Modes

There are two modes:
1. Determinate - `<md-progress-circle mode="determinate">`
1. Determinate - `<md-progress-spinner mode="determinate">`
* Indicates how long an operation will take when the percentage complete is detectable.
2. Indeterminate - `<md-progress-circle mode="indeterminate">` or `<md-spinner>`
2. Indeterminate - `<md-progress-spinner mode="indeterminate">` or `<md-spinner>`
* Indicates the user must wait while something finishes when it’s not necessary or possible to indicate how long it
will take.

Example:

```html
<md-progress-circle mode="determinate" [value]="myValue"></md-progress-circle>
<md-progress-circle mode="indeterminate"></md-progress-circle>
<md-progress-spinner mode="determinate" [value]="myValue"></md-progress-spinner>
<md-progress-spinner mode="indeterminate"></md-progress-spinner>
<md-spinner></md-spinner>
```

Expand All @@ -27,9 +27,9 @@ All progress indicators can be themed to match your "primary" palette, your "acc
Example:

```html
<md-progress-circle mode="indeterminate" color="primary"></md-progress-circle>
<md-progress-circle mode="indeterminate" color="accent"></md-progress-circle>
<md-progress-circle mode="indeterminate" color="warn"></md-progress-circle>
<md-progress-spinner mode="indeterminate" color="primary"></md-progress-spinner>
<md-progress-spinner mode="indeterminate" color="accent"></md-progress-spinner>
<md-progress-spinner mode="indeterminate" color="warn"></md-progress-spinner>
```

### Accessibility
Expand Down