katalyst-kpop 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfe556211c8cb27976e75cf940c7ae065fc6fbfb31f8a9fb2c78ec6e3d36db4d
-  data.tar.gz: 7014e09c2697ff7e0d0093f67068b1583a21c8bdb165222df6b990e63869eac0
+  metadata.gz: 66c9e1bfc0f87b08a5d2135d9e019a231436caa3e160c0aa650605a2476aa1cf
+  data.tar.gz: e14bf1caf937a8c55c5c6e88e2ff94bfa53296bb93023f7ff8de9c23f17068fb
 SHA512:
-  metadata.gz: 7affe4e861d299c11391520a71adf5d7a9fa4e1af699d7bd9938b0c784784c531992fd68d7d8ea14c58a974b2f6a52ff6e021bcab5811874730e006b1d7d31e9
-  data.tar.gz: d087f450b624e8dc6e4c2426672eb697e52f6e5fe3bbac402f2b71458d0c35ce8f956a60b6c6446f9a6bce4100fbb33865dd4af8550ce12fe0342540a59add1d
+  metadata.gz: 5ff8771ff501eceaf9d2bf6aff0cf6da279afbeb93605bc828aaaf4777505c1f624e0dabf84347a167f010288b9c8a79019e1a9d375e828d35da990820253985
+  data.tar.gz: ff52b8f6cd986c74cd6873b773bc186d23a3fcc98f501fb65f404bcee45f32b91fa0bb3a55306fbf6c9e63c7100f7de7887b8e9c7a280ddbe2ebe93200a9e02f

data/app/helpers/kpop_helper.rb

@@ -1,10 +1,18 @@
 # frozen_string_literal: true
 
 module KpopHelper
+  # Render a modal dialog. Intended for use inside a kpop turbo frame tag.
+  # See builder for options.
   def render_kpop(options = {}, &block)
     Kpop::Modal.new(self).render(options, &block)
   end
 
+  # Render a turbo stream action that will dismiss any open kpop modals.
+  def dismiss_kpop
+    turbo_stream.update("kpop", "")
+  end
+
+  # Render a turbo frame tag that can be targeted for rendering kpop modals.
   def kpop_frame_tag(&block)
     turbo_frame_tag "kpop",
                     class: "kpop-container",
@@ -13,6 +21,8 @@ module KpopHelper
     end
   end
 
+  # Renders a link that will navigate the kpop turbo frame to the given URL.
+  # The URL should render a modal response inside a kpop frame tag.
   def kpop_link_to(name = nil, options = nil, html_options = nil, &block)
     default_html_options = {
       data: { turbo: true, turbo_frame: "kpop" },
@@ -25,6 +35,8 @@ module KpopHelper
     end
   end
 
+  # Renders a button that will navigate the kpop turbo frame to the given URL.
+  # The URL should render a modal response inside a kpop frame tag.
   def kpop_button_to(name = nil, options = nil, html_options = nil, &block)
     default_html_options = {
       form: { data: { turbo: true, turbo_frame: "kpop" } },
@@ -32,6 +44,7 @@ module KpopHelper
     button_to(name, options, default_html_options.deep_merge(html_options || {}), &block)
   end
 
+  # Renders a button that will close the current kpop modal, if any.
   def kpop_button_close(content = nil, **options, &block)
     content = block ? capture(yield) : content
     tag.button content, data: { action: "click->kpop#dismiss:prevent" }, **options

data/lib/katalyst/kpop/version.rb

@@ -2,6 +2,6 @@
 
 module Katalyst
   module Kpop
-    VERSION = "2.0.0"
+    VERSION = "2.0.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-kpop
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Katalyst Interactive