Tutorial system
- Source:
Methods
(static) add(plugidId, name, description, icon, steps, prerequisites)
Add tutorial to options
Parameters:
| Name | Type | Description |
|---|---|---|
plugidId |
||
name |
||
description |
||
icon |
||
steps |
the tutorials object array, keys are "rule selector" strings rules are 'next', 'click', selectors define what element to highlight | |
prerequisites |
a function to execute at the beginning, default undefined |
- Source:
(static) hide()
Hide Tutorials
- Source:
(static) run(ctx)
Run tutorial
Parameters:
| Name | Type | Description |
|---|---|---|
ctx |
number | Array | index to the attached tutorials list (internal use) or tutorials data see add(..) steps parameter |
- Source:
(static) show(title, description)
Open the tutorials selection screen
Parameters:
| Name | Type | Description |
|---|---|---|
title |
string | title to show |
description |
string | subtitle to show |
- Source: