Add docs
Browse files- index.html +12 -5
index.html
CHANGED
@@ -15,7 +15,8 @@
|
|
15 |
<div class="page-wrap">
|
16 |
<section class="section__header" id="driver-demo-head">
|
17 |
<h1><span id="logo_emoji" class="emoji">👨🔧️</span> <span id="name_driver">Driver</span></h1>
|
18 |
-
<p class="text-muted tagline">Light-weight, no-dependency, vanilla JavaScript engine to drive user's focus across
|
|
|
19 |
page</p>
|
20 |
|
21 |
<a id="animated-tour" href="javascript:void(0)" class="btn btn__example btn__dark">With Animation</a>
|
@@ -250,6 +251,11 @@ driver.highlight({
|
|
250 |
opacity: 0.75, // Background opacity (0 means only popovers and without overlay)
|
251 |
padding: 10, // Distance of element from around the edges
|
252 |
allowClose: true, // Whether clicking on overlay should close or not
|
|
|
|
|
|
|
|
|
|
|
253 |
scrollIntoViewOptions: {}, // We use `scrollIntoView()` when possible, pass here the options for it if you want any
|
254 |
onHighlightStarted: (Element) {}, // Called when element is about to be highlighted
|
255 |
onHighlighted: (Element) {}, // Called when element is fully highlighted
|
@@ -257,6 +263,8 @@ driver.highlight({
|
|
257 |
});
|
258 |
</code></pre>
|
259 |
</div>
|
|
|
|
|
260 |
<div class="section__example">
|
261 |
<h4>Step Definition</h4>
|
262 |
<p>Here are the set of options that you can pass in each step i.e. an item in array of steps or the object that
|
@@ -267,10 +275,9 @@ driver.highlight({
|
|
267 |
title: 'Title', // Title on the popover
|
268 |
description: 'Description', // Body of the popover
|
269 |
showButtons: false, // Do not show control buttons in footer
|
270 |
-
|
271 |
-
|
272 |
-
|
273 |
-
prevBtnText: 'Previous', // Previous button text
|
274 |
}
|
275 |
};
|
276 |
</code></pre>
|
|
|
15 |
<div class="page-wrap">
|
16 |
<section class="section__header" id="driver-demo-head">
|
17 |
<h1><span id="logo_emoji" class="emoji">👨🔧️</span> <span id="name_driver">Driver</span></h1>
|
18 |
+
<p class="text-muted tagline">Light-weight, no-dependency, vanilla JavaScript engine to drive user's focus across
|
19 |
+
the
|
20 |
page</p>
|
21 |
|
22 |
<a id="animated-tour" href="javascript:void(0)" class="btn btn__example btn__dark">With Animation</a>
|
|
|
251 |
opacity: 0.75, // Background opacity (0 means only popovers and without overlay)
|
252 |
padding: 10, // Distance of element from around the edges
|
253 |
allowClose: true, // Whether clicking on overlay should close or not
|
254 |
+
doneBtnText: 'Done', // Text on the final button
|
255 |
+
closeBtnText: 'Close', // Text on the close button for this step
|
256 |
+
nextBtnText: 'Next', // Next button text for this step
|
257 |
+
prevBtnText: 'Previous', // Previous button text for this step
|
258 |
+
showButtons: false, // Do not show control buttons in footer
|
259 |
scrollIntoViewOptions: {}, // We use `scrollIntoView()` when possible, pass here the options for it if you want any
|
260 |
onHighlightStarted: (Element) {}, // Called when element is about to be highlighted
|
261 |
onHighlighted: (Element) {}, // Called when element is fully highlighted
|
|
|
263 |
});
|
264 |
</code></pre>
|
265 |
</div>
|
266 |
+
<p class="top-20">Note that all the button options that you provide in the driver definition can be overridden for a
|
267 |
+
specific step by giving them int he step definition</p>
|
268 |
<div class="section__example">
|
269 |
<h4>Step Definition</h4>
|
270 |
<p>Here are the set of options that you can pass in each step i.e. an item in array of steps or the object that
|
|
|
275 |
title: 'Title', // Title on the popover
|
276 |
description: 'Description', // Body of the popover
|
277 |
showButtons: false, // Do not show control buttons in footer
|
278 |
+
closeBtnText: 'Close', // Text on the close button for this step
|
279 |
+
nextBtnText: 'Next', // Next button text for this step
|
280 |
+
prevBtnText: 'Previous', // Previous button text for this step
|
|
|
281 |
}
|
282 |
};
|
283 |
</code></pre>
|