remove all mentions of data-shepherd-active-tour (#2022)

* remove all mentions of data-shepherd-active-tour * Update docs-src/tutorials/02-usage.md * Update src/js/tour.js * Update src/types/tour.d.ts Co-authored-by: Robert Wagner <[email protected]>
shipshapecode · Aug 18, 2022 · de84951 · de84951
1 parent df085f7
commit de84951
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 5 deletions.
diff --git a/docs-src/tutorials/02-usage.md b/docs-src/tutorials/02-usage.md
@@ -123,7 +123,7 @@ const myTour = new Shepherd.Tour(options);
 - `modalContainer` An optional container element for the modal. If not set, the modal will be appended to `document.body`.
 - `steps`: An array of step options objects or Step instances to initialize the tour with.
 - `tourName`: An optional "name" for the tour. This will be appended to the the tour's
-dynamically generated `id` property -- which is also set on the `body` element as the `data-shepherd-active-tour` attribute whenever the tour becomes active.
+dynamically generated `id` property.
 - `useModalOverlay`: Whether or not steps should be placed above a darkened modal overlay. If true, the overlay will create an opening around the target element so that it can remain interactive.
 
 ##### Tour Methods

diff --git a/src/js/tour.js b/src/js/tour.js
@@ -34,8 +34,7 @@ export class Tour extends Evented {
    * If not set, the modal will be appended to `document.body`.
    * @param {object[] | Step[]} options.steps An array of step options objects or Step instances to initialize the tour with
    * @param {string} options.tourName An optional "name" for the tour. This will be appended to the the tour's
-   * dynamically generated `id` property -- which is also set on the `body` element as the `data-shepherd-active-tour` attribute
-   * whenever the tour becomes active.
+   * dynamically generated `id` property.
    * @param {boolean} options.useModalOverlay Whether or not steps should be placed above a darkened
    * modal overlay. If true, the overlay will create an opening around the target element so that it
    * can remain interactive

diff --git a/src/types/tour.d.ts b/src/types/tour.d.ts
@@ -146,8 +146,7 @@ declare namespace Tour {
 
     /**
      * An optional "name" for the tour. This will be appended to the the tour's
-     * dynamically generated `id` property -- which is also set on the `body` element as the `data-shepherd-active-tour` attribute
-     * whenever the tour becomes active.
+     * dynamically generated `id` property.
      */
     tourName?: string;