Remove js_event_name_prefix and add stimulus_scoped_event/stimulus_scoped_event_on_window

Author: stevegeek

README.md

@@ -381,6 +381,37 @@ stimulus do
 end
 ```
 
+### Scoped Custom Events
+
+Vident provides helper methods to generate scoped event names for dispatching custom events that are unique to your component:
+
+```ruby
+class MyComponent < Vident::ViewComponent::Base
+  stimulus do
+    # Define an action that responds to a scoped event
+    actions [stimulus_scoped_event_on_window(:data_loaded), :handle_data_loaded]
+  end
+  
+  def handle_click
+    # Dispatch a scoped event from JavaScript
+    # This would generate: "my-component:dataLoaded"
+    puts stimulus_scoped_event(:data_loaded)
+    
+    # For window events, this generates: "my-component:dataLoaded@window" 
+    puts stimulus_scoped_event_on_window(:data_loaded)
+  end
+end
+
+# Available as both class and instance methods:
+MyComponent.stimulus_scoped_event(:data_loaded)      # => "my-component:dataLoaded"
+MyComponent.new.stimulus_scoped_event(:data_loaded)  # => "my-component:dataLoaded"
+```
+
+This is useful for:
+- Dispatching events from Stimulus controllers to communicate between components
+- Creating unique event names that won't conflict with other components
+- Setting up window-level event listeners with scoped names
+
 ### Manual Stimulus Configuration
 
 For more control, configure Stimulus attributes manually:

lib/vident/stimulus_attributes.rb

@@ -2,6 +2,25 @@
 
 module Vident
   module StimulusAttributes
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Class methods for generating scoped event names
+      def stimulus_scoped_event(event)
+        "#{component_name}:#{stimulus_js_name(event)}"
+      end
+
+      def stimulus_scoped_event_on_window(event)
+        "#{component_name}:#{stimulus_js_name(event)}@window"
+      end
+
+      private
+
+      def stimulus_js_name(name)
+        name.to_s.camelize(:lower)
+      end
+    end
+
     # Parse inputs to create a StimulusController instance representing a Stimulus controller attribute
     #   examples:
     #   stimulus_controller("my_controller") => StimulusController that converts to {"controller" => "my-controller"}
@@ -212,6 +231,15 @@ def add_stimulus_classes(named_classes)
       end
     end
 
+    # Stimulus events name for this component
+    def stimulus_scoped_event(event)
+      self.class.stimulus_scoped_event(event)
+    end
+
+    def stimulus_scoped_event_on_window(event)
+      self.class.stimulus_scoped_event_on_window(event)
+    end
+
     private
 
     def implied_controller

lib/vident/stimulus_component.rb

@@ -33,8 +33,6 @@ def stimulus_identifier = ::Vident::StimulusComponent.stimulus_identifier_from_p
       def component_name
         @component_name ||= stimulus_identifier
       end
-      # It is also used to generate the prefix for Stimulus events
-      alias_method :js_event_name_prefix, :component_name
     end
 
     # Components have the following properties
@@ -69,9 +67,6 @@ def stimulus_identifier = self.class.stimulus_identifier
     # An name that can helps identify the component type in the DOM or for styling purposes (its also used as a class name on the root element)
     def component_name = self.class.component_name
 
-    # The prefix for Stimulus events, which is used to generate the event names for Stimulus actions
-    def js_event_name_prefix = self.class.js_event_name_prefix
-
     # The `component` class name is used to create the controller name.
     # The path of the Stimulus controller when none is explicitly set
     def default_controller_path = self.class.stimulus_identifier_path

llm.txt

@@ -103,6 +103,24 @@ stimulus do
 end
 ```
 
+## Scoped Custom Events
+Generate unique event names for component communication:
+
+```ruby
+# Define actions that respond to scoped events
+stimulus do
+  actions [stimulus_scoped_event_on_window(:data_loaded), :handle_data_loaded]
+end
+
+# Generate scoped event names
+stimulus_scoped_event(:data_loaded)         # => "component-name:dataLoaded"
+stimulus_scoped_event_on_window(:data_loaded) # => "component-name:dataLoaded@window"
+
+# Available as both class and instance methods
+MyComponent.stimulus_scoped_event(:click)
+component_instance.stimulus_scoped_event(:click)
+```
+
 ## Manual Stimulus Configuration
 ```ruby
 def root_element_attributes

test/components/greeters/greeter_with_trigger_component_test.rb

@@ -261,9 +261,10 @@ def test_component_stimulus_identifier_path
     assert_equal expected_path, Greeters::GreeterWithTriggerComponent.stimulus_identifier_path
   end
 
-  def test_component_js_event_name_prefix
+  def test_component_stimulus_scoped_events
     expected_prefix = "greeters--greeter-with-trigger-component"
-    assert_equal expected_prefix, Greeters::GreeterWithTriggerComponent.js_event_name_prefix
+    assert_equal "#{expected_prefix}:click", Greeters::GreeterWithTriggerComponent.stimulus_scoped_event(:click)
+    assert_equal "#{expected_prefix}:click@window", Greeters::GreeterWithTriggerComponent.stimulus_scoped_event_on_window(:click)
   end
 
   def test_root_element_attributes_structure

test/components/phlex_greeters/greeter_with_trigger_component_test.rb

@@ -221,9 +221,10 @@ def test_component_stimulus_identifier_path
     assert_equal expected_path, PhlexGreeters::GreeterWithTriggerComponent.stimulus_identifier_path
   end
 
-  def test_component_js_event_name_prefix
+  def test_component_stimulus_scoped_events
     expected_prefix = "phlex-greeters--greeter-with-trigger-component"
-    assert_equal expected_prefix, PhlexGreeters::GreeterWithTriggerComponent.js_event_name_prefix
+    assert_equal "#{expected_prefix}:click", PhlexGreeters::GreeterWithTriggerComponent.stimulus_scoped_event(:click)
+    assert_equal "#{expected_prefix}:click@window", PhlexGreeters::GreeterWithTriggerComponent.stimulus_scoped_event_on_window(:click)
   end
 
   def test_root_element_attributes_structure