stimulus_table_filter 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f91c052d06053053b3a16d10850b67601c6adb56cf6b700e5185754d71113a3
-  data.tar.gz: 2300a0935a51a39f7b3efdb9a43350095e16d9ff5d7c2d07f72e880de28eabc5
+  metadata.gz: 495418a93784ca089dccd7fca9636a3bcc89a7e2f42599fc0cb9c6676be34ef7
+  data.tar.gz: c7486ef81d34dc5cd0d09ff3f2bd5047105f2810c25a296b960f1cdcaacddba1
 SHA512:
-  metadata.gz: 253a33fc42231ab85a0df2b4e99ccbc557c08f12d15ec8498d5518a165a04a5d7273901f6af6dfa5053909c1233a37895d8ff8d20686c624ce71c1571df5c918
-  data.tar.gz: 4606468cc32babe89d61bbab8729bf211e4c34d9b77a06a4f4eff4f5d706523ce295aa75e13795b1dcf1c0f0cce88d9a965d5b5dcd282fc15896ced0b9577097
+  metadata.gz: f9f256274e5dc8b69d2db008c7547781987d20dd67a0825f0c9e89af99c6b4b715bf6519ba80017073fe35cd6662e8776177ea9f0abd7ff78b8550ffc7e103f4
+  data.tar.gz: b61979d520487ce847e45c00d7d66c66c91adb8eaebb54a9a5742947825e666fda4c947fede3bada960eaf1546f4e584d65cae21f07b75c867cfb41310bf4f4b

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 All notable changes to this project will be documented in this file.
 The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## [0.2.0] - 2026-10-15
+
+- Add `table_filter_bar_tag`: a search input and optional filter buttons in one toolbar. It
+  raises `StimulusTableFilter::Error` when `filters:` is given without `dimension:`
+
 ## [0.1.1] - 2026-08-31
 
 - `table_filter_container_tag` accepts a `search:` option and emits

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stimulus_table_filter (0.1.1)
+    stimulus_table_filter (0.2.0)
       railties (>= 7.0, < 9)
 
 GEM
@@ -285,7 +285,7 @@ CHECKSUMS
   securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
   sexp_processor (4.17.5) sha256=ae2b48ba98353d5d465ce8759836b7a05f2e12c5879fcd14d7815b026de32f0e
   simplecov (1.1.1) sha256=25825ef13f0b2e74694d769817dad6ab8e90131dabdaa666e522fea105521e78
-  stimulus_table_filter (0.1.1)
+  stimulus_table_filter (0.2.0)
   thor (1.5.0) sha256=e3a9e55fe857e44859ce104a84675ab6e8cd59c650a49106a05f55f136425e73
   tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f
   tzinfo (2.0.6) sha256=8daf828cc77bcf7d63b0e3bdb6caa47e2272dcfaf4fbfe46f8c3a9df087a829b

data/README.md

@@ -110,13 +110,8 @@ A complete filterable table in one view partial:
 
 ```erb
 <%= table_filter_container_tag do %>
-  <%# Search + filter bar %>
-  <div>
-    <%= table_filter_search_tag(placeholder: "Search users…") %>
-    <%= table_filter_filter_btn_tag("all",      "All",      dimension: "status") %>
-    <%= table_filter_filter_btn_tag("active",   "Active",   dimension: "status") %>
-    <%= table_filter_filter_btn_tag("archived", "Archived", dimension: "status") %>
-  </div>
+  <%= table_filter_bar_tag(placeholder: "Search users…", dimension: "status",
+        filters: { "all" => "All", "active" => "Active", "archived" => "Archived" }) %>
 
   <table>
     <thead>
@@ -225,6 +220,28 @@ filters. Omit `filters:` and the filter helpers entirely for a search-and-sort-o
 Filters rows by matching `data-name`, or `data-searchable` when present. Case-insensitive
 substring match.
 
+### Toolbar
+
+`table_filter_bar_tag` renders the search input and, when `filters:` is given, a group of filter
+buttons inside one `<div>`:
+
+```erb
+<%= table_filter_bar_tag(placeholder: "Search users…", dimension: "status",
+      filters: { "all" => "All", "active" => "Active" },
+      class: "flex gap-2", search: { class: "input" }, group: { class: "join" }, button: { class: "btn" }) %>
+```
+
+| Option | Applies to |
+| --- | --- |
+| `placeholder:` | The search input |
+| `filters:` | `{ value => label }`; one button per entry. Omit it for a search-only bar. No group renders |
+| `dimension:` | The dimension every button acts on. **Required** with `filters:`. Without it the helper raises `StimulusTableFilter::Error` |
+| `search:`, `group:`, `button:` | Extra attributes (`class:`, `data:`, ...) for the input, the button group `<div>` and each button |
+| any other option | The outer `<div>` |
+
+It wraps `table_filter_search_tag` and `table_filter_filter_btn_tag`. Call those directly when
+you need a different layout.
+
 ### Filter buttons
 
 ```erb

data/lib/stimulus_table_filter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusTableFilter
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/stimulus_table_filter/view_helper/controls.rb

@@ -4,6 +4,14 @@ module StimulusTableFilter
   module ViewHelper
     def table_filter_search_tag(**opts) = tag.input(type: 'search', data: target_data('search', opts), **opts)
 
+    # Raises StimulusTableFilter::Error if +filters+ is given without +dimension+.
+    def table_filter_bar_tag(placeholder: nil, filters: {}, dimension: nil, search: {}, group: {}, button: {}, **opts)
+      content_tag(:div, **opts) do
+        safe_join([table_filter_search_tag(placeholder: placeholder, **search),
+                   table_filter_button_group(filters, dimension, group, button)])
+      end
+    end
+
     def table_filter_filter_btn_tag(value, label, dimension: nil, **opts)
       data = with_data({ filter_btn: value }, opts)
       data[:filter_dimension] = dimension if dimension
@@ -31,6 +39,18 @@ module StimulusTableFilter
 
     private
 
+    def table_filter_button_group(filters, dimension, group, button)
+      return if filters.empty?
+
+      content_tag(:div, table_filter_buttons(filters, dimension, button), **group)
+    end
+
+    def table_filter_buttons(filters, dimension, button)
+      raise Error, 'table_filter_bar_tag requires dimension: when filters are given' unless dimension
+
+      safe_join(filters.map { |value, label| table_filter_filter_btn_tag(value, label, dimension:, **button) })
+    end
+
     def option_tag(pair) = content_tag(:option, pair.first, value: pair.last)
     def render_options(pairs) = safe_join(pairs.map(&method(:option_tag)))
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_table_filter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - icoluccio
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Client-side table filtering, sorting and search for Rails
 test_files: []