Skip to content

Commit

Permalink
clean up README; add status and class info
Browse files Browse the repository at this point in the history
  • Loading branch information
James A. Rosen committed Sep 23, 2012
1 parent 865c2e9 commit 2856269
Showing 1 changed file with 39 additions and 3 deletions.
42 changes: 39 additions & 3 deletions README.md
@@ -1,6 +1,6 @@
## Ember-Progressbars
## Ember-ProgressBars

This component provides Progressbar views for [Ember.js](http://emberjs.com/)
This component provides progress bar views for [Ember.js](http://emberjs.com/)
that are compatible with
[http://twitter.github.com/bootstrap/](Twitter-Bootstrap).

Expand All @@ -13,8 +13,44 @@ With [http://twitter.github.com/bower/](Bower):

### Usage

The simplest thing that will work:

```handlebars
<h3>Progress:</h3>
{{view Em.Progressbars.Bar
{{view Em.ProgressBars.Bar
percentBinding="App.jobController.percentComplete"}}
```

```html
<h3>Progress:</h3>
<div class="progress">
<div class="bar" style="width: 48%;"></div>
</div>
```

To add classes to the `.progress` container element (like `progress-striped` or
`active`), add them with `classNames`. The container *will retain* the
`.progress` class.

```handlebars
{{view Em.ProgressBars.Bar classNames="progress-striped" ...}}
```

```html
<div class="progress progress-striped">
...
</div>
```

Setting the "status" property on a `Bar` will cause the contained `.bar`
element to gain the class `.bar-{status}`:

```handlebars
{{view Em.ProgressBars.Bar status="warning" ...}}
```

```html
<div class="progress">
<div class="bar bar-warning"...></div>
</div>
```

0 comments on commit 2856269

Please sign in to comment.