ProgressBar.js

Version: 0.8.1 (previous stable)

![Beautiful animation](docs/animation.gif)
Beautiful and responsive progress bars with animated SVG paths. Use built-in shapes or [create your own paths](#pathpath-options). [Customize](#custom-animations) the animations as you wish.

Shortcuts

Get started

Build status and browser tests for current master

ProgressBar.js is lightweight, MIT licensed and supports all major browsers including IE9+. See complete examples in examples section.

Installing options:

Using bower
```
  bower install progressbar.js
```
Using npm
```
  npm install progressbar.js
```
Including dist/progressbar.js or dist/progressbar.min.js from latest tag to your project.

Loading module

Files in dist/ folder are UMD modules built with Browserify's --standalone switch. Read more about standalone Browserify builds.

CommonJS

var ProgressBar = require('progressbar.js')
var line = new ProgressBar.Line('#container');

AMD

require.config({
    paths: {"progressbar": "../bower_components/progressbar.js/dist/progressbar"}
});

define(['progressbar'], function(ProgressBar) {
    var line = new ProgressBar.Line('#container');
});

Global variable

// If you aren't using any module loader, progressbar.js exposes
// global variable: window.ProgressBar
var line = new ProgressBar.Line('#container');

How it works

Progress bars are just regular SVG paths. Read Jake Archibald's blog post to see how the path drawing works under the hood.

ProgressBar.js uses shifty tweening library to animate path drawing. So in other words, animation is done with JavaScript using requestAnimationFrame. Animating with JS gives more control over the animation and is supported across major browsers. For example IE does not support animating SVG properties with CSS transitions.

API

NOTE: Line, Circle and SemiCircle all point to the same documentation which is named Shape. You almost certainly should replace it(Shape) with Line, Circle or SemiCircle.

Example: if documentation states Shape.animate(), replace it with Circle.animate(), simple. Shape is the base object for all progress bars and currently undocumented internal module.

ProgressBar

Line(container, [options])
Circle(container, [options])
SemiCircle(container, [options])
Path(path, [options])

Functions use node-style callback convention. Callback function is always the last given parameter.

Shapes have different SVG canvas sizes:

Shape	Canvas size
Circle	`100x100`
SemiCircle	`100x50`
Line	`100x{opts.strokeWidth}`

All shapes are fitted exactly to their canvases.

Shape(container, [options])

Line, Circle or SemiCircle shaped progress bar. Appends SVG to container.

Example

var progressBar = new ProgressBar.Circle('#container', {
    strokeWidth: 2
});

To make the shape resize with its container, set for example the following CSS:

#container > svg {
    display: block;
    width: 100%;
}

Note: this is just an example, you probably shouldn't use IDs in CSS selectors.

https://github.com/CSSLint/csslint/wiki/Disallow-IDs-in-selectors

http://oli.jp/2011/ids/

With Line shape, you can control the width of the line by specifying e.g. height: 5px with CSS.

Parameters

container Element where SVG is added. Query string or element.

For example "#container" or document.getElementById("#container")

options Options for path drawing.

{
    // Stroke color.
    // Default: "#555"
    color: "#3a3a3a",

    // Width of the stroke.
    // Unit is percentage of SVG canvas' size.
    // Default: 1.0
    strokeWidth: 2.1,

    // If trail options are not defined, trail won't be drawn

    // Color for lighter trail stroke
    // underneath the actual progress path.
    // Default: '#eee'
    trailColor: "#f4f4f4",

    // Width of the trail stroke. Trail is always centered relative to
    // actual progress path.
    // Default: same as strokeWidth
    trailWidth: 0.8,

    // Text options. Text element is a <p> element appended to container
    // You can add CSS rules for the text element with the className
    // NOTE: When text is set, 'position: relative' will be set to the
    // container for centering. You can also prevent all style modifications
    // with 'autoStyle: false'
    // Default: null
    text: {
        // Initial value for text.
        // Default: null
        value: 'Text',

        // Text color.
        // Default: same as stroke color (options.color)
        color: '#f00',

        // Class name for text element.
        // Default: 'progressbar-text'
        className: 'progressbar__label',

        // If true, CSS is automatically set for container and text element.
        // If you want to modify all CSS your self, set this to false
        // Default: true
        autoStyle: true,

        // Only effective when autoStyle is enabled.
        // If true, padding and margin are removed automatically
        // from text element. Set this to false, if you want to
        // set margin or padding for text element
        // Default: true
        removeMarginPadding: true,

        // Only effective if the shape is SemiCircle.
        // If true, baseline for text is aligned with bottom of
        // the SVG canvas. If false, bottom line of SVG canvas
        // is in the center of text.
        // Default: false
        alignToBottom: false
    },

    // Fill color for the shape. If null, no fill.
    // Default: null
    fill: "rgba(0, 0, 0, 0.5)",

    // Duration for animation in milliseconds
    // Default: 800
    duration: 1200,

    // Easing for animation. See #easing section.
    // Default: "linear"
    easing: "easeOut",

    // See #custom-animations section
    // Built-in shape passes reference to itself and a custom attachment
    // object to step function
    from: { color: '#eee' },
    to: { color: '#000' },
    step: function(state, circle, attachment) {
        circle.path.setAttribute('stroke', state.color);
    }
}

Shape.svg

Reference to SVG element where progress bar is drawn.

Shape.path

Reference to SVG path which presents the actual progress bar.

Shape.trail

Reference to SVG path which presents the trail of the progress bar. Returns null if trail is not defined.

Shape.text

Reference to p element which presents the text label for progress bar. Returns null if text is not defined.

Shape.animate(progress, [options], [cb])

Animates drawing of a shape.

Example

progressBar.animate(0.3, {
    duration: 800
}, function() {
    console.log('Animation has finished');
});

Parameters

progress progress from 0 to 1.

options Animation options. These options override the defaults given in initialization.

{
    // Duration for animation in milliseconds
    // Default: 800
    duration: 1200,

    // Easing for animation. See #easing section.
    // Default: "linear"
    easing: "easeInOut",

    // See #custom-animations section
    // Built-in shape passes reference to itself and a custom attachment
    // object to step function
    from: { color: '#eee' },
    to: { color: '#000' },
    step: function(state, circle, attachment) {
        circle.path.setAttribute('stroke', state.color);
    }
}

cb Callback function which is called after animation ends.

Shape.set(progress)

Sets progress instantly without animation. Clears all animations for path.

Shape.stop()

Stops animation to its current position.

Shape.value()

Returns current shown progress from 0 to 1. This value changes when animation is running.

Shape.setText(text)

Sets text to given a string. If you need to dynamically modify the text element, see .text attribute.

Shape.destroy()

Removes SVG element from container and removes all references to DOM elements. Destroying is irreversible.

Path(path, [options])

Custom shaped progress bar. You can create arbitrary shaped progress bars by passing a SVG path created with e.g. Adobe Illustrator. It's on caller's responsibility to append SVG to DOM.

Example

Assuming there was SVG object with heart shaped path in HTML

<svg xmlns="http://www.w3.org/2000/svg" version="1.1" x="0px" y="0px" viewBox="0 0 100 100">
    <path fill-opacity="0" stroke-width="0.5" stroke="#f4f4f4" d="M81.495,13.923c-11.368-5.261-26.234-0.311-31.489,11.032C44.74,13.612,29.879,8.657,18.511,13.923  C6.402,19.539,0.613,33.883,10.175,50.804c6.792,12.04,18.826,21.111,39.831,37.379c20.993-16.268,33.033-25.344,39.819-37.379  C99.387,33.883,93.598,19.539,81.495,13.923z"/>
    <path id="heart-path" fill-opacity="0" stroke-width="0.6" stroke="#555" d="M81.495,13.923c-11.368-5.261-26.234-0.311-31.489,11.032C44.74,13.612,29.879,8.657,18.511,13.923  C6.402,19.539,0.613,33.883,10.175,50.804c6.792,12.04,18.826,21.111,39.831,37.379c20.993-16.268,33.033-25.344,39.819-37.379  C99.387,33.883,93.598,19.539,81.495,13.923z"/>
</svg>

Initialization would be this easy

var svgPath = document.getElementById("heart-path");
var path = new ProgressBar.Path(svgPath, {
    duration: 300
});

Working with embedded SVG

If the SVG was not inline in the HTML but instead in, say, an <object> tag, we'd have to take extra steps to wait until it has loaded and then access it differently since it's in a separate DOM tree. Given e.g.:

<object id="heart" type="image/svg+xml" data="heart.svg">No SVG support :(</object>

we could do

var heart = document.getElementById('heart');
heart.addEventListener('load', function () {
var path = new ProgressBar.Path(heartObject.contentDocument.querySelector('#heart-path'), {
    duration: 300
});

Parameters

path SVG Path object. For example $('svg > path:first-child')[0].

options Animation options.

{
    // Duration for animation in milliseconds
    // Default: 800
    duration: 1200,

    // Easing for animation. See #easing section.
    // Default: "linear"
    easing: "easeIn",

    // Attachment which can be any object
    // you need to modify within the step function.
    // Passed as a parameter to step function.
    // Default: undefined
    attachment: document.querySelector('#container > svg'),

    // See #custom-animations section
    from: { color: '#eee' },
    to: { color: '#000' },
    step: function(state, path, attachment) {
        // Do any modifications to attachment and/or path attributes
    }
}

Path.path

Reference to SVG path which presents the actual progress bar.

Path.animate(progress, [options], [cb])

Animates drawing of path.

Example

path.animate(0.3, {
    duration: 800
}, function() {
    console.log('Animation has finished');
});

Parameters

progress progress from 0 to 1.

options Animation options. These options override the defaults given in initialization.

{
    // Duration for animation in milliseconds
    // Default: 800
    duration: 1200,

    // Easing for animation. See #easing section.
    // Default: "linear"
    easing: "easeOut",

    // Attachment which can be any object
    // you need to modify within the step function.
    // Passed as a parameter to step function.
    // Default: undefined
    attachment: document.querySelector('#container > svg'),

    // See #custom-animations section
    from: { color: '#eee' },
    to: { color: '#000' },
    step: function(state, path, attachment) {
        // Do any modifications to attachment and/or path attributes
    }
}

cb Callback function which is called after transition ends.

Path.set(progress)

Set progress instantly without animation. Clears all transitions for path.

Path.stop()

Stops animation to its current position.

Path.value()

Returns current shown progress from 0 to 1. This value changes when animation is running.

Parameters in detail

Easing

Easing functions provided with shifty are supported.

A few basic easing options:

"linear"
"easeIn"
"easeOut"
"easeInOut"

Custom animations

See example in demo page.

Customizing animations is possible with the help of from, to and step parameters. Tweening engine changes defined values over time and calls step function for each animation's frame.

from Object containing values which should be tweened. These values represent the starting values of the animation. Default: {}.

For example
```
{
    // Start from thin gray line
    width: 0.1,
    color: "#eee"
}
```
Thanks to shifty, you can tween values in formats like translateX(45px), rgb(0,255,0) and #fff. See all supported string formats from shifty's documentation

Easing defined as option for animation applies to all of the specified values.
to Object containing values which should be tweened. These represent the final values after animation is done. Default: {}.

For example
```
{
    // Finish to thick black line
    width: 1,
    color: "#000"
}
```
Signature must match from
step Function called for each animation step. Tweened values, a reference to the path or shape, and an attachment are passed as parameters. Attachment can be reference to any object you need to modify within step function. Default: function() {}.

This function is called multiple times per second. To make sure animations run smoothly, keep it minimal.

For example
```
function(state, shape, attachment) {
    shape.path.setAttribute('stroke-width', state.width);
    shape.path.setAttribute('stroke', state.color);
    attachment.text.innerHTML = shape.value()*100;
}
```

Note: There's a big difference between passing the from and to parameters in initialization of progress bar compared to passing in .animate() call. Here's example code and illustrations to explain the difference:

Pass in initialization

var bar = new ProgressBar.Line('#container', {
    from: { color: '#000 '},
    to: { color: '#888 '},
    step: function(state, bar, attachment) {
        bar.path.setAttribute('stroke', state.color);
    }
});

Pass in .animate() call

var bar = new ProgressBar.Line('#container', {
    step: function(state, bar, attachment) {
        bar.path.setAttribute('stroke', state.color);
    }
});

var opts = {
    from: { color: '#000 '},
    to: { color: '#888 '}
};
bar.animate(0.5, opts);

Examples

Contributing

See documentation for contributors.

Thanks

This project is a grateful recipient of the Futurice Open Source sponsorship program.

myste1tainn/progressbar.js

ProgressBar.js

Get started

Installing options:

Loading module

How it works

API

Shape(container, [options])

Shape.svg

Shape.path

Shape.trail

Shape.text

Shape.animate(progress, [options], [cb])

Shape.set(progress)

Shape.stop()

Shape.value()

Shape.setText(text)

Shape.destroy()

Path(path, [options])

Path.path

Path.animate(progress, [options], [cb])

Path.set(progress)

Path.stop()

Path.value()

Parameters in detail

Easing

Custom animations

Examples

Contributing

Thanks