0.0.2 • Published 6 years ago

angular-simple-step-guide v0.0.2

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

Angular 2+ Simple Step Guide Component

This is craeted by ng-packagr on Angular6.

Installation

npm install angular-simple-step-guide --save

Usage

In Module:

App Module

import {SimpleStepGuideModule} from "angular-simple-step-guide";

@NgModule({
	imports: [SimpleStepGuideModule]
})

or

Shared Module

import {SimpleStepGuideModule} from "angular-simple-step-guide";

@NgModule({
	imports: [SimpleStepGuideModule],
	exports: [SimpleStepGuideModule]

})

In Component:

Template

<simple-step-guide [guides]="guides" [options]="options"></simple-step-guide>

Component Class

guides = [
  {id: "elementId", message: "text message."},
  ...
];
options = {
  ...
};

"guides" Property values:

idTarget element id.
messageDisplay message.

"options" Property values:

next"Next" button text.
skip"Skip" button text.
complete"Complete" button text.
interceptFunction is called before go to next step.
colorBase color. format is only "#xxxxxx".

Other Properties:

completedOutput bind, called on Completed.

Demo

npm run start

or

demo on sandbox