state-stepper

State-Stepper

A states indicator for Ionic.

NOTE

This project is experimental and currently in work for initial usage. It may not yet work correctly.

Description

This is a very jung project. Please view the roadmap, before creating an issue. Anyway I appreciate for any contribution.

This is a Ionic v3 component.

Install

npm i state-stepper

NPM Package

Example

<state-stepper #stepper [steps]="steps"></state-stepper>

<ion-button (click)="stepper.nextStep('success')">OK</ion-button>
<ion-button (click)="stepper.nextStep('warning')">Warn</ion-button>
<ion-button (click)="stepper.nextStep('danger')">Error</ion-button>
<ion-button (click)="stepper.reset()">Reset</ion-button>

steps = [
  {
    icon: 'list',
    text: 'Input'
  },
  {
    icon: 'cog',
    text: 'Parameter'
  },
  {
    icon: 'cube',
    text: 'Save'
  },
  {
    icon: 'cloud-upload',
    text: 'Upload'
  },
  {
    icon: 'checkmark',
    text: 'Done'
  }
];

Roadmap

Following is planned. Just ideas in unsorted order.

• Find better solution to use html and scss.
• Support Ionic 4 (not yet tested).
• Use Ionic color variables.
• Translate step.text by changing the layout. (e.g. accept steps as html ng-content.)
• Make this library neutral for every Angular project. (Not only Ionic).
• Step content. Every step in a tab container.
• Create demo website.
• Testing (Unit tests).

License

MIT License

Copyright (c) 2019 Dominik Geng

Github @domske