rails_onboarding 0.8.9 → 0.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5de350daba589470bba3cfa3afe9daa037307873d47a888f81899b2e542172fa
-  data.tar.gz: 6871219f6639948ec9e66747c2e89be3b58d2260d6ef8bc2750a84900db14b1d
+  metadata.gz: c05ac141e36d0ce4babc403026980c036569d9ae47a6dfe7fd945b9023bdce8b
+  data.tar.gz: a4a1482feee59b542485b5368e9cadbbe99dc16d3bcb9da6da399b7ca22c02c6
 SHA512:
-  metadata.gz: 2b6e4ccc57e00c7d41e4b21604be312330888ac2cc96e6b8ef0bc39206c529416ddc35f5d4bdc998632a6488fca0ce2a1c53e900c50115a17b08c17c2f9193f3
-  data.tar.gz: a4714eaed7cca529878cc9cc99ed06e0e48fa117a1cfa7f327eed5e9de97abf98cf5c35cc4ef7b51e2c8449cca5e78bf64953f9d2a8b2114487b60a9a0dc27d5
+  metadata.gz: abcfa7de7380a5a5591fbcad733a093c0eb11dfacf89e82fb20d25d7570c67e2f4d26040a7c871d1990d9de5283bfe45b42584241676a55173078f29b5ff8393
+  data.tar.gz: 95ed36308b6f64e56bb4b2cac753efec1f6359dde989b8ccd516f57f2a0e9106c4621e2e4ca0e59ec72b9eb0f6dfdc092da1dcd3a5e3b803dbc45a6f40821809

data/app/assets/javascripts/rails_onboarding/tour_controller.js

@@ -28,6 +28,12 @@ export default class extends Controller {
         scrollBehavior: { type: String, default: "smooth" }, // smooth, auto, none
         scrollOffset: { type: Number, default: 80 }, // px offset from top when scrolling
         persistProgress: { type: Boolean, default: true },
+        // Whether the highlighted element stays clickable. It is lifted above the
+        // overlay so that a tour can say "click here to continue", and that is the
+        // default. An informational tour wants the opposite: a link inside the
+        // spotlight is a trap, because following it navigates away and the tour is
+        // either lost or restarted from step one. Overridable per step.
+        allowInteraction: { type: Boolean, default: true },
         tourId: String
     }
 
@@ -80,6 +86,7 @@ export default class extends Controller {
             beforeHide: step.beforeHide,
             onComplete: step.onComplete,
             width: step.width || 400, // Popup width in px
+            allowInteraction: step.allowInteraction ?? this.allowInteractionValue,
             ...step
         }))
     }
@@ -259,13 +266,25 @@ export default class extends Controller {
         }
     }
 
+    /**
+     * Elements the controller injects into document.body. Turbo caches the whole body
+     * when you navigate away, so without this a Back lands you on a snapshot with a
+     * frozen overlay and popup baked in - which then sit underneath the live tour the
+     * launcher starts, as duplicated and inert DOM. The attribute is ignored by hosts
+     * that do not use Turbo.
+     */
+    excludeFromSnapshot(element) {
+        element.setAttribute('data-turbo-cache', 'false')
+        return element
+    }
+
     /**
      * Create modal overlay
      */
     createOverlay() {
         if (this.overlay) return
 
-        this.overlay = document.createElement('div')
+        this.overlay = this.excludeFromSnapshot(document.createElement('div'))
         this.overlay.className = 'tour-overlay'
         this.overlay.style.cssText = `
             position: fixed;
@@ -322,7 +341,7 @@ export default class extends Controller {
 
         if (style === 'none') return
 
-        this.spotlight = document.createElement('div')
+        this.spotlight = this.excludeFromSnapshot(document.createElement('div'))
         this.spotlight.className = `tour-spotlight tour-spotlight-${style}`
 
         const baseStyles = `
@@ -381,8 +400,16 @@ export default class extends Controller {
         this.highlightedElement = element
         this.previousElementPosition = element.style.position
         this.previousElementZIndex = element.style.zIndex
+        this.previousElementPointerEvents = element.style.pointerEvents
         element.style.position = 'relative'
         element.style.zIndex = '10000'
+
+        // With interaction off, clicks fall through the highlighted element to the
+        // overlay beneath, which swallows them like the rest of the page. The element
+        // is still lifted above the overlay so it stays fully lit.
+        if (step.allowInteraction === false) {
+            element.style.pointerEvents = 'none'
+        }
     }
 
     /**
@@ -426,6 +453,7 @@ export default class extends Controller {
         if (this.highlightedElement) {
             this.highlightedElement.style.position = this.previousElementPosition || ''
             this.highlightedElement.style.zIndex = this.previousElementZIndex || ''
+            this.highlightedElement.style.pointerEvents = this.previousElementPointerEvents || ''
             this.highlightedElement = null
         }
     }
@@ -436,7 +464,7 @@ export default class extends Controller {
     createPopup(step, targetElement) {
         this.removePopup()
 
-        this.popup = document.createElement('div')
+        this.popup = this.excludeFromSnapshot(document.createElement('div'))
         this.popup.className = 'tour-popup'
 
         // Build popup HTML

data/lib/rails_onboarding/version.rb

@@ -1,3 +1,3 @@
 module RailsOnboarding
-  VERSION = "0.8.9"
+  VERSION = "0.8.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_onboarding
 version: !ruby/object:Gem::Version
-  version: 0.8.9
+  version: 0.8.10
 platform: ruby
 authors:
 - David Lewis
@@ -282,7 +282,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/bunnahabhain/rails_onboarding
-  source_code_uri: https://github.com/bunnahabhain/rails_onboarding/tree/v0.8.9
+  source_code_uri: https://github.com/bunnahabhain/rails_onboarding/tree/v0.8.10
   changelog_uri: https://github.com/bunnahabhain/rails_onboarding/blob/master/docs/CHANGELOG.md
 rdoc_options: []
 require_paths: