primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-12-11 11:16:04 +03:00
Code Issues Projects Releases Wiki Activity
8ca4c0e7e6
css/modules/primer-progress
History
Shawn Allen 101a8a2d5c Publish 
- primer-alerts@1.5.13
 - primer-avatars@1.5.10
 - primer-base@1.9.2
 - primer-blankslate@1.5.2
 - primer-box@2.5.13
 - primer-branch-name@1.0.11
 - primer-breadcrumb@1.5.9
 - primer-buttons@2.6.4
 - primer-core@6.10.8
 - primer-forms@2.1.8
 - primer-labels@1.5.13
 - primer-layout@1.6.2
 - primer-markdown@3.7.13
 - primer-marketing-buttons@1.0.13
 - primer-marketing-support@1.5.6
 - primer-marketing-type@1.4.13
 - primer-marketing-utilities@1.7.3
 - primer-marketing@6.3.3
 - primer-navigation@1.5.11
 - primer-page-headers@1.5.3
 - primer-page-sections@1.5.3
 - primer-pagination@1.0.7
 - primer-popover@0.1.8
 - primer-product@5.8.3
 - primer-progress@0.1.3
 - primer-subhead@1.0.11
 - primer-support@4.7.2
 - primer-table-object@1.4.13
 - primer-tables@1.5.3
 - primer-tooltips@1.5.11
 - primer-truncate@1.4.13
 - primer-utilities@4.14.3
 - primer@10.10.4
 - primer-module-build@1.0.10
2019-01-11 14:33:26 -08:00
..
lib changed default and modifier component names 2018-10-22 12:47:10 -04:00
index.scss renamed progress bar to progress 2018-10-12 17:22:16 -04:00
LICENSE update year in licenses and source headers to 2019 2019-01-04 10:38:46 -08:00
package.json Publish 2019-01-11 14:33:26 -08:00
README.md add path metadata to all docs 2018-12-17 15:26:50 -08:00
stories.js renamed progress bar to progress 2018-10-12 17:22:16 -04:00

README.md

Primer / Progress

npm version Build Status

Use Progress components to visualize task completion

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

Documentation

Use Progress components to visualize task completion.

Default Progress

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

Large Progress

<span class="Progress Progress--large">
  <span class="Progress-value bg-green" style="width: 50%;"></span>
</span>

Small Progress

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

Progress 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>
</div>

Progress with multiple values

<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