rails_onboarding 0.8.8 → 0.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 408fd1e294065de10f66f097028bca6ea0ef929c2da585fb5fe20034a14e0202
-  data.tar.gz: 2e015226988b1bda4bf5594d43c00341f4a9fb2c21c020b0607446be87dfe671
+  metadata.gz: c05ac141e36d0ce4babc403026980c036569d9ae47a6dfe7fd945b9023bdce8b
+  data.tar.gz: a4a1482feee59b542485b5368e9cadbbe99dc16d3bcb9da6da399b7ca22c02c6
 SHA512:
-  metadata.gz: 6f924adbe61c18fc3b8070653655b04d74bd01a97562ed5eaa274d43276c07a331a11ef233ceab5484f545b20779485cbe55417921516bc9c2cd0557da694884
-  data.tar.gz: 678c83c71d204f027f92d65555af8cff1b3aecd53992cda79e5d234f5deffaf3a465e4b786295bc5ca2319b97a74946750e3a98083a45b8f1ad5ea4a37f3d4c1
+  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
         }))
     }
@@ -190,6 +197,7 @@ export default class extends Controller {
         const targetElement = step.selector ? document.querySelector(step.selector) : null
 
         this.currentTargetElement = targetElement
+        this.applyScrim(step, targetElement)
 
         if (targetElement) {
             this.scrollToElement(targetElement, step)
@@ -258,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;
@@ -272,7 +292,7 @@ export default class extends Controller {
             left: 0;
             width: 100%;
             height: 100%;
-            background: rgba(0, 0, 0, ${this.overlayOpacityValue});
+            background: transparent;
             z-index: 9998;
             opacity: 0;
             transition: opacity 0.3s ease;
@@ -300,6 +320,7 @@ export default class extends Controller {
         const overlay = this.overlay
         if (!overlay) return
 
+        document.documentElement.style.removeProperty('--onboarding-tour-scrim')
         this.overlay = null
         overlay.style.opacity = '0'
 
@@ -320,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 = `
@@ -339,7 +360,6 @@ export default class extends Controller {
                     left: ${rect.left - padding}px;
                     width: ${rect.width + (padding * 2)}px;
                     height: ${rect.height + (padding * 2)}px;
-                    box-shadow: 0 0 0 9999px rgba(0, 0, 0, ${this.overlayOpacityValue});
                     border-radius: 8px;
                 `
                 break
@@ -380,8 +400,40 @@ 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'
+        }
+    }
+
+    /**
+     * Decide which layer paints the scrim for this step, and at what strength.
+     *
+     * A 'spotlight' highlight is already a full-viewport scrim - its box-shadow has a
+     * 9999px spread and covers everything but the cutout - so painting the overlay on
+     * top of it darkens every pixel twice. At the default 0.7 that composites to ~0.92,
+     * which buries the surrounding page and leaves someone unfamiliar with the layout
+     * with no idea what the highlight is being singled out *from*. Every other style
+     * (border, glow, none) draws no scrim of its own, and nor does a step with no target
+     * element, so those still need the overlay.
+     */
+    applyScrim(step, targetElement) {
+        document.documentElement.style.setProperty(
+            '--onboarding-tour-scrim', this.overlayOpacityValue
+        )
+
+        if (!this.overlay) return
+
+        const spotlit = Boolean(targetElement) && step.highlightStyle === 'spotlight'
+        this.overlay.style.background = spotlit
+            ? 'transparent'
+            : `rgba(0, 0, 0, ${this.overlayOpacityValue})`
     }
 
     /**
@@ -401,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
         }
     }
@@ -411,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/app/assets/stylesheets/rails_onboarding/tour.css

@@ -22,19 +22,15 @@
   border-radius: 8px;
 }
 
-/* Spotlight style - Creates cutout effect */
+/* Spotlight style - Creates cutout effect.
+   The 9999px spread makes this box-shadow a full-viewport scrim in its own right, so
+   tour_controller stops painting .tour-overlay whenever a spotlight is drawn - the two
+   together composited to ~0.92 and buried the surrounding page.
+   The alpha comes from --onboarding-tour-scrim, which the controller sets on :root from
+   its overlayOpacity value. It is deliberately not animated: an animation on this
+   property overrides the inline style, which is what made overlayOpacity a dead knob. */
 .tour-spotlight-spotlight {
-  box-shadow: 0 0 0 9999px rgba(0, 0, 0, 0.7);
-  animation: onboarding-spotlightPulse 2s ease-in-out infinite;
-}
-
-@keyframes onboarding-spotlightPulse {
-  0%, 100% {
-    box-shadow: 0 0 0 9999px rgba(0, 0, 0, 0.7);
-  }
-  50% {
-    box-shadow: 0 0 0 9999px rgba(0, 0, 0, 0.75);
-  }
+  box-shadow: 0 0 0 9999px rgba(0, 0, 0, var(--onboarding-tour-scrim, 0.7));
 }
 
 /* Border highlight style */
@@ -327,6 +323,10 @@
     background: rgba(0, 0, 0, 0.85);
   }
 
+  .tour-spotlight-spotlight {
+    --onboarding-tour-scrim: 0.85;
+  }
+
   .tour-spotlight-border {
     border-width: 4px;
   }
@@ -351,10 +351,6 @@
     animation: none;
   }
 
-  .tour-spotlight-spotlight {
-    animation: none;
-  }
-
   .tour-spotlight-border {
     animation: none;
   }

data/lib/rails_onboarding/version.rb

@@ -1,3 +1,3 @@
 module RailsOnboarding
-  VERSION = "0.8.8"
+  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.8
+  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.8
+  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: