CORE
NATIVE
TABLE
MAKE
CUSTOMIZE
EFFECTS
effects_base.js
effects_morph.js
effects_fade.js
effects_move.js
effects_extra.js
effects_toggle.js
effects_cycle.js
effects_cycles.js
VIRTUAL BOX
PLUG-IN
tutorial.js
Contains the Tutorial Class which allows to create professional tutorials and step by step presentations.
Contains
Class Tutorial
Summary
| Tutorial | Class for creating tutorials and step by step presentations |
Class for creating tutorials and step by step presentations.
Extends
Fx.Elements
Constructor
new Tutorial (element, options)
Properties
| element | the main wrapper that contains the single steps | |
| options | the options. See below |
Options
| arrowsKeyboard | if true you can change the step by using the keyboard's arrows. Default is true. | |
| names | an object which contains the class names of the Tutorial section. You can pass as keywords: step, next and prev. | |
| cycle | if true you can change the steps as a cycle (from last to first for example). Default is false. | |
| autostart | if true the presentation will be automated. | |
| steps | if the autostart option is true this option indicates the time delay of each step call. Default is 4000 ms. |
names:
-
step: the class name of the nested elements which represent the single steps -
prev: the class name of the link which changes to the previous step -
next: the class name of the link which changes to the next step
Methods
| prev | goes to the previous step | |
| next | goes to the next step | |
| autostart | autostarts the presentation. If the cycle option is true the presentation doesn't stop until an user stop it | |
| stop | stops the presentation |
Example
var tutorial = new Tutorial('main', {cycle: true});
top method prev
goes to the previous step
Example
turorial.prev();
top method next
goes to the next step
Example
turorial.next();
top method autostart
autostarts the presentation. If the cycle option is true the presentation doesn't stop until an user stop it
Example
turorial.autostart();
top method stop
stops the presentation
Example
turorial.stop();
Documentation By
Riccardo Degni -
powered by MakeDocs, CMS by RD
The moo.rd documentation is released under the
Creative Commons BY-NC SA License
