primer-progress

Primer / Progress

TODO: fill in this description later

This repository is a module of the full primer repository.

Install

This repository is distributed with npm. After installing npm, you can install primer-progress with this command.

$ npm install --save primer-progress

Usage

The source files included are written in Sass (SCSS) You can simply point your sass include-path at your node_modules directory and import it like this.

@import "primer-progress/index.scss";

You can also import specific portions of the module by importing those partials from the /lib/ folder. Make sure you import any requirements along with the modules.

Build

For a compiled CSS version of this module, an npm script is included that will output a css version to build/build.css The built css file is also included in the npm package:

$ npm run build

Default Progress Bar

<span class="Progress">
  <span class="Progress-value bg-green" style="width: 50%;"></span>
  <span class="Progress-value bg-purple" style="width: 25%;"></span>
  <span class="Progress-value bg-red" style="width: 5%;"></span>
</span>

Small Progress Bar

<span class="Progress Progress--small">
  <span class="Progress-value bg-green" style="width: 50%;"></span>
  <span class="Progress-value bg-purple" style="width: 25%;"></span>
  <span class="Progress-value bg-red" style="width: 5%;"></span>
</span>

Progress Bar With Tooltip

<div class="tooltipped tooltipped-n" aria-label="78 done / 6 in progress / 2 to do">
  <span class="Progress">
    <span class="Progress-value bg-green" style="width: 50%;"></span>
    <span class="Progress-value bg-purple" style="width: 25%;"></span>
    <span class="Progress-value bg-red" style="width: 5%;"></span>
  </span>
</div>

License

MIT © GitHub