Skip to content

Step by Step Tutorial application

Notifications You must be signed in to change notification settings

cnfilms/explain-js

 
 

Repository files navigation

ng-explain-js

This library is an Angular onboarding component that allows you to highlight and introduce certain parts of a page when visiting it.
Its use is not complicated. All you have to do is fill in an object array containing a title, a description and a selector.

Installation

$ cd your-angular-project
$ npm install ng-explain-js

Create your steps Array of Object

const steps = [
    {
        title: 'My step title',
        desc: 'My step description',
        selector: '.my_step_selector',
    },
]

Use the component

<app-explainjs [steps]="steps" (closeTutorial)="closeTutorialModal($event)"></app-explainjs>

Input | Output

INPUT OUTPUT TYPE USE
steps - steps: {title: string; desc: string; selector: string} Array of objects used to list steps
- closeTutorial closeTutorial: EventEmitter<boolean> Boolean use to handle modal closure

About

Step by Step Tutorial application

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 63.1%
  • CSS 22.6%
  • JavaScript 14.3%