stimulus_rails_datatables 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fb4d9d9a89a2835c85454e5233bbc7c6c842f3edfc773c66cf989f88a1d7360
-  data.tar.gz: ed4597b08c8d1a00063f48c963a2f11f7ba96a5436260d5a5a3348cd5f99f8f9
+  metadata.gz: d839615241e07844f4051bda906e5b0678c4a2e41072598c284966379ba8a576
+  data.tar.gz: 59f3872b9593296872b1838af1039f67687ffeab0ef875de5d36339053f370bd
 SHA512:
-  metadata.gz: bdc04f63df7a51b0f49b3c179087aa16b9eed8aeea00133806b098a117d455eb1290f615683813cadc49bd45f68112d9282a30aacae1051d28df851ecd095eb4
-  data.tar.gz: eb61a469d12d5ee064556c3d947348067e091449e105be7bb04fa33bed8628c18518c5674d62d57599b459ccbccb2c3e9bb510d02ea4d803b14beb60b28c6743
+  metadata.gz: fd41c028f9d65c93716f8d9a1317966271637c1c5f368bd623d7f1ad86bd39dbc59603d6dd31f025042c16d78e11fe37559cc4198bdcb13e417e67a1b9842609
+  data.tar.gz: aee985f8fa8699cc7280dc387c60db55976acaf869b2f16d550012ffe5c2e804c31dadffab7d2a5b8ecb5b9eb148fd8c192c8a572428fa9d0c3a94291020abf2

data/README.md

@@ -126,6 +126,29 @@ The gem automatically registers Stimulus controllers and imports required JavaSc
 - `datatable` - Main DataTable controller
 - `filter` - Filter controller with state management
 
+## Overriding Default Configuration
+To override the default DataTables configuration, create a file at `app/javascript/datatables_config.js` with your custom settings or run rails generator:
+
+```bash
+rails generate stimulus_rails_datatables:install
+```
+
+Once created, you can pin it in your importmap configuration:
+
+```ruby
+# config/importmap.rb
+pin 'datatables_config', to: 'datatables_config.js'
+```
+
+Finally, import it in your application JavaScript:
+
+```javascript
+// app/javascript/application.js
+import 'datatables_config'
+```
+
+Note: You may need to restart your Rails server for changes to take effect.
+
 ## Dependencies
 
 - Rails >= 7.0

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

@@ -1,5 +1,10 @@
 import DataTable from 'datatables.net-responsive-bs5'
 
+// Set global DataTables default for orderSequence
+Object.assign(DataTable.defaults.column, {
+  orderSequence: ['desc', 'asc']
+})
+
 class AppDataTable {
   constructor(selector, options) {
     // Initialize the DataTable just like the original one

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

@@ -0,0 +1,44 @@
+// DataTables Configuration
+// Customize these settings to match your application's needs
+
+let datatablesConfig = {
+  // Language strings for DataTables UI
+  language: {
+    processing: '<div class="spinner-border"></div><div class="mt-2">Loading...</div>',
+    lengthMenu: 'show <span class="px-2">_MENU_</span> entries',
+    // Uncomment and customize any of these as needed:
+    // search: '_INPUT_',
+    // info: 'Showing _START_ to _END_ of _TOTAL_ entries',
+    // infoEmpty: 'Showing 0 to 0 of 0 entries',
+    // infoFiltered: '(filtered from _MAX_ total entries)',
+    // paginate: {
+    //   first: 'First',
+    //   last: 'Last',
+    //   next: 'Next',
+    //   previous: 'Previous'
+    // },
+    // emptyTable: 'No data available',
+    // zeroRecords: 'No matching records found'
+  },
+
+  // Default layout configuration
+  layout: {
+    topStart: 'pageLength',
+    topEnd: 'search',
+    bottomStart: 'info',
+    bottomEnd: 'paging'
+  },
+
+  // Length menu options
+  lengthMenu: [[10, 25, 50, 100], [10, 25, 50, 100]]
+}
+
+// Function to let the app override defaults
+export function setDatatablesConfig(overrideConfig) {
+  datatablesConfig = { ...datatablesConfig, ...overrideConfig };
+}
+
+// Function to read the config
+export function getDatatablesConfig() {
+  return datatablesConfig;
+}

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

@@ -3,6 +3,7 @@
 
 import { AppDataTable } from 'stimulus_rails_datatables/app_datatable'
 import { Controller } from '@hotwired/stimulus'
+import { getDatatablesConfig } from 'stimulus_rails_datatables/config'
 
 export default class extends Controller {
   static values = {
@@ -19,6 +20,8 @@ export default class extends Controller {
   }
 
   connect() {
+    this.datatablesConfig = getDatatablesConfig();
+
     // try to use saved filters if present, else listen for filters:ready
     const filterEl = document.querySelector('.filter-form[data-filter-root-key]')
     if (filterEl) {
@@ -79,7 +82,7 @@ export default class extends Controller {
     if (datatableWrapper === null) {
       Turbo.cache.exemptPageFromCache()
 
-      appDataTable = new AppDataTable(`#${datatableId}`, {
+      const options = {
         lengthMenu: [[10, 25, 50, 100], [10, 25, 50, 100]],
         searching: this.searchingValue,
         lengthChange: this.lengthChangeValue,
@@ -101,7 +104,18 @@ export default class extends Controller {
           bottomStart: 'info',
           bottomEnd: 'paging'
         }
-      })
+      }
+
+      // Add drawCallback to dispatch custom event
+      const appDataTable = new AppDataTable(`#${datatableId}`, options).table
+      if (appDataTable) {
+       appDataTable.on('draw', () => {
+          this.element.dispatchEvent(new CustomEvent('datatable:drawn', {
+            bubbles: true,
+            detail: { table: appDataTable }
+          }))
+        })
+      }
     }
 
     return appDataTable

data/config/importmap.rb

@@ -10,3 +10,4 @@ pin 'datatables.net-responsive-bs5', to: 'responsive.bootstrap5.min.js'
 pin 'stimulus_rails_datatables/app_datatable', to: 'stimulus_rails_datatables/app_datatable.js'
 pin 'stimulus_rails_datatables/datatables_controller', to: 'stimulus_rails_datatables/datatables_controller.js'
 pin 'stimulus_rails_datatables/filter_controller', to: 'stimulus_rails_datatables/filter_controller.js'
+pin 'stimulus_rails_datatables/config', to: 'stimulus_rails_datatables/config.js'

data/lib/generators/{nueca_datatables → stimulus_rails_datatables}/install/install_generator.rb

@@ -7,8 +7,8 @@ module StimulusRailsDatatables
 
       desc 'Creates StimulusRailsDatatables initializer for your application'
 
-      def copy_initializer
-        template 'stimulus_rails_datatables.rb', 'config/initializers/stimulus_rails_datatables.rb'
+      def copy_config
+        template 'datatables_config.js', 'app/javascript/datatables_config.js'
       end
 
       def show_readme
@@ -36,8 +36,15 @@ module StimulusRailsDatatables
         say "   application.register('filter', FilterController)"
         say "   window.AppDataTable = AppDataTable"
         say ''
-        say '3. Create your datatable classes inheriting from StimulusRailsDatatables::BaseDatatable'
-        say '4. Use the datatable_for and filter_for helpers in your views'
+        say '3. Customize app/javascript/datatables_config.js to override default settings'
+        say '4. Create your datatable classes inheriting from StimulusRailsDatatables::BaseDatatable'
+        say '5. Use the datatable_for and filter_for helpers in your views'
+        say ''
+        say 'To override the default configuration, edit app/javascript/datatables_config.js and the ff:'
+        say '1. pin it in config/importmap.rb if using importmap:'
+        say "   pin 'datatables_config', to: 'datatables_config.js'"
+        say '2. import and set the config in app/javascript/application.js:'
+        say "   import 'datatables_config'"
         say ''
         say 'For more information, see: https://github.com/denmarkmeralpis/stimulus_rails_datatables'
         say '=' * 80

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

@@ -0,0 +1,50 @@
+// Import the functions to set and get the config
+import { setDatatablesConfig } from 'stimulus_rails_datatables/config'
+
+// DataTables Configuration Override
+// Customize these settings to match your application's needs
+// This file overrides the default gem configuration
+export const datatablesConfig = {
+  // Language strings for DataTables UI
+  language: {
+    processing: '<div class="spinner-border"></div><div class="mt-2">Loading...</div>',
+    lengthMenu: 'show <span class="px-2">_MENU_</span> entries',
+
+    // Uncomment and customize any of these as needed:
+    // search: `<div class="ms-auto d-flex flex-wrap btn-list">
+    //           <div class="input-group input-group-flat w-auto" data-controller="kbd-focus">
+    //             <span class="input-group-text"><i class="material-symbols-outlined">search</i></span>
+    //             _INPUT_
+    //             <span class="input-group-text">
+    //               <kbd>ctrl + k</kbd>
+    //             </span>
+    //           </div>
+    //         </div>`,
+
+    // info: 'Showing _START_ to _END_ of _TOTAL_ entries',
+    // infoEmpty: 'Showing 0 to 0 of 0 entries',
+    // infoFiltered: '(filtered from _MAX_ total entries)',
+    // paginate: {
+    //   first: 'First',
+    //   last: 'Last',
+    //   next: 'Next',
+    //   previous: 'Previous'
+    // },
+    // emptyTable: 'No data available',
+    // zeroRecords: 'No matching records found'
+  },
+
+  // Default layout configuration
+  layout: {
+    topStart: 'pageLength',
+    topEnd: 'search',
+    bottomStart: 'info',
+    bottomEnd: 'paging'
+  },
+
+  // Length menu options
+  lengthMenu: [[10, 25, 50, 100], [10, 25, 50, 100]]
+}
+
+// Apply the custom configuration
+setDatatablesConfig(datatablesConfig)

data/lib/stimulus_rails_datatables/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stimulus_rails_datatables
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Den Meralpis
@@ -104,14 +104,15 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/stimulus_rails_datatables/app_datatable.js
+- app/assets/javascripts/stimulus_rails_datatables/config.js
 - app/assets/javascripts/stimulus_rails_datatables/datatables_controller.js
 - app/assets/javascripts/stimulus_rails_datatables/filter_controller.js
 - app/datatables/stimulus_rails_datatables/base_datatable.rb
 - app/helpers/stimulus_rails_datatables/datatable_helper.rb
 - app/helpers/stimulus_rails_datatables/filter_helper.rb
 - config/importmap.rb
-- lib/generators/nueca_datatables/install/install_generator.rb
-- lib/generators/nueca_datatables/install/templates/nueca_datatables.rb
+- lib/generators/stimulus_rails_datatables/install/install_generator.rb
+- lib/generators/stimulus_rails_datatables/install/templates/datatables_config.js
 - lib/stimulus_rails_datatables.rb
 - lib/stimulus_rails_datatables/engine.rb
 - lib/stimulus_rails_datatables/version.rb

data/lib/generators/nueca_datatables/install/templates/nueca_datatables.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-# StimulusRailsDatatables configuration
-#
-# This initializer is optional. The gem works out of the box with sensible defaults.
-# You can customize the behavior by uncommenting and modifying the options below.
-
-StimulusRailsDatatables.configure do |config|
-  # Configure default options for all datatables
-  # config.default_order = [[1, 'desc']]
-  # config.default_page_length = 25
-  # config.default_searching = true
-  # config.default_length_change = true
-
-  # Configure filter state persistence
-  # config.filter_state_key_prefix = 'filterState'
-  # config.filter_state_expires_in = 1.day
-end