Skip to content
Create nice and customizable progress bar
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.resources
demo
doc/sass
src
tests
.babelrc
.browserslistrc
.editorconfig
.eslintrc
.gitignore
.node-version
.prettierrc
.stylelintrc
.travis.yml
LICENSE
README.md
_index.scss
code-playground.config.js
package-lock.json
package.json
webpack.config.js

README.md

Coffeekraken s-progress-bar-component

Create nice and customizable progress bar

View demo

Table of content

  1. Demo
  2. Install
  3. Get Started
  4. SASS API
  5. Browsers support
  6. Code linting
  7. Contribute
  8. Who are Coffeekraken?
  9. Licence

Install

npm install coffeekraken-s-progress-bar-component --save

Get Started

First, import and setup the Coffeekraken Sugar toolkit

Then, import the component into your scss file like so:

@import 'node_modules/coffeekraken-s-progress-bar-component/index';

Then, generate the classes like so:

@include s-progress-bar-classes(
  $colors: default primary secondary
);

Then simply use it inside your html like so:

<div class="progress-bar" value="50"></div>
<div class="progress-bar progress-bar--primary" value="75"></div>
<div class="progress-bar progress-bar--secondary progress-bar--stripped" value="33"></div>

Note the value attribute. This is how you set the value of yout progress bar. It has to be an integer between 0 and 100

Browsers support

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
IE11+ last 2 versions last 2 versions last 2 versions

As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.

The webcomponent API (custom elements, shadowDOM, etc...) is not supported in some older browsers like IE10, etc... In order to make them work, you will need to integrate the corresponding polyfill.

Code linting

This package uses some code linting rules. Here's the list:

  1. StandardJS for javascript files
  2. Stylelint with stylelint-config-standard for scss files

Your commits will not been accepted if the code style is not respected!

Contribute

This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:

  1. Share the love ❤️
  2. Declare issues
  3. Fix issues
  4. Add features
  5. Build web component

Who are Coffeekraken

We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.

More on who we are

License

The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...

You can’t perform that action at this time.