third_party/ot-br-posix/repo/third_party/mdl/repo/src/progress/README.md

   1 ## Introduction
   2
   3 The Material Design Lite (MDL) **progress** component is a visual indicator of background activity in a web page or application. A progress indicator consists of a (typically) horizontal bar containing some animation that conveys a sense of motion. While some progress devices indicate an approximate or specific percentage of completion, the MDL progress component simply communicates the fact that an activity is ongoing and is not yet complete.
   4
   5 Progress indicators are an established but non-standardized feature in user interfaces, and provide users with a visual clue to an application's status. Their design and use is therefore an important factor in the overall user experience. See the progress component's [Material Design specifications page](http://www.google.com/design/spec/components/progress-activity.html) for details.
   6
   7 ### To include an MDL **progress** component:
   8
   9 &nbsp;1. Code a `<div>` element. Include any desired attributes and values, such as an id or width &mdash; typically done using external CSS rather than the inline `style` attribute as shown here.
  10 ```html
  11 <div id="prog1" style="width:250px"></div>
  12 ```
  13 &nbsp;2. Add one or more MDL classes, separated by spaces, to the div using the `class` attribute.
  14 ```html
  15 <div id="prog1" style="width:250px" class="mdl-js-progress"></div>
  16 ```
  17
  18 The progress component is ready for use.
  19
  20 #### Examples
  21
  22 A static (non-animated) progress indicator.
  23 ```html
  24 <div id="progstatic" style="width:250px" class="mdl-js-progress"></div>
  25 ```
  26
  27 An active (animated) progress indicator.
  28 ```html
  29 <div id="progactive" style="width:200px" class="mdl-js-progress
  30  mdl-progress--indeterminate"></div>
  31 ```
  32
  33 ## Configuration options
  34
  35 The MDL CSS classes apply various predefined visual and behavioral enhancements to the progress indicator. The table below lists the available classes and their effects.
  36
  37 | MDL class | Effect | Remarks |
  38 |-----------|--------|---------|
  39 | `mdl-js-progress` | Assigns basic MDL behavior to progress indicator | Required |
  40 | `mdl-progress--indeterminate` | Applies animation effect | Optional |
  41
  42 > Note: `mdl-progress__intermediate` does exist within the codebase. It is deprecated since the name is not in BEM alignment. It will be removed in 2.0.