stimulus_rails_datatables 0.3.2 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -0
  3. data/app/helpers/stimulus_rails_datatables/datatable_helper.rb +13 -7
  4. data/lib/generators/stimulus_rails_datatables/install/install_generator.rb +2 -2
  5. data/lib/stimulus_rails_datatables/version.rb +1 -1
  6. metadata +11 -11
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d508095bbb7cd25e12447b92081260fa8fa373f139be6b065c5eb6f17b3118af
4
- data.tar.gz: 9ae1b95a92a6898b2d2b6c55310f06dd7b8ca58902fb55d8f378d1a8605cf5ec
3
+ metadata.gz: 33857a74b843142081e2c836a7ca6b9ea3478b5de62c641397de780174b3365c
4
+ data.tar.gz: fc7ceebc44032ec83db84357e9472c981c011f927581d051c5ed75d9de2785a1
5
5
  SHA512:
6
- metadata.gz: fe105aa5f8bc6b0ffcc8bda21fe78c070d75c09b17a211d7e05a217a81ffcf680051e7cd2e5778f864d6735c191a63897ed25b2418e51e7fc9fea3fc14ece080
7
- data.tar.gz: c87088b4327210d783377c05291fcf5194f8ae0fcc523408f99d2e678b820fd2ca3c3d465879e9f423d782df255914ef2f6c5bc37f13e640e5430631d301f19f
6
+ metadata.gz: 496590e1f982a96b81f0c65e4ae6f577f82b9d59bb3a6638e294a3fbeff96d391e92552b1f352316e4864f3c8a70fe4846bf01ae6cd955f046818b111e88d0f7
7
+ data.tar.gz: 886217d0aab41163e3d282e80c9144ada0f4b025f190753ce95c76fbfb9294ea65791ee1b078f75391b5a0e38b1bef4b4d7d71b4857223969fe20415903cb752
data/README.md CHANGED
@@ -63,6 +63,20 @@ import 'datatables_config'
63
63
  <% end %>
64
64
  ```
65
65
 
66
+ #### Custom Header Content
67
+
68
+ Pass a block to render custom HTML in the column header instead of using `title:`.
69
+
70
+ ```ruby
71
+ <%= datatable_for 'users-table', source: users_path do |dt| %>
72
+ <% dt.column :name, title: 'Name' %>
73
+
74
+ <% dt.column class: 'text-center' do %>
75
+ <div>My Custom Div</div>
76
+ <% end %>
77
+ <% end %>
78
+ ```
79
+
66
80
  #### With Filters
67
81
 
68
82
  ```ruby
data/app/helpers/stimulus_rails_datatables/datatable_helper.rb CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  module StimulusRailsDatatables
4
4
  module DatatableHelper
5
- def datatable_for(id, source:, order: [[2, 'desc']], **options)
5
+ def datatable_for(id, source:, order: [[2, 'desc']], **options, &block)
6
6
  classes = options.fetch(:classes, 'align-middle table w-100')
7
7
  searching = options.fetch(:searching, true)
8
8
  length_change = options.fetch(:length_change, true)
@@ -10,14 +10,15 @@ module StimulusRailsDatatables
10
10
  responsive = options.fetch(:responsive, true)
11
11
  columns = []
12
12
 
13
- yield DatatableBuilder.new(columns)
13
+ capture(DatatableBuilder.new(self, columns), &block)
14
+ datatable_columns = columns.map { |column| column.reject { |key, _| key == :header_content } }
14
15
 
15
16
  data = {
16
17
  controller: 'datatable',
17
18
  datatable_id_value: id,
18
19
  datatable_source_value: source,
19
20
  datatable_order_value: order.to_json,
20
- datatable_columns_value: columns.to_json,
21
+ datatable_columns_value: datatable_columns.to_json,
21
22
  datatable_searching_value: searching,
22
23
  datatable_length_change_value: length_change,
23
24
  datatable_state_save_value: state_save,
@@ -29,7 +30,9 @@ module StimulusRailsDatatables
29
30
  content_tag(:thead, class: 'table-light align-middle') do
30
31
  content_tag(:tr) do
31
32
  safe_join(columns.map do |col|
32
- content_tag(:th, col[:title] || col[:data].to_s.titleize, class: col[:class])
33
+ header = col[:header_content] || col[:title] || col[:data].to_s.titleize
34
+
35
+ content_tag(:th, header, class: col[:class])
33
36
  end)
34
37
  end
35
38
  end
@@ -40,12 +43,15 @@ module StimulusRailsDatatables
40
43
  class DatatableBuilder
41
44
  attr_reader :columns
42
45
 
43
- def initialize(columns)
46
+ def initialize(view, columns)
47
+ @view = view
44
48
  @columns = columns
45
49
  end
46
50
 
47
- def column(data, **options)
48
- @columns << options.merge(data: data)
51
+ def column(data = nil, **options, &block)
52
+ header_content = @view.capture(&block) if block
53
+
54
+ @columns << options.merge(data: data, header_content: header_content).compact
49
55
  nil
50
56
  end
51
57
  end
data/lib/generators/stimulus_rails_datatables/install/install_generator.rb CHANGED
@@ -17,7 +17,7 @@ module StimulusRailsDatatables
17
17
 
18
18
  private
19
19
 
20
- def readme(filename)
20
+ def readme(_filename)
21
21
  say ''
22
22
  say '=' * 80
23
23
  say 'StimulusRailsDatatables has been installed!'
@@ -34,7 +34,7 @@ module StimulusRailsDatatables
34
34
  say ''
35
35
  say " application.register('datatable', DatatableController)"
36
36
  say " application.register('filter', FilterController)"
37
- say " window.AppDataTable = AppDataTable"
37
+ say ' window.AppDataTable = AppDataTable'
38
38
  say ''
39
39
  say '3. Import app/javascript/datatables_config.js in your application.js:'
40
40
  say ''
data/lib/stimulus_rails_datatables/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module StimulusRailsDatatables
4
- VERSION = '0.3.2'
4
+ VERSION = '0.4.0'
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: stimulus_rails_datatables
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.2
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Den Meralpis
@@ -24,45 +24,45 @@ dependencies:
24
24
  - !ruby/object:Gem::Version
25
25
  version: '1.4'
26
26
  - !ruby/object:Gem::Dependency
27
- name: rails
27
+ name: importmap-rails
28
28
  requirement: !ruby/object:Gem::Requirement
29
29
  requirements:
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: '7.0'
32
+ version: '2'
33
33
  - - "<"
34
34
  - !ruby/object:Gem::Version
35
- version: '8.3'
35
+ version: '3'
36
36
  type: :runtime
37
37
  prerelease: false
38
38
  version_requirements: !ruby/object:Gem::Requirement
39
39
  requirements:
40
40
  - - ">="
41
41
  - !ruby/object:Gem::Version
42
- version: '7.0'
42
+ version: '2'
43
43
  - - "<"
44
44
  - !ruby/object:Gem::Version
45
- version: '8.3'
45
+ version: '3'
46
46
  - !ruby/object:Gem::Dependency
47
- name: importmap-rails
47
+ name: rails
48
48
  requirement: !ruby/object:Gem::Requirement
49
49
  requirements:
50
50
  - - ">="
51
51
  - !ruby/object:Gem::Version
52
- version: '2'
52
+ version: '7.0'
53
53
  - - "<"
54
54
  - !ruby/object:Gem::Version
55
- version: '3'
55
+ version: '8.3'
56
56
  type: :runtime
57
57
  prerelease: false
58
58
  version_requirements: !ruby/object:Gem::Requirement
59
59
  requirements:
60
60
  - - ">="
61
61
  - !ruby/object:Gem::Version
62
- version: '2'
62
+ version: '7.0'
63
63
  - - "<"
64
64
  - !ruby/object:Gem::Version
65
- version: '3'
65
+ version: '8.3'
66
66
  - !ruby/object:Gem::Dependency
67
67
  name: rspec-rails
68
68
  requirement: !ruby/object:Gem::Requirement