Checkbox is used for a list of selections that are meant to have one or more options checked.
<% checkboxes = [ { name: 'Coffee', id: 'coffee', checked: false }, { name: 'Ice Cream', id: 'ice-cream', checked: false }, { name: 'Chocolate', id: 'chocolate', checked: true } ] %> <%= pb_rails("table", props: { container: false, size: "md" }) do %> <thead> <tr> <th> <%= pb_rails("checkbox", props: { checked: true, text: "Uncheck All", value: "checkbox-value", name: "main-checkbox", indeterminate: true, id: "indeterminate-checkbox" }) %> </th> </tr> </thead> <tbody> <% checkboxes.each do |checkbox| %> <tr> <td> <%= pb_rails("checkbox", props: { checked: checkbox[:checked], text: checkbox[:name], value: checkbox[:id], name: "#{checkbox[:id]}-indeterminate-checkbox", id: "#{checkbox[:id]}-indeterminate-checkbox", }) %> </td> </tr> <% end %> </tbody> <% end %> <script> document.addEventListener('DOMContentLoaded', function() { const mainCheckboxWrapper = document.getElementById('indeterminate-checkbox'); const mainCheckbox = document.getElementsByName("main-checkbox")[0]; const childCheckboxes = document.querySelectorAll('input[type="checkbox"][id$="indeterminate-checkbox"]'); const updateMainCheckbox = () => { // Count the number of checked child checkboxes const checkedCount = Array.from(childCheckboxes).filter(cb => cb.checked).length; // Determine if the main checkbox should be in an indeterminate state const indeterminate = checkedCount > 0 && checkedCount < childCheckboxes.length; // Set the main checkbox states mainCheckbox.indeterminate = indeterminate; mainCheckbox.checked = checkedCount > 0; // Determine the main checkbox label based on the number of checked checkboxes const text = checkedCount === 0 ? 'Check All' : 'Uncheck All'; // Determine the icon class to add and remove based on the number of checked checkboxes const iconClassToAdd = checkedCount === 0 ? 'pb_checkbox_checkmark' : 'pb_checkbox_indeterminate'; const iconClassToRemove = checkedCount === 0 ? 'pb_checkbox_indeterminate' : 'pb_checkbox_checkmark'; // Update main checkbox label mainCheckboxWrapper.getElementsByClassName('pb_body_kit')[0].textContent = text; // Add and remove the icon class to the main checkbox wrapper mainCheckboxWrapper.querySelector('[data-pb-checkbox-icon-span]').classList.add(iconClassToAdd); mainCheckboxWrapper.querySelector('[data-pb-checkbox-icon-span]').classList.remove(iconClassToRemove); // Toggle the visibility of the checkbox icon based on the indeterminate state mainCheckboxWrapper.getElementsByClassName("indeterminate_icon")[0].classList.toggle('hidden', !indeterminate); mainCheckboxWrapper.getElementsByClassName("check_icon")[0].classList.toggle('hidden', indeterminate); }; mainCheckbox.addEventListener('change', function() { childCheckboxes.forEach(cb => cb.checked = this.checked); updateMainCheckbox(); }); childCheckboxes.forEach(cb => { cb.addEventListener('change', updateMainCheckbox); }); }); </script>
<%= pb_rails("flex", props: {orientation: "column"}) do %> <%= pb_rails("flex/flex_item") do %> <%= pb_rails("checkbox" , props: { input_options: { tabindex: 0 }, margin_bottom: "xs", text: "Disabled unchecked", value: "checkbox-value", disabled: true, name: "checkbox-name" }) %> <% end %> <%= pb_rails("flex/flex_item") do %> <%= pb_rails("checkbox" , props: { input_options: { tabindex: 0 }, text: "Disabled checked", value: "checkbox-value", disabled: true, checked: true, name: "checkbox-name" }) %> <% end %> <% end %>
Props | Type | Values |
---|---|---|
max_width |
array
|
0%
xs
sm
md
lg
xl
xxl
0
none
100%
|
min_width |
array
|
0%
xs
sm
md
lg
xl
xxl
0
none
100%
|
width |
array
|
0%
xs
sm
md
lg
xl
xxl
0
none
100%
|
z_index |
array
|
1
2
3
4
5
6
7
8
9
10
|
number_spacing |
array
|
tabular
|
shadow |
array
|
none
deep
deeper
deepest
|
line_height |
array
|
tightest
tighter
tight
normal
loose
looser
loosest
|
display |
array
|
block
inline_block
inline
flex
inline_flex
none
|
cursor |
array
|
auto
default
none
contextMenu
help
pointer
progress
wait
cell
crosshair
text
verticalText
alias
copy
move
noDrop
notAllowed
grab
grabbing
eResize
nResize
neResize
nwResize
sResize
seResize
swResize
wResize
ewResize
nsResize
neswResize
nwseResize
colResize
rowResize
allScroll
zoomIn
zoomOut
|
flex_direction |
array
|
row
column
rowReverse
columnReverse
|
flex_wrap |
array
|
wrap
nowrap
wrapReverse
|
justify_content |
array
|
start
end
center
spaceBetween
spaceAround
spaceEvenly
|
justify_self |
array
|
auto
start
end
center
stretch
|
align_items |
array
|
flexStart
flexEnd
start
end
center
baseline
stretch
|
align_content |
array
|
start
end
center
spaceBetween
spaceAround
spaceEvenly
|
align_self |
array
|
auto
start
end
center
stretch
baseline
|
flex |
array
|
auto
initial
0
1
2
3
4
5
6
7
8
9
10
11
12
none
|
flex_grow |
array
|
1
0
|
flex_shrink |
array
|
1
0
|
order |
array
|
1
2
3
4
5
6
7
8
9
10
11
12
|
position |
array
|
relative
absolute
fixed
sticky
|
hover |
array
|
|
border_radius |
array
|
none
xs
sm
md
lg
xl
rounded
|
text_align |
array
|
start
end
left
right
center
justify
justify-all
match-parent
|
overflow |
array
|
visible
hidden
scroll
auto
|
truncate |
array
|
1
2
3
4
5
|
left |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
top |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
right |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
bottom |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
vertical_align |
array
|
baseline
super
top
middle
bottom
sub
text-top
text-bottom
|
height |
array
|
auto
xs
sm
md
lg
xl
xxl
xxxl
|
min_height |
array
|
auto
xs
sm
md
lg
xl
xxl
xxxl
|
max_height |
array
|
auto
xs
sm
md
lg
xl
xxl
xxxl
|
overflow_x |
array
|
visible
hidden
scroll
auto
|
overflow_y |
array
|
visible
hidden
scroll
auto
|
margin |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_bottom |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_left |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_right |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_top |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_x |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_y |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_bottom |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_left |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_right |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_top |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_x |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_y |
array
|
none
xxs
xs
sm
md
lg
xl
|
classname |
string
|
|
dark |
boolean
|
|
group_hover |
boolean
|
|
id |
string
|
|
data |
hashprop
|
|
aria |
hashprop
|
|
html_options |
hashprop
|
|
children |
proc
|
|
style |
hashprop
|
Props | Type | Values | Default |
---|---|---|---|
error |
boolean
|
false
|
|
checked |
boolean
|
false
|
|
indeterminate |
boolean
|
false
|
|
text |
string
|
||
value |
string
|
||
name |
string
|
||
disabled |
boolean
|
false
|
|
input_options |
hashprop
|
||
required |
boolean
|
false
|
|
form_spacing |
boolean
|
false
|