## A HTML component to illustrate the steps in a multi step process e.g. a multi step form, a timeline or a quiz.

### Basic usage

### Center aligned

### Right aligned

### Text inside markers

### Spaced markers

### Border

### Color theme

### Text on markers

- #### Step 1

  Summary text explaining this step to the user

- #### Step 2

  Summary text explaining this step to the user

- #### Step 3

  Summary text explaining this step to the user

- #### Step 4

  Shorter summary text

- #### Step 5

  Shorter summary text

### Center aligned

- #### Step 1

  Summary text explaining this step to the user

- #### Step 2

  Summary text explaining this step to the user

- #### Step 3

  Summary text explaining this step to the user

- #### Step 4

  Shorter summary text

- #### Step 5

  Shorter summary text

### Right aligned

- #### Step 1

  Summary text explaining this step to the user

- #### Step 2

  Summary text explaining this step to the user

- #### Step 3

  Summary text explaining this step to the user

- #### Step 4

  Shorter summary text

- #### Step 5

  Shorter summary text

### Link surrounding each step

- #### Step 1

  Summary text explaining this step to the user

- #### Step 2

  Summary text explaining this step to the user

- #### Step 3

  Summary text explaining this step to the user

- #### Step 4

  Shorter summary text

- #### Step 5

  Shorter summary text

### Dots connecting text to markers

- #### Step 1

  Summary text explaining this step to the user

- #### Step 2

  Summary text explaining this step to the user

- #### Step 3

  Summary text explaining this step to the user

- #### Step 4

  Shorter summary text

- #### Step 5

  Shorter summary text

### Text above markers

- #### Step 1

  Summary text explaining this step to the user

- #### Step 2

  Summary text explaining this step to the user

- #### Step 3

  Summary text explaining this step to the user

- #### Step 4

  Shorter summary text

- #### Step 5

  Shorter summary text

### Text to the left of markers

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

### Text to the right of markers

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

### Square markers

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

### Small screen optimised <=575px

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

## Animations

The animation class can be applied to the progress tracker so each step has the same animation. Alternatively you can add the animation class to the progress step to have different animation on each step.

- #### Ripple

- #### Ripple large

- #### Ripple splash

- #### Ripple double

- #### Ripple double large

### Fill path between steps

This site has some basic javascript to demonstrate this effect.

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

### Partial fill of steps

- #### 10%

- #### 30%

- #### 50%

- #### 70%

- #### 90%

### Vertical layout

- #### Step 1

  Summary text explaining this step to the user

- #### Step 2

  Summary text explaining this step to the user

- #### Step 3

  Summary text explaining this step to the user

- #### Step 4

  Summary text explaining this step to the user

- #### Step 5

  Summary text explaining this step to the user

## Installation

    $ npm install progress-tracker --save-dev

## Usage

### Import

After installation you can import it into your Sass files with the statement below.

    @import "node_modules/progress-tracker/src/styles/progress-tracker.scss";

The JS that is part of this site is just for demonstration purposes, add your own JS as needed to toggle the classes for the step states.

### Markup

Follow the HTML code example below for basic usage; each demo sets the first two steps as complete, the third step as active and the last two steps as inactive.

For additional styles add modifier classes and additional markup as needed in the examples below. You can add multiple modifier classes to achieve additional styles that those shown below.

    <ul class="progress-tracker">
      <li class="progress-step is-complete">
        <div class="progress-marker"></div>
      </li>
      <li class="progress-step is-complete">
        <div class="progress-marker"></div>
      </li>
      <li class="progress-step is-active">
        <div class="progress-marker"></div>
      </li>
      <li class="progress-step">
        <div class="progress-marker"></div>
      </li>
      <li class="progress-step">
        <div class="progress-marker"></div>
      </li>
    </ul>

### Demo site

Clone or download from Github.

    $ npm install
    $ gulp serve