Skip to content

Commit 086a402

Browse files
josephperrottjelbourn
authored andcommitted
docs(md-progress-circle): Add README.
Closes #184
1 parent de1be09 commit 086a402

File tree

3 files changed

+62
-11
lines changed

3 files changed

+62
-11
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# md-progress-circle
2+
3+
`md-progress-circle` is a component for indicating progress and activity, matching the spec of
4+
[Material Design Progress & Activity](https://http://www.google.com/design/spec/components/progress-activity.html).
5+
6+
### Progress Modes
7+
8+
There are two modes:
9+
1. Determinate - `<md-progress-circle mode="determinate">`
10+
* Indicates how long an operation will take when the percentage complete is detectable.
11+
2. Indeterminate - `<md-progress-circle mode="indeterminate">` or `<md-spinner>`
12+
* Indicates the user must wait while something finishes when it’s not necessary or possible to indicate how long it
13+
will take.
14+
15+
Example:
16+
17+
```html
18+
<md-progress-circle mode="determinate" value="myValue"></md-progress-circle>
19+
<md-progress-circle mode="indeterminate"></md-progress-circle>
20+
<md-spinner></md-spinner>
21+
```
22+
23+
### Theming
24+
25+
All progress indicators can be themed to match your "primary" palette, your "accent" palette, or your "warn" palette using the appropriate class.
26+
27+
Example:
28+
29+
```html
30+
<md-progress-circle mode="indeterminate" color="primary"></md-progress-circle>
31+
<md-progress-circle mode="indeterminate" color="accent"></md-progress-circle>
32+
<md-progress-circle mode="indeterminate" color="warn"></md-progress-circle>
33+
```
34+
35+
### Accessibility
36+
37+
* ARIA attributes are applied to the indicator defining the valuemin, valuemax and valuenow attributes.
38+
39+
### Upcoming work
40+
41+
* Adding ARIA attribute for progressbar "for".
42+
43+
### API Summary
44+
45+
Properties:
46+
47+
| Name | Type | Description |
48+
| --- | --- | --- |
49+
| `color` | `"primary"|"accent"|"warn"` | The color palette of the progress indicator |
50+
| `mode` | `"determinate"|"indeterminate"` | The mode of the progress indicator |
51+
| `value` | number | The current progress percentage for determinate indicators |

src/components/progress-circle/progress-circle.scss

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ $md-progress-circle-viewport-size : 100px !default;
6363
}
6464

6565

66-
&.md-accent circle {
66+
&[color="accent"] circle {
6767
stroke: md-color($md-accent, 600);
6868
}
6969

7070

71-
&.md-warn circle {
71+
&[color="warn"] circle {
7272
stroke: md-color($md-warn, 600);
7373
}
7474

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<h1>Determinate</h1>
22
<div class="demo-progress-circle">
3-
<md-progress-circle mode="determinate"
4-
[value]="progressValue"
5-
class="md-primary"></md-progress-circle>
6-
<md-progress-circle [value]="progressValue"
7-
class="md-accent"></md-progress-circle>
3+
<md-progress-circle mode="determinate"
4+
[value]="progressValue"
5+
class="md-primary"></md-progress-circle>
6+
<md-progress-circle [value]="progressValue"
7+
color="accent"></md-progress-circle>
88
</div>
99
<span>Value: {{progressValue}}</span>
1010
<button md-raised-button (click)="step(10)">Increase</button>
@@ -14,8 +14,8 @@ <h1>Determinate</h1>
1414

1515
<h1>Indeterminate</h1>
1616
<div class="demo-progress-circle">
17-
<md-progress-circle mode="indeterminate"></md-progress-circle>
18-
<md-progress-circle mode="indeterminate"
19-
class="md-accent"></md-progress-circle>
20-
<md-spinner></md-spinner>
17+
<md-progress-circle mode="indeterminate"></md-progress-circle>
18+
<md-progress-circle mode="indeterminate"
19+
color="accent"></md-progress-circle>
20+
<md-spinner></md-spinner>
2121
</div>

0 commit comments

Comments
 (0)