https://github.com/maiyaporn/angular2-wizard
Angular2 - Form Wizard Component
https://github.com/maiyaporn/angular2-wizard
angular2 angular2-component angular2-wizard bootstrap4 form-wizard wizard
Last synced: 10 months ago
JSON representation
Angular2 - Form Wizard Component
- Host: GitHub
- URL: https://github.com/maiyaporn/angular2-wizard
- Owner: maiyaporn
- Created: 2017-02-03T05:07:17.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-11-17T16:20:50.000Z (about 5 years ago)
- Last Synced: 2025-03-30T06:08:09.841Z (10 months ago)
- Topics: angular2, angular2-component, angular2-wizard, bootstrap4, form-wizard, wizard
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 117
- Watchers: 14
- Forks: 119
- Open Issues: 46
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# angular2-wizard
[](https://badge.fury.io/js/angular2-wizard)
[](https://travis-ci.org/maiyaporn/angular2-wizard)
[](https://codeclimate.com/github/maiyaporn/angular2-wizard)
[](https://codeclimate.com/github/maiyaporn/angular2-wizard/coverage)
This is an Angular2 Form Wizard component. Just like any form wizard. You can define steps and control how each step works. You can enable/disable navigation button based on validity of the current step. Currently, the component only support basic functionality. More features will come later.
You can checkout the demo below and see how to use it in the next section.
## Demo
https://maiyaporn.github.io/angular2-wizard-demo/
## Dependencies
- Angular2 (tested with 2.3.1)
- Bootstrap 4
## Installation
After installing the above dependencies, install angular2-wizard via:
```bash
$ npm install angular2-wizard --save
```
## How to use the component
Once you have installed the library, you can import it in `AppModule` of your application:
```typescript
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
// Import your library
import { FormWizardModule } from 'angular2-wizard';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
// Specify the library as an import
FormWizardModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
```
Once your library is imported, you can use form-wizard and wizard-step components in your Angular application:
```xml
Step1
Email address
We'll never share your email with anyone else.
Step2
Step3
Step4
Thank you! You have completed all the steps.
```
## Document
https://github.com/maiyaporn/angular2-wizard/wiki
## Development
To generate all `*.js`, `*.js.map` and `*.d.ts` files:
```bash
$ npm run tsc
```
To lint all `*.ts` files:
```bash
$ npm run lint
```
## Improvement
- [x] Click title to navigate
- [x] Hide/Show navigation button
- [ ] Disable visited steps after navigate to previous
- [ ] Dynamically add/remove step
## License
MIT © [Maiyaporn Phanich](mailto:p.maiyaporn@gmail.com)