diff --git a/README.md b/README.md index c200a0c..dea07f3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,603 @@ -[![MIT Badge](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/christabor/css-progress-wizard/master/LICENSE) -![Donation badge](https://img.shields.io/gratipay/christabor.svg) - -## A pure css progress indicator! -* Pure CSS (lightweight, easy to implement) -* Flexbox - easy to update and add more items -* Resizeable/responsive (text-resize, etc... try it!) -* Easy to customize design (sass mixins/variables, etc...) -* Written with SASS +[![MIT Badge](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/christabor/css-progress-wizard/master/LICENSE) + +![Donation badge](https://img.shields.io/gratipay/christabor.svg) + +GITHUB https://github.com/christabor/css-progress-wizard + +DEMO http://christabor.github.io/css-progress-wizard/ + +# A pure css progress indicator! + +- Pure CSS (lightweight, easy to implement) + +- Flexbox - easy to update and add more items + +- Resizeable/responsive (text-resize, etc... try it!) + +- Easy to customize design (sass mixins/variables, etc...) + +- Written with SASS + + +## Table of contents + +* [Bar and Progress Format](#bar-and-progress-format-) + * [Bar](#bar-) + * [Horizontal Bar](#horizontal-bar-) + * [Bubble](#bubble-) + * [Bar](#bar-) + * [Vertical Bar](#vertical-bar-) + * [Text and Subdued Text](#text-and-subdued-text-) + * [Bar Format Class](#bar-format-class-) + * [Progress Format Class](#progress-format-class-) + +* [Color](#color-) + * [Bubble](#bubble--) + * [Bar](#bar--) + * [Vertical Bar](#vertical-bar--) + * [Color Class](#color-class-) + +* [Time Line](#time-line-) + + * [Time and sub-info](#time-and-sub-info-) + +* [No Center Align](#no-center-align-) + +* [Icons](#icons-) + + +## Bar and Progress Format [↟](#table-of-contents) + +### Bar [↟](#table-of-contents) + +#### Horizontal Bar [↟](#table-of-contents) + +##### Bubble [↟](#table-of-contents) + +![Bubble](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/screenshots/Bubble.png) + +
Show this example code + +```html + +``` + +
+ +* How to use: + ```html + + + ``` + +##### Bar [↟](#table-of-contents) + +![Bar](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/screenshots/Bar.png) + +
Show this example code + +```html + +``` + +
+ +* How to use: + ```html + + + ``` + +#### Vertical Bar [↟](#table-of-contents) + +![Vertical](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/screenshots/Vertical.png) + +
Show this example code + +```html + + + + + +``` + +
+ +* How to use: + ```html + + + ``` + +##### Text and Subdued Text [↟](#table-of-contents) + +![VerticalText](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/screenshots/VerticalText.png) + +
Show this example code + +```html + +``` +
+ +* How to use: + ```html +
  • + + + I'm stacked-text 1 + + + /I'm a subdued text 1 + + +
  • + ``` + +### Bar Format Class [↟](#table-of-contents) + +| format | class | +| :--------: | :--------: | +| horizontal | (no class) | +| vertical | stacked | + +```html + + +``` + +### Progress Format Class [↟](#table-of-contents) + +| format | class | +| :----: | :-------------------------------: | +| bubble | progress-indicator | +| bar | progress-indicator custom-complex | + +```html + +
  • + +
  • +``` + +## Color [↟](#table-of-contents) + +### Bubble [↟](#table-of-contents) + +![BubbleColor](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/screenshots/BubbleColor.png) + +
    Show this example code + +```html + +``` +
    + +### Bar [↟](#table-of-contents) + +![BarColor](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/screenshots/BarColor.png) + +
    Show vertical bar example code + +```html + +``` + +
    + +### Vertical Bar [↟](#table-of-contents) + +![VerticalColor](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/screenshots/VerticalColor.png) + +
    Show this example code + +```html + + + + + +``` +
    + +### Color Class [↟](#table-of-contents) + +| progress | text & icon color | class | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------- | +| ![img](https://placehold.it/15/65d074/000000?text=+) green | ![img](https://placehold.it/15/65d074/000000?text=+) green | `completed` | +| ![img](https://placehold.it/15/337AB7/000000?text=+) blue | ![img](https://placehold.it/15/337AB7/000000?text=+) blue | `active` | +| ![img](https://placehold.it/15/5b32d6/000000?text=+) purple | ![img](https://placehold.it/15/bbb/000000?text=+) gray | `info` | +| ![img](https://placehold.it/15/edb10a/000000?text=+) yellow | ![img](https://placehold.it/15/bbb/000000?text=+) gray | `warning` | +| ![img](https://placehold.it/15/d3140f/000000?text=+) red | ![img](https://placehold.it/15/bbb/000000?text=+) gray | `danger` | +| ![img](https://placehold.it/15/bbb/000000?text=+) gray | ![img](https://placehold.it/15/bbb/000000?text=+) gray | no class | + +```html + + +``` + +## Time Line [↟](#table-of-contents) + +![Time Line](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/screenshots/TimeLine.png) + +
    Show this example code + +```html + +
    +

    How about a speaker timeline?

    + +
    +``` + +
    + +* How to use: + ```html +
    + (...) +
    + ``` + +### Time and sub-info [↟](#table-of-contents) + +```html +
    (...) + + (time) + + + (...) + +
    +``` + +## No Center Align [↟](#table-of-contents) + +![NoCenter](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/screenshots/NoCenter.png) + +
    Show this example code + +```html + + +``` + +
    + +* How to use: + ```html + + ``` + +## Icons [↟](#table-of-contents) + +Font Awesome Icons. + +![Icons](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/screenshots/Icons.png) + +
    Show this example code + +```html + +``` + +
    + +| class | image | +| ------------ | ------------------------------------------------------------ | +| check-circle | ![img](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/icon/check-circle.png) | +| minus | ![img](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/icon/minus.png) | +| exclamation | ![img](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/icon/exclamation.png) | +| calendar | ![img](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/icon/calendar.png) | +| comment | ![img](https://raw.githubusercontent.com/maico910/css-progress-wizard/maico910-patch-1/icon/comment.png) | + +```html + +``` diff --git a/icon/calendar.png b/icon/calendar.png new file mode 100644 index 0000000..ae2e590 Binary files /dev/null and b/icon/calendar.png differ diff --git a/icon/check-circle.png b/icon/check-circle.png new file mode 100644 index 0000000..41d1319 Binary files /dev/null and b/icon/check-circle.png differ diff --git a/icon/comment.png b/icon/comment.png new file mode 100644 index 0000000..7530ba6 Binary files /dev/null and b/icon/comment.png differ diff --git a/icon/exclamation.png b/icon/exclamation.png new file mode 100644 index 0000000..65bff3a Binary files /dev/null and b/icon/exclamation.png differ diff --git a/icon/minus.png b/icon/minus.png new file mode 100644 index 0000000..e272c9d Binary files /dev/null and b/icon/minus.png differ diff --git a/index.html b/index.html index e6a396d..9948e38 100644 --- a/index.html +++ b/index.html @@ -6,7 +6,7 @@ CSS Progress wizard - +