new Chariot(config, delegateopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
config |
ChariotConfiguration | The main configuration for all tutorials | |
delegate |
ChariotDelegate |
<optional> |
An optional delegate that responds to lifecycle callbacks |
- Source:
Methods
(static) createTutorial(config, delegateopt)
Static method for creating a Tutorial object without needing to instantiate
chariot with a large configuration and named tutorials.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
config |
TutorialConfiguration | The tutorial configuration | |
delegate |
ChariotDelegate |
<optional> |
An optional delegate that responds to lifecycle callbacks |
- Source:
(static) startTutorial(config, delegateopt)
Static method for creating and starting a Tutorial object without needing
to instantiate chariot with a large configuration and named tutorials.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
config |
TutorialConfiguration | The tutorial configuration | |
delegate |
ChariotDelegate |
<optional> |
An optional delegate that responds to lifecycle callbacks |
- Source:
currentTutorial() → {Tutorial}
Returns the current tutorial, if any.
- Source:
Returns:
tutorial - The current tutorial, or null if none active
- Type
- Tutorial
endTutorial() → {undefined}
Ends the current tutorial.
- Source:
Returns:
- Type
- undefined
setDelegate(delegateopt)
Sets the chariot delegate.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
delegate |
ChariotDelegate |
<optional> |
An object that responds to lifecycle callbacks |
- Source:
startTutorial(name) → {Tutorial}
Starts a tutorial with the given name.
Won't start a tutorial if one is currently running.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Name of the tutorial to start |
- Source:
Returns:
tutorial - The Tutorial object, or undefined if
another tutorial is currently active.
- Type
- Tutorial