stimulus-overlay-helpers 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deccbe57dab0e4e45e99893419fdb6495f518565b134c5ec30e1869e9cbb8ac1
-  data.tar.gz: c68a39bce68d49f5c9079c08b87bf989a8fae3763b16e0e599192fad442c9100
+  metadata.gz: 86ae555d09ee9af3eae8fec2e46e53de2d2b907679cb7d7721196d44fdb5835f
+  data.tar.gz: 5bb2badc10b8d1278e93cc6083d35f468a551703fb88e989e738057805083f4e
 SHA512:
-  metadata.gz: 4f23720354622b3233d1616d2fbcd67c6d3c57c32a23d800689b7d793dae6b75d25b7a86d45f64bc04e61dc976be649600e4a087617f996423aa9d419d9ec357
-  data.tar.gz: 86168a819f03aeee4aeec4e7383fc86ee02230d83838da86e325a96e5dd5f0257da2be9e6a5e400d2b3b376475313c480477b99bbc78451f88d98b0760d9620f
+  metadata.gz: 933332441daf7824da520ba1ec4acfcebd9d783aa2605d803a2b68847fa32911a2a879650c18f013609e908d7aeb51751b05b447adb69144aa70cca70a641607
+  data.tar.gz: 5b0136dd827abba33dba52ec1fb0ec8c3685f83abee61f9ee77968426561dd5a3e00e9ff1d785aa0f35b2854473cdacd7a922fbef3f888673e3e047c08f54051

data/README.md

@@ -27,23 +27,24 @@ If you work with the helpers on this gem, you can setup a initializer for a cust
 
 StimulusDropdown.configure do |config|
   config.close_button_proc = ->(view) do
-    view.content_tag(:span, 'X', class: 'close-button')
+    view.content_tag(:span, 'X', class: 'close-button', data: { close: true })
   end
 end
 ```
 
 **Z-index issues / `panel_at_place` option**
 
-If the overlay should appear above all other elements, it should be rendered closer to the root level, because `z-index` is always relative to sibling elements.
+If an overlay should appear above all other elements, it should be rendered close to the root level because `z-index` is always relative to the current stacking context.
+
+By default, unless `true` is passed to the helper’s `panel_at_place` argument, the overlay is rendered via `yield :overlays_box` in the layout:
 
-By default, when the `panel_at_place` argument is not passed to the helper, the overlay is rendered into the `:overlays_box` content block. Therefore, this block must be yielded in the layout:
 
 ```haml
 #overlays-box
   = yield :overlays_box
 ```
 
-This aligns to the behaviour of the [svelte overlays from @csedl/hotwire-svelte-helpers](https://www.npmjs.com/package/@csedl/hotwire-svelte-helpers)
+This matches the behavior of the [Svelte overlays from `@csedl/hotwire-svelte-helpers`](https://www.npmjs.com/package/@csedl/hotwire-svelte-helpers).
 
 ## Usage Examples
 

data/lib/stimulus_overlay_helpers/view_helpers.rb

@@ -26,7 +26,7 @@ module StimulusOverlayHelpers
 
       button_options = options.dup
       button_options[:class] = [options[:class], 'dropdown-button'].compact.join(' ')
-      button_options = button_options.merge(data: { controller: 'csedl-dropdown', panel_id: id })
+      button_options = button_options.merge(data: { controller: 'hotwire-svelte-helpers-dropdown', panel_id: id })
 
       button_content = capture(&button_content) if button_content.is_a?(Proc)
       btn = content_tag(:div, button_content, button_options)
@@ -46,7 +46,7 @@ module StimulusOverlayHelpers
         safe_join([
                     content_tag(:div, class: 'header') do
                       concat content_tag(:div, title, class: 'title')
-                      concat content_tag(:div, class: 'buttons') { close_btn_proc.present? ? close_btn_proc.call(self) : content_tag(:span, 'X', class: 'close-button') }
+                      concat content_tag(:div, class: 'buttons') { close_btn_proc.present? ? close_btn_proc.call(self) : content_tag(:span, 'X', class: 'close-button', data: { close: true }) }
                     end,
                     content_tag(:div, class: 'content') do
                       capture(&panel_content) if block_given?
@@ -62,6 +62,59 @@ module StimulusOverlayHelpers
       end
     end
 
+    def modal(button_content, title = nil, options = {}, &panel_content)
+      if title.is_a?(Hash)
+        options = title.dup
+        title = nil
+      end
+
+      panel_at_place = options.delete(:panel_at_place)
+
+      id = "modal-overlay-#{SecureRandom.hex(4)}"
+
+      src = options.delete(:src)
+
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+      # create the Button
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+      button_options = options.dup
+      button_options[:class] = [options[:class], 'modal-button'].compact.join(' ')
+      button_options = button_options.merge(data: { controller: 'hotwire-svelte-helpers-modal', panel_id: id })
+
+      button_content = capture(&button_content) if button_content.is_a?(Proc)
+      btn = content_tag(:div, button_content, button_options)
+
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+      # create the overlay
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+      panel_options = options.dup
+      panel_options[:class] = [options[:class], 'modal-panel'].compact.join(' ')
+      panel_options['data-src'] = src if src
+      close_btn_proc = StimulusOverlayHelpers.close_button_proc
+
+      overlay = content_tag(:div, class: 'modal-overlay', style: 'display:none;', id: id) do
+        content_tag(:div, panel_options) do
+          safe_join([
+                      content_tag(:div, class: 'header') do
+                        concat content_tag(:div, title, class: 'title')
+                        concat content_tag(:div, class: 'buttons') { close_btn_proc.present? ? close_btn_proc.call(self) : content_tag(:span, 'X', class: 'close-button', data: { close: true }) }
+                      end,
+                      content_tag(:div, class: 'content') do
+                        capture(&panel_content) if block_given?
+                      end
+                    ])
+        end
+      end
+
+      if panel_at_place
+        btn + overlay
+      else
+        content_for(:overlays_box, overlay)
+        btn
+      end
+    end
 
     def tooltip(label, options = {}, &content)
 
@@ -86,7 +139,7 @@ module StimulusOverlayHelpers
       label_options = options.dup
       label_options[:id] = options.delete(:id)
       label_options[:class] = [options[:class], label_class].compact.join(' ')
-      label_options = label_options.merge(data: { controller: 'csedl-tooltip', panel_id: id, delay: delay })
+      label_options = label_options.merge(data: { controller: 'hotwire-svelte-helpers-tooltip', panel_id: id, delay: delay })
 
       label_element = if block_given? && cont.present?
                         content_tag(:span, label_options) do
@@ -118,7 +171,6 @@ module StimulusOverlayHelpers
       # return the result
       # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 
-
       if !panel_element
         label_element
       elsif panel_at_place

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimulus-overlay-helpers
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Christian Sedlmair
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-27 00:00:00.000000000 Z
+date: 2026-05-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email: christian@sedlmair.ch