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

#### Its written in SASS using flexbox to be flexible and responsive. It can be easily customized, includes many possible layouts and works in all major browsers from IE10 up.

## Installation

Download Download CSS View on GitHub

### npm

    $ npm install progress-tracker --save

### bower

    $ bower install progress-tracker --save

## Usage

Once you have downloaded the code, run the commands below to view the demo site.

    $ npm install
    $ gulp serve

You can also import progress-tracker.scss into your own project directly and modify as needed. You can also optionally import progress-tracker-animations.scss to add animations and progress-tracker-theme.scss for quicker theming.

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.

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">
        <span class="progress-marker"></span>
      </li>
      <li class="progress-step is-complete">
        <span class="progress-marker"></span>
      </li>
      <li class="progress-step is-active">
        <span class="progress-marker"></span>
      </li>
      <li class="progress-step">
        <span class="progress-marker"></span>
      </li>
      <li class="progress-step">
        <span class="progress-marker"></span>
      </li>
    </ul>

## Examples

### Basic usage

### Center aligned markers

### Right aligned markers

### Numbers or letters in the markers

- 1
- 2
- 3
- A
- B

### Border

### Spaced markers

## Small amount of text on markers

### Left aligned text

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

### Centered aligned text

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

### Right aligned text

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

## Longer text on markers

### Left aligned text

- #### 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 text

- #### 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 text

- #### 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

### 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 beside 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 <400px

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

## Animations - Click on a step to see the effect

### Ripple effect

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

### Large ripple effect

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

### Double ripple effect

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

### Fill path when step is complete - Click on a step to see the effect

- #### Step 1

- #### Step 2

- #### Step 3

- #### Step 4

- #### Step 5

### 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