material-design-lite

History

Konstantin Mamaev fd21836fd4 Fix js lint issues (#5013 )		2017-02-24 16:04:07 +00:00
..
snippets	Remove unneeded progress-demo classes from Loading documentation	2015-08-06 09:48:30 +01:00
README.md	Update progress readme for new modifier.	2015-12-23 18:55:32 -05:00
_progress.scss	Change to modifier for intermediate progress state.	2015-12-23 18:54:02 -05:00
progress.js	Fix js lint issues (#5013 )	2017-02-24 16:04:07 +00:00

README.md

Introduction

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.

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 for details.

To include an MDL progress component:

1. Code a <div> element. Include any desired attributes and values, such as an id or width — typically done using external CSS rather than the inline style attribute as shown here.

<div id="prog1" style="width:250px"></div>

2. Add one or more MDL classes, separated by spaces, to the div using the class attribute.

<div id="prog1" style="width:250px" class="mdl-js-progress"></div>

The progress component is ready for use.

Examples

A static (non-animated) progress indicator.

<div id="progstatic" style="width:250px" class="mdl-js-progress"></div>

An active (animated) progress indicator.

<div id="progactive" style="width:200px" class="mdl-js-progress
 mdl-progress--indeterminate"></div>

Configuration options

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.

MDL class	Effect	Remarks
`mdl-js-progress`	Assigns basic MDL behavior to progress indicator	Required
`mdl-progress--indeterminate`	Applies animation effect	Optional

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.