THIS IS AN AUTOGENERATED FILE. EDIT INDEX.JS INSTEAD.

Progress

An unopinionated progress implementation, allowing for a variety of shapes and effects.

Props

Note: only top-level props are in the README, for the full list check out the website.

Required Props

There are no required props.

Optional Props

<tr>
    <td>cancelProps</td>
    <td><pre><code>object</code></pre></td>
    <td><pre><code class="language-js">{}</code></pre></td>
    <td>any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-progress-cancel` node</td>
</tr>

<tr>
    <td>component</td>
    <td><pre><code>string or function</code></pre></td>
    <td><pre><code class="language-js">'div'</code></pre></td>
    <td>any valid HTML tag name or a React component factory, anything that can be passed as the first argument to `React.createElement`</td>
</tr>

<tr>
    <td>label</td>
    <td><pre><code>any renderable</code></pre></td>
    <td><pre><code class="language-js">null</code></pre></td>
    <td>the value to show as a label of the progress, e.g. "50%"</td>
</tr>

<tr>
    <td>labelProps</td>
    <td><pre><code>object</code></pre></td>
    <td><pre><code class="language-js">{}</code></pre></td>
    <td>any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-progress-label` node</td>
</tr>

<tr>
    <td>onCancel</td>
    <td><pre><code>function</code></pre></td>
    <td><pre><code class="language-js">null</code></pre></td>
    <td>if supplied, adds a cancel element and calls this function when that element is clicked</td>
</tr>

<tr>
    <td>progress</td>
    <td><pre><code>string or number</code></pre></td>
    <td><pre><code class="language-js">undefined</code></pre></td>
    <td>the integer (and unit, if applicable) of the current progress state, e.g. 0.01 (opacity)</td>
</tr>

<tr>
    <td>progressProps</td>
    <td><pre><code>object</code></pre></td>
    <td><pre><code class="language-js">{}</code></pre></td>
    <td>any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-progress` node</td>
</tr>

<tr>
    <td>tweenProperty</td>
    <td><pre><code>string</code></pre></td>
    <td><pre><code class="language-js">'width'</code></pre></td>
    <td>the CSS property to tween (must accept percentages) - defaults to "width"</td>
</tr>