view_component_reflex 2.1.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cba771f1bff88b05863347a7bd1d071b8c931cdab779b65223b05e103a841d7
-  data.tar.gz: 9251cf944ebdc965b26afb5d4e15002a98c230a6efb3dc528f3e88873843f22d
+  metadata.gz: 4ac0e4b7fc45ba1963f6d260f66463a00a37fccfb6db10855f608beb8f54126e
+  data.tar.gz: eaa30fcda3a41ffc51f651398d490a51b89d1eb06fdf81619e2a9ee0535b62f7
 SHA512:
-  metadata.gz: c35f1bf68654bdb97acb33af4e7552fd3b6fb3f3bbf8cf599b214a35340a8648ed614c6ca4281df19446ce997be4ee493b56e08f3480b10d4d84cab38ccd68fb
-  data.tar.gz: 93a5a0702e21814df172fef57d1cadbc4c91c9d8123affb3d331e3fa8cc98e0c6055257f2c8754e86d6a1ef05170c7aa8ad806455ad8610c650f59aa3a4fc417
+  metadata.gz: aa7fed3d3bd4aa4718c5c5358c798b6e0a9edb028d26bb26228989cf6c17f9348036a5ab4d3932c376cb632b7eb145d1e7e1f37a44405e6188609cf1b3942bd8
+  data.tar.gz: f761bbdc0c3a11edbcc01e49fe704fa4a8dac9fdf167a5068c2187d28bb35b400afe542edd2d2b7fe2964a0d5a224a299d00de660a47c26525162e12b8d5efea

data/README.md

@@ -2,6 +2,8 @@
 
 ViewComponentReflex allows you to write reflexes right in your view component code.
 
+It builds upon [stimulus_reflex](https://github.com/hopsoft/stimulus_reflex) and [view_component](https://github.com/github/view_component)
+
 ## Usage
 
 You can add reflexes to your component by adding inheriting from `ViewComponentReflex::Component`.
@@ -88,12 +90,30 @@ This shares the same definition as `content_tag`, except it accepts a reflex as
 
 Would add a click handler to the `increment` method on your component.
 
-To use a non-click event, specific that with `->` notiation
+To use a non-click event, specific that with `->` notation
 
 ```erb
 <%= reflex_tag "mouseenter->increment", :button, "Click me!" %>
 ```
 
+### reflex_data_attributes(reflex)
+
+This helper will give you the data attributes used in the reflex_tag above if you want to build your own elements.
+
+Build your own tag:
+
+```erb
+<%= link_to (image_tag photo.image.url(:medium)), data: reflex_data_attributes(:increment) %>
+```
+
+Render a ViewComponent
+
+```erb
+<%= render ButtonComponent.new(data: reflex_data_attributes("mouseenter->increment")) %>
+```
+
+Make sure that you assign the reflex_data_attributes to the correct element in your component.
+
 ### collection_key
 If you're rendering a component as a collection with `MyComponent.with_collection(SomeCollection)`, you must define this method to return some unique value for the component.
 This is used to reconcile state in the background.
@@ -279,9 +299,9 @@ Or install it yourself as:
 $ gem install view_component_reflex
 ```
 
-## Common problems
+# Common problems
 
-# Uninitialized constants \<component\>Reflex
+## Uninitialized constants \<component\>Reflex
 A component needs to be wrapped in `<%= component_controller do %>` in order to properly initialize, otherwise the Reflex class won't get created.
 
 ## License

data/app/components/view_component_reflex/component.rb

@@ -54,20 +54,25 @@ module ViewComponentReflex
       @key = key
     end
 
-    def reflex_tag(reflex, name, content_or_options_with_block = {}, options = {}, escape = true, &block)
+    # Helper to use to create the proper reflex data attributes for an element
+    def reflex_data_attributes(reflex)
       action, method = reflex.to_s.split("->")
       if method.nil?
         method = action
         action = "click"
       end
-      data_attributes = {
+
+      {
         reflex: "#{action}->#{self.class.name}##{method}",
         key: key
       }
+    end
+
+    def reflex_tag(reflex, name, content_or_options_with_block = {}, options = {}, escape = true, &block)
       if content_or_options_with_block.is_a?(Hash)
-        merge_data_attributes(content_or_options_with_block, data_attributes)
+        merge_data_attributes(content_or_options_with_block, reflex_data_attributes(reflex))
       else
-        merge_data_attributes(options, data_attributes)
+        merge_data_attributes(options, reflex_data_attributes(reflex))
       end
       content_tag(name, content_or_options_with_block, options, escape, &block)
     end
@@ -97,8 +102,8 @@ module ViewComponentReflex
         ViewComponentReflex::Engine.state_adapter.state(request, @key).each do |k, v|
           instance_value = instance_variable_get(k)
           if permit_parameter?(initial_state[k], instance_value)
-            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, "#{@key}_initial", { k => instance_value })
-            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, @key, { k => instance_value })
+            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, "#{@key}_initial", {k => instance_value})
+            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, @key, {k => instance_value})
           else
             instance_variable_set(k, v)
           end

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '2.1.5'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.2.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-16 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails