xref: /external/chromium-trace/catapult/third_party/polymer/components/paper-spinner

<!---

This README is automatically generated from the comments in these files:
paper-spinner-behavior.html  paper-spinner-lite.html  paper-spinner.html

Edit those files, and our readme bot will duplicate them over here!
Edit this file, and the bot will squash your changes :)

The bot does some handling of markdown. Please file a bug if it does the wrong
thing! https://github.com/PolymerLabs/tedium/issues

-->

[![Build status](https://travis-ci.org/PolymerElements/paper-spinner.svg?branch=master)](https://travis-ci.org/PolymerElements/paper-spinner)

_[Demo and API docs](https://elements.polymer-project.org/elements/paper-spinner)_


##&lt;paper-spinner&gt;

Material design: [Progress & activity](https://www.google.com/design/spec/components/progress-activity.html)

Element providing a multiple color material design circular spinner.

```html
<paper-spinner active></paper-spinner>
```

The default spinner cycles between four layers of colors; by default they are
blue, red, yellow and green. It can be customized to cycle between four different
colors. Use <paper-spinner-lite> for single color spinners.

### Accessibility

Alt attribute should be set to provide adequate context for accessibility. If not provided,
it defaults to 'loading'.
Empty alt can be provided to mark the element as decorative if alternative content is provided
in another form (e.g. a text block following the spinner).

```html
<paper-spinner alt="Loading contacts list" active></paper-spinner>
```

### Styling

The following custom properties and mixins are available for styling:

| Custom property | Description | Default |
| --- | --- | --- |
| `--paper-spinner-layer-1-color` | Color of the first spinner rotation | `--google-blue-500` |
| `--paper-spinner-layer-2-color` | Color of the second spinner rotation | `--google-red-500` |
| `--paper-spinner-layer-3-color` | Color of the third spinner rotation | `--google-yellow-500` |
| `--paper-spinner-layer-4-color` | Color of the fourth spinner rotation | `--google-green-500` |
| `--paper-spinner-stroke-width` | The width of the spinner stroke | 3px |



##&lt;paper-spinner-lite&gt;

Material design: [Progress & activity](https://www.google.com/design/spec/components/progress-activity.html)

Element providing a single color material design circular spinner.

```html
<paper-spinner-lite active></paper-spinner-lite>
```

The default spinner is blue. It can be customized to be a different color.

### Accessibility

Alt attribute should be set to provide adequate context for accessibility. If not provided,
it defaults to 'loading'.
Empty alt can be provided to mark the element as decorative if alternative content is provided
in another form (e.g. a text block following the spinner).

```html
<paper-spinner-lite alt="Loading contacts list" active></paper-spinner-lite>
```

### Styling

The following custom properties and mixins are available for styling:

| Custom property | Description | Default |
| --- | --- | --- |
| `--paper-spinner-color` | Color of the spinner | `--google-blue-500` |
| `--paper-spinner-stroke-width` | The width of the spinner stroke | 3px |



<!-- No docs for Polymer.PaperSpinnerBehavior found. -->