OLD | NEW |
1 | 1 |
2 <!--- | 2 <!--- |
3 | 3 |
4 This README is automatically generated from the comments in these files: | 4 This README is automatically generated from the comments in these files: |
5 paper-spinner-behavior.html paper-spinner-lite.html paper-spinner.html | 5 paper-spinner-behavior.html paper-spinner-lite.html paper-spinner.html |
6 | 6 |
7 Edit those files, and our readme bot will duplicate them over here! | 7 Edit those files, and our readme bot will duplicate them over here! |
8 Edit this file, and the bot will squash your changes :) | 8 Edit this file, and the bot will squash your changes :) |
9 | 9 |
| 10 The bot does some handling of markdown. Please file a bug if it does the wrong |
| 11 thing! https://github.com/PolymerLabs/tedium/issues |
| 12 |
10 --> | 13 --> |
11 | 14 |
12 [](https://travis-ci.org/PolymerElements/paper-spinner) | 15 [](https://travis-ci.org/PolymerElements/paper-spinner) |
13 | 16 |
14 _[Demo and API Docs](https://elements.polymer-project.org/elements/paper-spinner
)_ | 17 _[Demo and API docs](https://elements.polymer-project.org/elements/paper-spinner
)_ |
15 | 18 |
16 | 19 |
17 ##<paper-spinner> | 20 ##<paper-spinner> |
18 | 21 |
19 | |
20 Material design: [Progress & activity](https://www.google.com/design/spec/compon
ents/progress-activity.html) | 22 Material design: [Progress & activity](https://www.google.com/design/spec/compon
ents/progress-activity.html) |
21 | 23 |
22 Element providing a multiple color material design circular spinner. | 24 Element providing a multiple color material design circular spinner. |
23 | 25 |
24 <paper-spinner active></paper-spinner> | 26 ```html |
| 27 <paper-spinner active></paper-spinner> |
| 28 ``` |
25 | 29 |
26 The default spinner cycles between four layers of colors; by default they are | 30 The default spinner cycles between four layers of colors; by default they are |
27 blue, red, yellow and green. It can be customized to cycle between four differen
t | 31 blue, red, yellow and green. It can be customized to cycle between four differen
t |
28 colors. Use <paper-spinner-lite> for single color spinners. | 32 colors. Use <paper-spinner-lite> for single color spinners. |
29 | 33 |
30 ### Accessibility | 34 ### Accessibility |
31 | 35 |
32 Alt attribute should be set to provide adequate context for accessibility. If no
t provided, | 36 Alt attribute should be set to provide adequate context for accessibility. If no
t provided, |
33 it defaults to 'loading'. | 37 it defaults to 'loading'. |
34 Empty alt can be provided to mark the element as decorative if alternative conte
nt is provided | 38 Empty alt can be provided to mark the element as decorative if alternative conte
nt is provided |
35 in another form (e.g. a text block following the spinner). | 39 in another form (e.g. a text block following the spinner). |
36 | 40 |
37 <paper-spinner alt="Loading contacts list" active></paper-spinner> | 41 ```html |
| 42 <paper-spinner alt="Loading contacts list" active></paper-spinner> |
| 43 ``` |
38 | 44 |
39 ### Styling | 45 ### Styling |
40 | 46 |
41 The following custom properties and mixins are available for styling: | 47 The following custom properties and mixins are available for styling: |
42 | 48 |
43 Custom property | Description | Default | 49 | Custom property | Description | Default | |
44 ----------------|-------------|---------- | 50 | --- | --- | --- | |
45 `--paper-spinner-layer-1-color` | Color of the first spinner rotation | `--googl
e-blue-500` | 51 | `--paper-spinner-layer-1-color` | Color of the first spinner rotation | `--goo
gle-blue-500` | |
46 `--paper-spinner-layer-2-color` | Color of the second spinner rotation | `--goog
le-red-500` | 52 | `--paper-spinner-layer-2-color` | Color of the second spinner rotation | `--go
ogle-red-500` | |
47 `--paper-spinner-layer-3-color` | Color of the third spinner rotation | `--googl
e-yellow-500` | 53 | `--paper-spinner-layer-3-color` | Color of the third spinner rotation | `--goo
gle-yellow-500` | |
48 `--paper-spinner-layer-4-color` | Color of the fourth spinner rotation | `--goog
le-green-500` | 54 | `--paper-spinner-layer-4-color` | Color of the fourth spinner rotation | `--go
ogle-green-500` | |
| 55 | `--paper-spinner-stroke-width` | The width of the spinner stroke | 3px | |
49 | 56 |
50 | 57 |
51 | 58 |
52 ##<paper-spinner-lite> | 59 ##<paper-spinner-lite> |
53 | 60 |
54 | |
55 Material design: [Progress & activity](https://www.google.com/design/spec/compon
ents/progress-activity.html) | 61 Material design: [Progress & activity](https://www.google.com/design/spec/compon
ents/progress-activity.html) |
56 | 62 |
57 Element providing a single color material design circular spinner. | 63 Element providing a single color material design circular spinner. |
58 | 64 |
59 <paper-spinner-lite active></paper-spinner-lite> | 65 ```html |
| 66 <paper-spinner-lite active></paper-spinner-lite> |
| 67 ``` |
60 | 68 |
61 The default spinner is blue. It can be customized to be a different color. | 69 The default spinner is blue. It can be customized to be a different color. |
62 | 70 |
63 ### Accessibility | 71 ### Accessibility |
64 | 72 |
65 Alt attribute should be set to provide adequate context for accessibility. If no
t provided, | 73 Alt attribute should be set to provide adequate context for accessibility. If no
t provided, |
66 it defaults to 'loading'. | 74 it defaults to 'loading'. |
67 Empty alt can be provided to mark the element as decorative if alternative conte
nt is provided | 75 Empty alt can be provided to mark the element as decorative if alternative conte
nt is provided |
68 in another form (e.g. a text block following the spinner). | 76 in another form (e.g. a text block following the spinner). |
69 | 77 |
70 <paper-spinner-lite alt="Loading contacts list" active></paper-spinner-lite> | 78 ```html |
| 79 <paper-spinner-lite alt="Loading contacts list" active></paper-spinner-lite> |
| 80 ``` |
71 | 81 |
72 ### Styling | 82 ### Styling |
73 | 83 |
74 The following custom properties and mixins are available for styling: | 84 The following custom properties and mixins are available for styling: |
75 | 85 |
76 Custom property | Description | Default | 86 | Custom property | Description | Default | |
77 ----------------|-------------|---------- | 87 | --- | --- | --- | |
78 `--paper-spinner-color` | Color of the spinner | `--google-blue-500` | 88 | `--paper-spinner-color` | Color of the spinner | `--google-blue-500` | |
| 89 | `--paper-spinner-stroke-width` | The width of the spinner stroke | 3px | |
79 | 90 |
80 | 91 |
81 | 92 |
82 <!-- No docs for Polymer.PaperSpinnerBehavior found. --> | 93 <!-- No docs for Polymer.PaperSpinnerBehavior found. --> |
OLD | NEW |