stimulus-overlay-helpers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed9c39b6dd74b4ae136adeb53976a9f163274fdb5a015c64893914fa036f976d
+  data.tar.gz: a82288e58dbadef0ae37d6c06de3e380151aa7aee6c59deab531ea732b1ea2ea
+SHA512:
+  metadata.gz: b1f99ebd83e1077f7b0e2fce50691d51931e6af30f1b967ef929adbc4fccab8da54ce9eae9efeddbe2e7bf782698090cd2d8f213caebb95772aa67711fefb748
+  data.tar.gz: a38b5ee26de87f5a14ab19486ce86c052752a358c6e27a91fa70382e37d1503d7a0417de9f7e5af34d48d68b84cabaf9802c9bfbc570772e325d0497dffc3f7b

data/README.md

@@ -0,0 +1,52 @@
+# Stimulus Overlay Helpers
+
+This gem adds two view helpers corresponding to the npm package
+[@csedl/hotwire-svelte-helpers](https://www.npmjs.com/package/@csedl/hotwire-svelte-helpers), to a rails app.
+
+There is a [online example rails app](https://hotwire-svelte-helpers.sedlmair.ch/).
+
+**Links**
+* [How we are building a Rails App](https://dev.to/chmich/setup-vite-svelte-inertia-stimulus-bootstrap-foundation-on-rails-7-overview-1bk1)
+
+## Installation
+
+add
+
+```ruby
+gem 'stimulus-overlay-helpers'
+```
+
+to your Gemfile and run `bundle install`
+
+## Configuration
+
+If you work with the helpers on this gem, you can setup a initializer for a custom close-button, like: 
+
+```ruby
+#=> config/initializers/stimulus_overlay_helpers.rb
+
+StimulusDropdown.configure do |config|
+  config.close_button_proc = ->(view) do
+    view.content_tag(:span, 'X', class: 'close-button')
+  end
+end
+```
+
+## Usage Examples
+
+```haml
+= dropdown('button-label-or-proc', class: 'fetch-from-server', src: optional_server_request_path) do
+  'any content here ...'
+```
+
+```haml
+= dropdown(->{inline_svg_tag("my-svg")}, class: 'fetch-from-server', src: optional_server_request_path) do
+  'any content here ...'
+```
+
+```haml
+= tooltip('tooltip-text-or-proc', class: 'primary-tooltip') do
+    tooltip-content
+```
+
+License: MIT

data/lib/stimulus-overlay-helpers.rb

@@ -0,0 +1,20 @@
+require 'stimulus_overlay_helpers/railtie' if defined?(Rails)
+require 'stimulus_overlay_helpers/view_helpers'
+
+# Provides helpers and configuration for Stimulus overlay behavior.
+module StimulusOverlayHelpers
+  class << self
+    attr_accessor :close_button_proc
+
+    def configure
+      yield self
+    end
+
+    def reset_config!
+      self.close_button_proc = nil
+    end
+  end
+
+  # Default fallback if no config is set
+  self.close_button_proc = nil
+end

data/lib/stimulus_overlay_helpers/railtie.rb

@@ -0,0 +1,10 @@
+module StimulusOverlayHelpers
+  class Railtie < Rails::Railtie
+
+    initializer "stimulus_overlay_helpers.view_helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include StimulusOverlayHelpers::ViewHelpers
+      end
+    end
+  end
+end

data/lib/stimulus_overlay_helpers/view_helpers.rb

@@ -0,0 +1,137 @@
+module StimulusOverlayHelpers
+  module ViewHelpers
+    #== dropdown helper
+    # @param [button_content] Proc or String for content of the button element
+    # @param [panel_at_place] true (default: false) => it would render the panel into content_for(:dropdown_panels) on sticky parts (left-menu / top-bar) panels should be at place for avoiding that the panel would scroll with the content
+    # @block [panel_content] Panel Content as block
+    # what it does:
+    # * a) wraps the button_content in element like: %button{ data: { controller: 'dropdown', ... } } and renders it at place
+    # * b) wraps the panel_content in a corresponding element and renders it to the dropdown_panels-box (because of z-index-hierarchy)
+    # * c) the stimulus controller always adds the class .dropdown-panel to the panel
+    def dropdown(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 = "dropdown-panel-#{SecureRandom.hex(4)}"
+
+      src = options.delete(:src)
+
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+      # create the Button
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+      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_content = capture(&button_content) if button_content.is_a?(Proc)
+      btn = content_tag(:div, button_content, button_options)
+
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+      # create the panel
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+      panel_options = options.dup
+      panel_options[:class] = [options[:class], 'dropdown-panel'].compact.join(' ')
+      panel_options[:style] = "display: none;"
+      panel_options[:id] = id
+      panel_options['data-src'] = src if src
+      close_btn_proc = StimulusOverlayHelpers.close_button_proc
+
+      panel = 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') }
+                    end,
+                    content_tag(:div, class: 'content') do
+                      capture(&panel_content) if block_given?
+                    end
+                  ])
+      end
+
+      if panel_at_place
+        btn + panel
+      else
+        content_for(:dropdown_panels, panel)
+        btn
+      end
+    end
+
+
+    def tooltip(label, options = {}, &content)
+
+      panel_at_place = options.delete(:panel_at_place) || false
+      delay = options.delete(:delay) || 0.4
+      src = options.delete(:src)
+      label_class = options.delete(:label_class) || 'tooltip-label'
+
+      id = ['tooltip', SecureRandom.hex(4)].join('-')
+
+      lab = if label.is_a?(Proc)
+              capture &label
+            else
+              label
+            end
+      cont = capture(&content) if block_given?
+
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+      # create the Label
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+      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_element = if block_given? && cont.present?
+                        content_tag(:span, label_options) do
+                          lab
+                        end
+                      else
+                        lab
+                      end
+
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+      # create the panel
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+      panel_options = options.dup
+      panel_options[:class] = [options[:class], 'tooltip-panel'].compact.join(' ')
+      panel_options[:id] = id
+      panel_options[:style] = 'display: none;'
+      panel_options['data-src'] = src if src
+
+      panel_element = if block_given? && cont.present?
+                        content_tag(:div, panel_options) do
+                          content_tag(:div, class: 'content') do
+                            cont
+                          end
+                        end
+                      end
+
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+      # return the result
+      # xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+
+      if !panel_element
+        label_element
+      elsif panel_at_place
+        r = label_element
+        r << panel_element
+      else
+        content_for(:dropdown_panels) do
+          panel_element
+        end
+        label_element
+      end
+
+    end
+
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: stimulus-overlay-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christian Sedlmair
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-22 00:00:00.000000000 Z
+dependencies: []
+description:
+email: christian@sedlmair.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/stimulus-overlay-helpers.rb
+- lib/stimulus_overlay_helpers/railtie.rb
+- lib/stimulus_overlay_helpers/view_helpers.rb
+homepage: https://gitlab.com/sedl/csedl-stimulus-dropdown
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/sedl/csedl-stimulus-dropdown
+  source_code_uri: https://gitlab.com/sedl/csedl-stimulus-dropdown
+  changelog_uri: https://gitlab.com/sedl/csedl-stimulus-dropdown
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: View helpers for the npm package @csedl/hotwire-svelte-helpers
+test_files: []