File size: 16,996 Bytes
6b9b285 61b111d 6b9b285 2dda34a 6b9b285 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
---
import { ExampleButton } from "./ExampleButton";
---
<h2 class="text-4xl md:text-5xl lg:text-6xl font-bold mb-3 md:mb-4 lg:mb-6" data-examples-heading>Examples</h2>
<p class="text-base md:text-xl lg:text-2xl text-black leading-6" data-examples-tagline>Here are just a few examples; find more <a
class="text-black underline underline-offset-4" href="/docs/installation">in the documentation</a>.</p>
<div class="flex flex-wrap gap-2 md:gap-2 lg:gap-3 my-6 md:my-8 lg:my-12" data-example-btns>
<ExampleButton id="animated-tour" text="Animated Tour" />
<ExampleButton id="static-tour" text="Non-Animated Tour" />
<ExampleButton id="async-tour" text="Async Tour" />
<ExampleButton id="no-element" text="No Element" />
<ExampleButton id="confirm-on-exit" text="Confirm on Exit" />
<ExampleButton id="show-progress" text="Show Progress" />
<ExampleButton id="simple-element-highlight" text="Simple Highlight" />
<ExampleButton id="simple-element-highlight-popover" text="Highlight with Popover" />
<ExampleButton id="prevent-close" text="Prevent Closing" />
<ExampleButton id="overlay-color" text="Overlay Color" />
<ExampleButton id="popover-position" text="Popover Positioning" />
<ExampleButton id="customizing-popover" text="Customizing Popover" />
<ExampleButton id="hooks-everything" text="Hooks for Everything" />
<a href="/docs/installation"
class="items-center flex text-base md:text-base lg:text-lg text-gray-900 bg-yellow-300 rounded-lg lg:rounded-xl px-5 py-2 hover:bg-yellow-500 hover:text-black">
and much more ...
</a>
</div>
<script>
import { driver } from "driver.js";
import "driver.js/dist/driver.css";
import { mountDummyElement, removeDummyElement } from "../components/CodeSample";
function markDone(btn) {
btn.classList.add("bg-gray-300", "hover:bg-gray-200", "line-through");
btn.classList.remove("bg-transparent");
}
const demoTourButton = document.querySelector("[data-demo-tour]");
demoTourButton.addEventListener("click", () => {
const driverObj = driver({
popoverClass: "driverjs-theme",
showButtons: ["next", "previous"],
steps: [
{
element: "[data-hero-text]",
popover: {
title: "Before we start",
description: "This is just one use-case, make sure to look at the docs for more use-cases and examples.",
nextBtnText: "Okay, start!",
side: "bottom",
align: "start"
}
},
{
element: "[data-driver-tagline]",
popover: {
title: "Focus Anything",
description: "You can use it to highlight literally anything, images, text, svg, div, span, li etc.",
side: "bottom",
align: "start"
}
},
{
element: "[data-driver-name]",
popover: {
title: "Why Driver.js",
description: "It's lightweight, has no dependencies, is MIT licensed, is highly customizable, and is super easy to use.",
side: "bottom",
align: "start"
}
},
{
element: "[data-docs-link]",
popover: {
title: "More Powerful than Ever",
description: "Driver.js has been completely rewritten from scratch and is now more powerful than ever.",
side: "bottom",
align: "start"
}
},
{
element: "[data-example-btns]",
popover: {
title: "Examples",
description: "Here are some examples to give you a rough idea.",
side: "bottom",
align: "start"
}
},
{
element: "[data-example-btns] a:last-child",
popover: {
title: "Visit Docs",
description: "Make sure to visit the docs for more examples and use-cases.",
side: "top",
align: "start"
}
},
{
element: "[data-github-link]",
popover: {
title: "MIT Licensed",
description: "Driver.js is MIT licensed and is used by thousands of companies around the world.",
side: "top",
align: "start"
}
},
{
popover: {
description: "<img style='width: 270px; height: 206.65px; margin-bottom: 10px; border-radius: 5px;' src='https://i.imgur.com/3WpTnyA.gif' />That's it for now, make sure to <a class='underline font-medium' href='/docs/installation'>visit the docs</a> for more examples and use-cases.",
side: "bottom",
align: "start",
showButtons: [],
popoverClass: "default-theme"
}
}
]
});
driverObj.drive();
});
const animatedTourBtn = document.getElementById('animated-tour');
animatedTourBtn.addEventListener("click", () => {
const driverObj = driver({
popoverClass: "driverjs-theme",
showButtons: ["next", "previous"],
steps: [
{
element: "[data-examples-heading]",
popover: {
title: "Animated Tour",
description: "Animated tour can simply be achieved by setting `animate` option true.",
side: "bottom",
align: "start"
}
},
{
element: "[data-examples-tagline]",
popover: {
title: "Just an Example",
description: "We don't have many steps in this example, but you can have as many as you want.",
side: "bottom",
align: "start"
}
},
{
element: "[data-examples-tagline] a",
popover: {
title: "That's it for now",
description: "Make sure to visit the docs for more examples and use-cases.",
side: "bottom",
align: "start"
}
},
],
onDestroyed: () => {
markDone(animatedTourBtn);
}
});
driverObj.drive();
});
const staticTourBtn = document.getElementById('static-tour');
staticTourBtn.addEventListener("click", () => {
const driverObj = driver({
animate: false,
popoverClass: "driverjs-theme",
showButtons: ["next", "previous"],
steps: [
{
element: "[data-examples-heading]",
popover: {
title: "Static Tour",
description: "This is a static tour, which means that it won't be animated.",
side: "bottom",
align: "start"
}
},
{
element: "[data-examples-tagline]",
popover: {
title: "Just an Example",
description: "We don't have many steps in this example, but you can have as many as you want.",
side: "bottom",
align: "start"
}
},
{
element: "[data-examples-tagline] a",
popover: {
title: "That's it for now",
description: "Make sure to visit the docs for more examples and use-cases.",
side: "bottom",
align: "start"
}
},
],
onDestroyed: () => {
markDone(staticTourBtn);
}
});
driverObj.drive();
});
const asyncTourBtn = document.getElementById('async-tour');
asyncTourBtn.addEventListener("click", () => {
const driverObj = driver({
animate: true,
popoverClass: "driverjs-theme",
showButtons: ["next", "previous"],
steps: [
{
popover: {
title: "Async Tour",
description: "You can also use Driver.js to create async tours. Element for the next step doesn't exist -- we will create before moving next.",
side: "bottom",
align: "start",
onNextClick: () => {
mountDummyElement();
driverObj.moveNext();
}
}
},
{
element: '.dynamic-el',
popover: {
title: "New Element",
description: "This element was created after the first step and will be destroyed after this step.",
side: "bottom",
align: "start",
onPrevClick: () => {
removeDummyElement();
driverObj.movePrevious();
},
onNextClick: () => {
removeDummyElement();
driverObj.moveNext();
}
}
},
{
popover: {
title: "More in Docs",
description: "There is a detailed guide on <a href='/docs/async-tour/' target='_blank' class='underline font-bold'>how to create async</a> tours in the documentation.",
side: "bottom",
align: "start",
onPrevClick: () => {
mountDummyElement();
driverObj.movePrevious();
}
}
},
],
onDestroyed: () => {
markDone(asyncTourBtn);
}
});
driverObj.drive();
});
const exitConfirm = document.getElementById('confirm-on-exit');
exitConfirm.addEventListener("click", () => {
const driverObj = driver({
animate: true,
popoverClass: "driverjs-theme",
showButtons: ["next", "previous"],
steps: [
{
element: "[data-examples-heading]",
popover: {
title: "Confirm on Exit",
description: "You can also ask for confirmation before exiting the tour.",
side: "bottom",
align: "start"
}
},
{
element: "[data-examples-tagline]",
popover: {
title: "Just an Example",
description: "We don't have many steps in this example, but you can have as many as you want.",
side: "bottom",
align: "start"
}
},
{
element: "[data-examples-tagline] a",
popover: {
title: "That's it for now",
description: "Make sure to visit the docs for more examples and use-cases.",
side: "bottom",
align: "start"
}
},
],
onDestroyStarted: () => {
if (!driverObj.hasNextStep() || confirm("Are you sure?")) {
driverObj.destroy();
}
},
onDestroyed: () => {
markDone(exitConfirm);
}
});
driverObj.drive();
});
const showProgressBtn = document.getElementById('show-progress');
showProgressBtn.addEventListener('click', () => {
const driverObj = driver({
animate: true,
showProgress: true,
showButtons: ["next", "previous"],
steps: [
{
element: "[data-examples-heading]",
popover: {
title: "Show Progress",
description: "You can set `showProgress` to `true` and progress will be shown in the footer.",
side: "bottom",
align: "start"
}
},
{
element: "[data-examples-tagline]",
popover: {
title: "Just an Example",
description: "We don't have many steps in this example, but you can have as many as you want.",
side: "bottom",
align: "start"
}
},
{
element: "[data-examples-tagline] a",
popover: {
title: "That's it for now",
description: "Make sure to visit the docs for more examples and use-cases.",
side: "bottom",
align: "start"
}
},
],
onDestroyed: () => {
markDone(showProgressBtn);
}
});
driverObj.drive();
});
const simpleHighlightBtn = document.getElementById('simple-element-highlight');
simpleHighlightBtn.addEventListener('click', () => {
const driverObj = driver({
popoverClass: 'driverjs-theme',
onDestroyed: () => {
markDone(simpleHighlightBtn);
}
});
driverObj.highlight({
element: '[data-example-btns]'
})
});
const simpleHighlightPopoverBtn = document.getElementById('simple-element-highlight-popover');
simpleHighlightPopoverBtn.addEventListener('click', () => {
const driverObj = driver({
popoverClass: 'driverjs-theme',
onDestroyed: () => {
markDone(simpleHighlightPopoverBtn);
}
});
driverObj.highlight({
element: '[data-example-btns]',
popover: {
title: "Popover Highlight",
description: "You can also highlight an element with a popover.",
side: 'top'
}
});
});
const noElementbtn = document.getElementById('no-element');
noElementbtn.addEventListener('click', () => {
const driverObj = driver({
popoverClass: 'driverjs-theme',
onDestroyed: () => {
markDone(noElementbtn);
}
});
driverObj.highlight({
popover: {
title: "Without Element",
description: "You can also show a popover without highlighting an element. For example, this popover is shown without highlighting anything.",
}
});
});
const preventCloseBtn = document.getElementById('prevent-close');
preventCloseBtn.addEventListener('click', () => {
const driverObj = driver({
animate: true,
allowClose: false,
showProgress: true,
showButtons: ["next", "previous"],
steps: [
{
element: "[data-examples-heading]",
popover: {
title: "Show Progress",
description: "You can set `showProgress` to `true` and progress will be shown in the footer.",
side: "bottom",
align: "start"
}
},
{
element: "[data-examples-tagline]",
popover: {
title: "Just an Example",
description: "We don't have many steps in this example, but you can have as many as you want.",
side: "bottom",
align: "start"
}
},
{
element: "[data-examples-tagline] a",
popover: {
title: "That's it for now",
description: "Make sure to visit the docs for more examples and use-cases.",
side: "bottom",
align: "start"
}
},
],
onDestroyed: () => {
markDone(preventCloseBtn);
}
});
driverObj.drive();
});
const overlayColorBtn = document.getElementById('overlay-color');
overlayColorBtn.addEventListener('click', () => {
const driverObj = driver({
overlayColor: 'red',
overlayOpacity: 0.5,
onDestroyed: () => {
markDone(overlayColorBtn);
}
});
driverObj.highlight({
element: '[data-example-btns]',
popover: {
title: "Popover Highlight",
description: "You can also highlight an element with a popover.",
side: 'top'
}
});
});
const popoverPositionBtn = document.getElementById('popover-position');
popoverPositionBtn.addEventListener('click', () => {
const driverObj = driver({
onDestroyed: () => {
markDone(popoverPositionBtn);
}
});
driverObj.highlight({
element: '#popover-position',
popover: {
title: "Popover Position",
description: "You can also change the position of the popover using `side` and `align` options.<br /> Allowed sides are `top`, `bottom`, `left` and `right`. Allowed aligns are `start`, `center` and `end`.",
side: 'top',
align: 'start'
}
});
});
const customizingBtn = document.getElementById('customizing-popover');
customizingBtn.addEventListener('click', () => {
const driverObj = driver({
popoverClass: 'driverjs-theme',
onDestroyed: () => {
markDone(customizingBtn);
}
});
driverObj.highlight({
element: '#customizing-popover',
popover: {
title: "Customizing Popover",
description: "Add your own class using `popoverClass` or use `onPopoverRender` to get full control over the popover. <br /><br /> Visit these pages which cover <a class='font-medium underline' href='/docs/styling-popover'>styling</a> and <a class='font-medium underline' href='/docs/buttons'>customizing popovers</a> in detail.",
side: 'top',
align: 'start'
}
});
});
const hooksEverythingBtn = document.getElementById('hooks-everything');
hooksEverythingBtn.addEventListener('click', () => {
const driverObj = driver({
popoverClass: 'driverjs-theme',
onDestroyed: () => {
markDone(hooksEverythingBtn);
}
});
driverObj.highlight({
element: '#hooks-everything',
popover: {
title: "Hooks for Everything",
description: "Have a look at the <a class='font-medium underline' href='/docs/configuration'>configuration</a> page to see how you can use hooks to control the driver.",
side: 'top',
align: 'start'
}
});
});
</script> |