demo of tutorial.js

Tutorial.js

Helps you to create user-friendly web apps

Create and manage easily tutorials to show how to use your web application

Installation

Download the latest version of tutorial.js in the repository (dist folder)

Import it on your project

Import the index.js within your javascript files

Implement your tutorial

Build your own tutorial and guide your users into a new experience.

Documentation

Constructor

constructor(Step[], Options)
Step
Attribute (? if can be null) Type Default value
element string | HTMLElement null
comment string null
option? StepOptions {}
StepOptions
Attribute (? if can be null) Type Default value
position? 'top' | 'left' | 'right' | 'bottom' bottom
fontsize? string 15px
fontweight? string normal
gap? number 10
Options
Attribute (? if can be null) Type Default value
backgroundColor? string #000000
textColor? string #FFFFFF
backgroundOpacity? number 0.5
textOpacity? number 1
nextButtonLabel? string Next
previousButtonLabel? string Previous

Methods

start()

Runs the tutorial

Demonstration

Start tutorial