The draggable
kit gives you a full subcomponent structure that allows it to be used with almost any kit.
initial_items
is a REQUIRED prop, which is the array of objects that contains data for the the draggable items.
draggable/draggable_container
= This specifies the container within which items can be dropped.
draggable/draggable_item
= This specifies the items that can be dragged and dropped. drag_id
is a REQUIRED prop for draggable_item and must match the id on the items within initial_items
.
<% initial_items = [ { id: "1", url: "https://unsplash.it/500/400/?image=633", }, { id: "2", url: "https://unsplash.it/500/400/?image=634", }, { id: "3", url: "https://unsplash.it/500/400/?image=637", }, ] %> <%= pb_rails("draggable", props: {initial_items: initial_items}) do %> <%= pb_rails("draggable/draggable_container") do %> <%= pb_rails("flex") do %> <% initial_items.each do |item| %> <%= pb_rails("draggable/draggable_item", props:{drag_id: item[:id]}) do %> <%= pb_rails("image", props: { alt: item[:id], size: "md", url: item[:url], margin: "xs" }) %> <% end %> <% end %> <% end %> <% end %> <% end %>
For a simplified version of the Draggable API for the List kit, you can do the following:
The List kit is optimized to work with the draggable kit. To enable drag, use the enable_drag
prop on List kit with an array of the included items AND drag_id
prop on ListItems. You will also need to include the items
prop containing your array of listed items for the Draggable API.
An additional optional boolean prop (set to true by default) of drag_handle
is also available on ListItem kit to show the drag handle icon.
<% initial_items = [ { id: "31", name: "Philadelphia" }, { id: "32", name: "New Jersey" }, { id: "33", name: "Maryland" }, { id: "34", name: "Connecticut" }, ] %> <%= pb_rails("list", props: { enable_drag: true, items: initial_items }) do %> <% initial_items.each do |item| %> <%= pb_rails("list/item", props:{drag_id: item[:id]}) do %><%= item[:name] %><% end %> <% end %> <% end %>
For a simplified version of the Draggable API for the SelectableList kit, you can do the following:
The SelectableList kit is optimized to work with the draggable kit. To enable drag, use the enable_drag
prop on SelectableList kit AND drag_id
prop within the SelectableList kit prop. An additional optional boolean prop (set to true by default) of drag_handle
is also available on SelectableList kit to show the drag handle icon.
<%= pb_rails("selectable_list", props: { enable_drag: true, variant: "radio", items: [ { drag_id: "41", text: "Task 1", input_options: { value: "1", name: "radio-name", } }, { drag_id: "42", text: "Task 2", checked: true, input_options: { value: "2", name: "radio-name", } }, { drag_id: "43", text: "Task 3", input_options: { value: "3", name: "radio-name", } }, { drag_id: "44", text: "Task 4", input_options: { value: "4", name: "radio-name", } } ] } ) %>
For a simplified version of the Draggable API for the Card kit, you can do the following:
Use the draggable
kit and manage state as shown.
draggable/draggable_container
kit creates the container within which the cards can be dragged and dropped.
The Card kit is optimized to work with the draggable kit. To enable drag, use the draggable_item
and drag_id
props on the Card kit as shown. An additional optional boolean prop (set to true by default) of drag_handle
is also available to show the drag handle icon.
<% initial_items = [ { id: "21", name: "Joe Black" }, { id: "22", name: "Nancy White" }, { id: "23", name: "Bill Green" }, ] %> <%= pb_rails("draggable", props: {initial_items: initial_items}) do %> <%= pb_rails("draggable/draggable_container") do %> <% initial_items.each do |item| %> <%= pb_rails("card", props: {highlight: {position: "side", color:"primary"}, margin_bottom: "xs", padding: "xs", drag_id: item[:id], draggable_item: true }) do %> <%= pb_rails("flex", props:{align_items: "stretch", flex_direction:"column"}) do %> <%= pb_rails("flex", props:{gap: "xs"}) do %> <%= pb_rails("title", props: { text: item[:name], tag: "h4", size: 4 }) %> <%= pb_rails("badge", props: {text:"35-12345" ,variant: "primary"}) %> <% end %> <%= pb_rails("caption", props: { size: "xs", text: "8:00A • Township Name • 90210" }) %> <%= pb_rails("flex", props:{gap: "xxs", spacing:"between"}) do %> <%= pb_rails("flex", props:{gap: "xxs"}) do %> <%= pb_rails("caption", props: { size: "xs" , color: "error" }) do %> <%= pb_rails("icon", props: { icon: "house-circle-exclamation", fixed_width: true }) %> <% end %> <%= pb_rails("caption", props: { size: "xs" , color: "success" }) do %> <%= pb_rails("icon", props: { icon: "file-circle-check", fixed_width: true }) %> <% end %> <% end %> <%= pb_rails("flex") do %> <%= pb_rails("badge", props: {text:"Schedule QA" ,variant: "warning", rounded: true}) %> <%= pb_rails("badge", props: {text:"Flex" ,variant: "primary", rounded: true}) %> <%= pb_rails("badge", props: {text:"R99" ,variant: "primary", rounded: true}) %> <% end %> <% end %> <% end %> <% end %> <% end %> <% end %> <% end %>
Props | Type | Values |
---|---|---|
gap |
array
|
none
xxs
xs
sm
md
lg
xl
|
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 |
---|---|---|---|
initial_items |
array
|