steps
steps
is an array of Step
Step
{
attachTo: {
element: "#foo"
classList: ["attached", "bar"]
},
content: {
title: "..."
description: "..."
html: false
},
on: {
beforeStep: function (options) { ... },
afterStep: function (options) { ... }
},
options: {}
}
Name | Type | Default | Description |
---|---|---|---|
attachTo |
Object |
||
attachTo.element |
String Function |
Required | Element to attach onboarding step |
attachTo.classList |
String[] |
Optional | CSS classes to be added to attached element |
content |
Object |
Optional | |
content.title |
String |
Optional | Title to use in onboarding step |
content.description |
String |
Optional | Description to use in onboarding step |
content.html |
Boolean |
Optional | If its set to true , the content.description will be rendered in the default template using v-html |
on |
Object |
Optional | |
on.beforeStep |
Function AsyncFunction |
Optional | Function to run before showing the step (More information) |
on.afterStep |
Function AsyncFunction |
Optional | Function to run after showing the step (More information) |
options |
Options | Optional | Option for step. Overrides the VOnboardingWrapper options |