feat: add update_url_on_submit option (#13)

* Add update_url_on_submit option

* Bump minor version

* bundle

Co-authored-by: Chase McDougall <[email protected]>

Author: michaelroudnitski

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sn_filterable (1.0.1)
+    sn_filterable (1.1.0)
       heroicon (~> 1)
       kaminari (~> 1)
       pg (~> 1)

app/components/sn_filterable/main_component.html.erb

@@ -70,7 +70,7 @@
     </div>
   <% end %>
 
-  <%= turbo_frame_tag @frame_id, "data-turbo-action": "advance" do %>
+  <%= turbo_frame_tag @frame_id, "data-turbo-action": @update_url_on_submit ? "advance" : nil do %>
     <%= content_tag :input, "", type: "hidden", name: "sort", value: @filtered.queries["sort"] if @filtered.queries["sort"].present? %>
     <%= content_tag :input, "", type: "hidden", name: "order", value: @filtered.queries["order"] if @filtered.queries["order"].present? %>
 

app/components/sn_filterable/main_component.rb

@@ -23,13 +23,15 @@ class MainComponent < ViewComponent::Base
     # @param [String, nil] url Optional, the base URL of where the filters are displayed
     # @param [String, nil] search_filter_name Optional, enable's and set's the search filter, specified by the filter's parameter name
     # @param [Boolean] show_sidebar If true, will show the sidebar with the filters.
-    def initialize(frame_id:, filtered:, filters:, url: nil, search_filter_name: nil, show_sidebar: true)
+    # @param [Boolean] update_url_on_submit If true, will update the URL in the user's browser on form submission.
+    def initialize(frame_id:, filtered:, filters:, url: nil, search_filter_name: nil, show_sidebar: true, update_url_on_submit: true)
       @frame_id = frame_id
       @filtered = filtered
       @filters = filters
       @url = url
       @search_filter_name = search_filter_name
       @show_sidebar = show_sidebar
+      @update_url_on_submit = update_url_on_submit
     end
 
     def search_field

lib/sn_filterable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SnFilterable
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end