stimulus_rails_datatables 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b850688d95d3bbcea4dc97863df1249b3a926b5e686b9b25f840ccd169ce46be
-  data.tar.gz: d4b7b87d91f94aa5bd5691e36d20027bbc98c2c672dc47c3fbb1c45dc1b79fd0
+  metadata.gz: 6c52d575fdf1e4bf88eb1cdf3b581ed80ec4c6956b1d5f0c3a60b90f99d2e3f2
+  data.tar.gz: 9bf301decccb7e7490972346183d73fa25d659088383521ff8b825b6bc83ac5e
 SHA512:
-  metadata.gz: 740fb571e4e0836dc58df16ccbc009d55e2dd78dc7244948e85b9ab27fd0e79835e7be1f38f0e84d52bf7aac5f0d7524bb8bd596499fa533e77c8c0a13009038
-  data.tar.gz: 78e0b1238a6d89e08a17464303dca30cb3ba4b4a60604c8e4ce6c20116521541fa126a62d56441c600af4ac0fef4f1b880949aa994b06c586dce882be968cec5
+  metadata.gz: 61e84f397c85ad598f98b47f7451e454fa6fae7e8e707fee9b9281829feecab1e151be8a387d4ea19cad63ac3d71f3e3c301f756dc2f20f07f9b7948a0f830ea
+  data.tar.gz: 780dddf9239013c1fb8444a0d2ffeaab370829cfbffcd0827d23f5545f8e082d3740403b8e4854e52ed0185cf8eccd683decd3eb9d6353e2b8e327ac7113c73d

data/CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.0] - 2026-09-25
+
+### Added
+- `resetPaging` global config option (`window.datatablesConfig` or `setDatatablesConfig`) to go back to the first page when filters change; defaults to `false`
+- `reset_paging` option for the `datatable_for` helper, which overrides the global `resetPaging` value per datatable
+
+## [0.6.0] - 2026-08-03
+
+### Added
+- Tom-Select support for remote filter selects via the `tomselect` option
+- `multiple` option for remote filter selects, sending the selected values as array params (`filters[key][]=`)
+- `set_values` remote option to preselect multiple values
+- Summary label showing the number of selected items on Tom-Select multi-selects
+
+### Changed
+- The `location` filter's barangay select is now a Tom-Select multi-select
+- The filter controller imports `tom-select`, so the host app must pin it in its importmap
+
 ## [0.5.1] - 2026-07-28
 
 ### Changed

data/README.md

@@ -335,10 +335,25 @@ window.datatablesConfig = {
   },
 
   // Length menu options
-  lengthMenu: [[10, 25, 50, 100], [10, 25, 50, 100]]
+  lengthMenu: [[10, 25, 50, 100], [10, 25, 50, 100]],
+
+  // Go back to the first page when filters change (default: false)
+  resetPaging: true
 }
 ```
 
+### Resetting Pagination on Filter Change
+
+By default, changing a filter reloads the datatable and keeps the current page. Set `resetPaging: true` in `window.datatablesConfig` to jump back to the first page for every datatable, or override it per table with `reset_paging:`:
+
+```ruby
+<%= datatable_for 'users-table', source: users_path, reset_paging: false do |dt| %>
+  <% dt.column :name %>
+<% end %>
+```
+
+Leave `reset_paging:` out to use the global value. Restoring saved filters on page load never resets the page, so the page kept by `state_save` is not lost.
+
 ### Available Stimulus Controllers
 
 The gem automatically registers the following Stimulus controllers:

data/app/assets/javascripts/stimulus_rails_datatables/config.js

@@ -30,7 +30,10 @@ let datatablesConfig = {
   },
 
   // Length menu options
-  lengthMenu: [[10, 25, 50, 100], [10, 25, 50, 100]]
+  lengthMenu: [[10, 25, 50, 100], [10, 25, 50, 100]],
+
+  // Go back to the first page when filters change (override per table with datatable_for reset_paging:)
+  resetPaging: false
 }
 
 // Function to let the app override defaults

data/app/assets/javascripts/stimulus_rails_datatables/datatables_controller.js

@@ -17,7 +17,8 @@ export default class extends Controller {
     pagingType: { type: String, default: 'simple_numbers' },
     searching: { type: Boolean, default: true },
     lengthChange: { type: Boolean, default: true },
-    responsive: { type: Boolean, default: true }
+    responsive: { type: Boolean, default: true },
+    resetPaging: Boolean
   }
 
   connect() {
@@ -89,7 +90,8 @@ export default class extends Controller {
       const config = {
         language: { ...defaultConfig.language, ...(userConfig.language || {}) },
         layout: { ...defaultConfig.layout, ...(userConfig.layout || {}) },
-        lengthMenu: userConfig.lengthMenu || defaultConfig.lengthMenu
+        lengthMenu: userConfig.lengthMenu || defaultConfig.lengthMenu,
+        resetPaging: userConfig.resetPaging ?? defaultConfig.resetPaging
       }
 
       const responsiveValue = this.responsiveValue
@@ -107,6 +109,9 @@ export default class extends Controller {
         responsive: this.responsiveValue,
         language: config.language,
         layout: config.layout,
+        // Not a DataTables option; the filter controller reads it back via datatable.init()
+        // Per-table value (datatable_for reset_paging:) wins over the global config
+        resetPaging: this.hasResetPagingValue ? this.resetPagingValue : !!config.resetPaging,
         initComplete: function() {
           if (responsiveValue === false) {
             // Add overflow-x only to the table wrapper (not the whole layout) this is alternative of scrollX

data/app/assets/javascripts/stimulus_rails_datatables/filter_controller.js

@@ -136,7 +136,8 @@ export default class extends Controller {
   }
 
   // reloadAppDatatable reloads the datatable with current params
-  async reloadAppDatatable() {
+  // pass resetPaging true/false to force it, otherwise the datatable's resetPaging setting is used
+  async reloadAppDatatable(resetPaging) {
     var id = this.element.dataset.filterDatatableId
 
     if (!id) {
@@ -147,7 +148,9 @@ export default class extends Controller {
       const datatableUrl = datatable.ajax.url().split('?')[0]
       const params = this.toQuery(this.currentParams())
 
-      datatable.ajax.url(`${datatableUrl}?${params}`).load(null, false)
+      if (typeof resetPaging !== 'boolean') resetPaging = datatable.init()?.resetPaging === true
+
+      datatable.ajax.url(`${datatableUrl}?${params}`).load(null, resetPaging)
     }
   }
 
@@ -296,8 +299,9 @@ export default class extends Controller {
       localStorage.setItem(`filterState:${this.filterDtId}`, JSON.stringify(payload))
     } catch (e) {}
 
+    // restoring saved filters is not a filter change, so keep the page restored by stateSave
     if (Object.keys(payload[rootKey] || {}).length > 0) {
-      this.reloadAppDatatable()
+      this.reloadAppDatatable(false)
     }
   }
 

data/app/helpers/stimulus_rails_datatables/datatable_helper.rb

@@ -8,6 +8,7 @@ module StimulusRailsDatatables
       length_change = options.fetch(:length_change, true)
       state_save = options.fetch(:state_save, true)
       responsive = options.fetch(:responsive, true)
+      reset_paging = options[:reset_paging] # nil falls back to the global resetPaging config
       columns = []
 
       capture(DatatableBuilder.new(self, columns), &block)
@@ -22,7 +23,8 @@ module StimulusRailsDatatables
         datatable_searching_value: searching,
         datatable_length_change_value: length_change,
         datatable_state_save_value: state_save,
-        datatable_responsive_value: responsive
+        datatable_responsive_value: responsive,
+        datatable_reset_paging_value: reset_paging
       }
 
       content_tag(:div, data: data) do

data/lib/generators/stimulus_rails_datatables/install/templates/datatables_config.js

@@ -41,5 +41,8 @@ window.datatablesConfig = {
   },
 
   // Length menu options
-  lengthMenu: [[10, 25, 50, 100], [10, 25, 50, 100]]
+  lengthMenu: [[10, 25, 50, 100], [10, 25, 50, 100]],
+
+  // Go back to the first page when filters change (override per table with datatable_for reset_paging:)
+  resetPaging: false
 }

data/lib/stimulus_rails_datatables/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusRailsDatatables
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_rails_datatables
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Den Meralpis