This component is available on GitHub.
Stimulus Checkbox Select All
A Stimulus controller for managing checkbox lists.
Video Tutorial
Chris Oliver from GoRails has released a presentation video on how to use this package with a real life example with Ruby on Rails.
π Take a look: Bulk Operations in Rails
Installation
$ yarn add stimulus-checkbox-select-all
And use it in your JS file:
// Probably in app/javascript/controllers/index.js
import { Application } from '@hotwired/stimulus'
import CheckboxSelectAll from 'stimulus-checkbox-select-all'
const application = Application.start()
application.register('checkbox-select-all', CheckboxSelectAll)
π Demo
See demo βUsage
Without Rails
<table data-controller="checkbox-select-all">
<tbody>
<td class="block">
<label>
<input type="checkbox" data-checkbox-select-all-target="checkboxAll" />
<span>Select All / Deselect All</span>
</label>
</td>
<td class="block">
<label>
<input type="checkbox" data-checkbox-select-all-target="checkbox" value="1" />
<span>Team 1</span>
</label>
</td>
<td class="block">
<label>
<input type="checkbox" data-checkbox-select-all-target="checkbox" checked="checked" value="2" />
<span>Team 2</span>
</label>
</td>
<td class="block">
<label>
<input type="checkbox" data-checkbox-select-all-target="checkbox" value="3" />
<span>Team 3</span>
</label>
</td>
</tbody>
</table>
With Rails
In your models:
class User < ApplicationRecord
has_many :teams
end
class Team < ApplicationRecord
belongs_to :user
end
In your controller:
class UsersController < ApplicationController
def update
if user.update(user_params)
redirect_to users_path
else
render :edit
end
end
private
def user_params
params
.require(:user)
.permit(
team_ids: []
)
end
end
In your view:
<%= form_with model: @user, data: { controller: 'checkbox-select-all' } do |f| %>
<label>
<input type="checkbox" data-checkbox-select-all-target="checkboxAll" />
<span>Select All / Deselect All</span>
</label>
<%= f.collection_check_boxes :team_ids, Team.all, :id, :name do |b| %>
<%= b.label do %>
<%= b.check_box data: { checkbox_select_all_target: 'checkbox' } %>
<%= b.text %>
<% end %>
<% end %>
<% end %>
π Extending Controller
You can use inheritance to extend the functionality of any Stimulus component:
import CheckboxSelectAll from 'stimulus-checkbox-select-all'
export default class extends CheckboxSelectAll {
connect() {
super.connect()
console.log('Do what you want here.')
// Get all checked checkboxes
this.checked
// Get all unchecked checkboxes
this.unchecked
}
}
This controller will automatically have access to targets defined in the parent class.
If you override the connect
, disconnect
or any other methods from the parent, you'll
want to call super.method()
to make sure the parent functionality is executed.
βοΈ Sponsors
Stimulus Component is an MIT licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support Stimulus Components development on Github Sponsors. π
π· Contributing
Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.
Donβt forget to drop a π on Github to support the project.
π License
This project is released under the MIT license.