phlex-stimulus 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9daeb0661e299cb12e012622f2fd879e1b0a5b0cb47f35f10fa0d7a306ef1f1
-  data.tar.gz: e104306fddb134fd3aab3e8c3e987b132e209b4f59ce0196d711cb5b0ec19539
+  metadata.gz: '01190c3e09b4d2381741d1191ba5b06f2222fed5c20246e69732f80672e742b0'
+  data.tar.gz: 79686f42a9561d53b17c94f7652c762ba9d43358ad710f8fd456129907ea0e76
 SHA512:
-  metadata.gz: d89cc17fb9c9d6178adf2a52c5648a2cfce4b338b0b0e703d0ed62186958c1883e35c2597010cc584fc3f63dda930890a7c00b3215f984489bd3524f726182ee
-  data.tar.gz: 4ef495c9749504edff2fb5fd93e8027ba2ca9a739872078a66b52dbaea6880132101d905c481a594b1245ed1f168d9f5ddf9dd4b4c8d4058b5f3c8206e65faf4
+  metadata.gz: 5e857f549c94fa68e8639f9e8bbcfda48626bbf2e3fb960d25d0e1490f97c453cce96174239c660532a1be4a2abd2be85a82221f3a8c2c380da24b5d9ed24fde
+  data.tar.gz: 7d459a8ff17f0626c0fc692b5b9fa929c2081815b8438e38a198518f10e94a16d0157a2c6e5ce94597c37914085d2a8216d121e8e67ffa51bb845af437d43334

data/CHANGELOG.md

@@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Add changes in new features here. Do not change the gem's version in pull/merge requests.
 
+## [0.2.0] - 29.07.2026
+
+[Diff](https://github.com/espago/phlex-stimulus/compare/v0.1.3...v0.2.0)
+
+- Add action parameter support
+
 ## [0.1.3] - 28.07.2026
 
 [Diff](https://github.com/espago/phlex-stimulus/compare/v0.1.2...v0.1.3)

data/README.md

@@ -210,6 +210,40 @@ This is the same as:
 div(data: { 'summary:redirected' => 'other#do' })
 ```
 
+#### `param`
+
+This method helps you get the names of parameters
+given to stimulus actions.
+You can read more about action parameters [here](https://stimulus.hotwired.dev/reference/https://stimulus.hotwired.dev/reference/actions#action-parameters).
+
+```rb
+class SummaryController < Controller
+  self.controller_name = 'summary'
+
+  actions :foo
+end
+
+SummaryController.param('id') #=> "summary-id-param"
+```
+
+You would use it like so to define a parameter for a stimulus action:
+
+```rb
+div(
+  data: {
+    action: event('click', SummaryController.foo_action),
+    # will be available as `event.id` in the action
+    SummaryController.param('id') => 35,
+  },
+)
+```
+
+This is the same as:
+
+```rb
+div(data: { 'summary:redirected' => 'other#do' })
+```
+
 ### Component Helpers
 
 There are some useful helper methods you can use in every phlex component.

data/lib/phlex/stimulus/components/controller.rb

@@ -84,6 +84,16 @@ module Phlex::Stimulus
           @target_defs ||= []
         end
 
+        # Constructs a Stimulus action parameter name
+        # eg.
+        #
+        #     SummaryController.param('id') #=> "summary-id-param"
+        #
+        #: (String) -> String
+        def param(param_name)
+          "#{controller_name}-#{param_name}-param"
+        end
+
         # Constructs a Stimulus dispatched event name
         # eg.
         #

data/lib/phlex/stimulus/version.rb

@@ -3,6 +3,6 @@
 
 module Phlex
   module Stimulus
-    VERSION = '0.1.3'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phlex-stimulus
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Espago