sn_filterable 3.1.2 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 189899fbf9e20cc4383ea9429c84278c0e7f231dc5d315a35193d6232f696758
-  data.tar.gz: b35afd8d7a0bef95d8567d7e66bf53de969e494b8cbc2b39f894405d9d2e059c
+  metadata.gz: 0bc47df19eb878cd2185a81c845708e58daa50a4d084a45e56a46e3a37bff2a3
+  data.tar.gz: 38389e482742a8abeb5003c589bf0347ec238870e016eb445e67b273b4f5e32f
 SHA512:
-  metadata.gz: 512c8c66a5fcbd99c1d93a4161b02da557a007d3912162954a155c43deb3015fbb698757fb6f895eb553a03a17441403dd2b5551f74ffb48ce4cbb5c3a4c4c5c
-  data.tar.gz: dc13d05d8e747b99155d0ade9fd98f1adad2e0051c2c1e52e5905d4314c03a50a43f44f4d9428a05ca62f35e39bf72a51793e80bcb2f1c8ebe44f16325e6995c
+  metadata.gz: e78f6ab61549b24c38fee7b1572251d620a616ffe001dd0e2e7c1a2e9dbf6a38950329d3296c9c7618496bc263893d392315614a449344cd902a97bd8889810f
+  data.tar.gz: fe920cbbac525670491df387d9c9642a0bb55508496e34d181a850b23a4691a18d9841f9f5bc1f4cba301ba5fb295c7bd5834b8c61f25bf5f77ad19f3c5462ee

data/app/components/sn_filterable/filter_category_component.html.erb

@@ -28,7 +28,7 @@
     <div class="min-w-0 flex-1 flex-grow">
       <%= content_tag :label,
                       sub_filter[:name],
-                      class: "block py-2 pr-4 text-gray-600 dark:text-gray-400 select-none w-full cursor-pointer",
+                      class: "block pl-3 py-2 text-gray-600 dark:text-gray-400 select-none w-full cursor-pointer",
                       for: "filter-#{@filter[:filter_name]}-#{index}" %>
     </div>
   </div>

data/app/components/sn_filterable/main_component.html.erb

@@ -6,6 +6,7 @@
                   "method": "get",
                   "data-turbo-frame": @frame_id,
                   "class": "relative",
+                  "aria-label": "Content filters",
                   "@submit": "filtersLoading = true" do %>
     <% @extra_params.each do |k, v| %>
       <%= content_tag :input, "", class: "hidden", type: "hidden", value: v, name: k %>
@@ -17,7 +18,7 @@
           <% if search? %>
             <%= search %>
           <% else %>
-            <div class="col-span-2 col-start-2 md:ml-48 lg:ml-64 h-12 pointer-events-auto">
+            <div class="col-span-2 xl:col-span-1 col-start-1 h-12 pointer-events-auto">
               <%= render search_field %>
             </div>
           <% end %>
@@ -82,7 +83,7 @@
         <%= render SnFilterable::FilterButtonComponent.new(filtered: @filtered, filters: @filters) %>
       </div>
       <% if @search_filter_name.present? %>
-        <div class="col-span-2 col-start-2 md:ml-64 h-12 pointer-events-none"></div>
+        <div class="col-span-2 xl:col-span-1 col-start-1 h-12 pointer-events-none"></div>
       <% end %>
     </div>
 

data/app/components/sn_filterable/main_component.rb

@@ -34,6 +34,7 @@ module SnFilterable
       @show_sidebar = show_sidebar
       @update_url_on_submit = update_url_on_submit
       @extra_params = extra_params
+      @filtered.extra_params = extra_params if extra_params.present?
     end
 
     def search_field

data/lib/models/filtered.rb

@@ -7,19 +7,21 @@
 #
 # @see Filterable
 class Filtered
-  attr_accessor :items, :queries
+  attr_accessor :items, :queries, :extra_params
 
   # @param [Class] model_class The class of the ActiveRecord::Base subclass
   # @param [ActiveRecord::Relation] items The items sorted and filtered by [Filterable]
   # @param [Hash] queries A hash of the sorting / filtering parameters
   # @param [Symbol] sort_name The current sorting name
   # @param [Boolean] sort_reversed True when the current sorting order is reversed
-  def initialize(model_class, items, queries, sort_name, sort_reversed)
+  # @param [Hash] extra_params Optional hash of additional parameters to include in URLs
+  def initialize(model_class, items, queries, sort_name, sort_reversed, extra_params = {})
     @model_class = model_class
     @items = items
     @queries = queries
     @sort_name = sort_name
     @sort_reversed = sort_reversed
+    @extra_params = extra_params || {}
   end
 
   # Returns if any filters are active
@@ -162,6 +164,11 @@ class Filtered
     uri = URI.parse(url)
     query = Rack::Utils.parse_nested_query(uri.query).deep_merge(@queries.deep_dup)
 
+    # Add extra_params to the URL
+    @extra_params.each do |key, value|
+      query[key.to_s] = value
+    end if @extra_params.present?
+
     yield(query) if block_given?
 
     uri.query = Rack::Utils.build_nested_query(query)

data/lib/sn_filterable/filterable.rb

@@ -26,8 +26,9 @@ module SnFilterable
       # @param [ActiveRecord::Relation] items Optional, the items to scope from the model
       # @param [String, Array, nil] default_sort Optional, similar to the `DEFAULT_SORT` constant, sets the default sort of items when no sorting parameter is set. Can be either a [String], which returns the sorting name or an [Array], where the first item is the sorting name and the second item is the sort direction (either `:asc` or `:desc`). Will take precedence over the `DEFAULT_SORT` constant.
       # @param [Boolean] pagination_enabled Optional, toggles pagination
+      # @param [Hash] extra_params Optional, allows for custom query parameters to be included in URLs
       # @return [Filtered] the filtered and sorted items
-      def filter(params:, items: where(nil), default_sort: nil, pagination_enabled: true)
+      def filter(params:, items: where(nil), default_sort: nil, pagination_enabled: true, extra_params: {})
         filter_params = filter_params(params)
         sort_params = sort_params(params)
         other_params = other_params(params, items)
@@ -35,7 +36,7 @@ module SnFilterable
         items = perform_filter(items, filter_params)
         items = items.page(other_params[:page]).per(other_params[:per]) if pagination_enabled
 
-        Filtered.new(self, items, generate_url_queries(filter_params, sort_params, other_params), sort_name, reverse_order)
+        Filtered.new(self, items, generate_url_queries(filter_params, sort_params, other_params), sort_name, reverse_order, extra_params)
       end
 
       private

data/lib/sn_filterable/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sn_filterable
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.4
 platform: ruby
 authors:
 - IBM Skills Network
 bindir: exe
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: heroicon