Search...

Draggable

Default

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 %>

Draggable with List Kit

Philadelphia

New Jersey

Maryland

Connecticut

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 %>

Draggable with SelectableList Kit

Task 1

Task 2

Task 3

Task 4

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",
              }
            }
          ]
        }
    )
%>

Draggable with Cards

Joe Black

35-12345

8:00A • Township Name • 90210

Schedule QA

Flex

R99

Nancy White

35-12345

8:00A • Township Name • 90210

Schedule QA

Flex

R99

Bill Green

35-12345

8:00A • Township Name • 90210

Schedule QA

Flex

R99

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 %>

Draggable with Table

id	name	task number
1	Terry Miles	Task 1
2	Sophia Miles	Task 2
3	Alice Jones	Task 3
4	Mike James	Task 4
5	James Guy	Task 5

The draggable kit can also be used in conjunction with the table kit to create draggable table rows. To do this:

use the draggable_container prop on the table/table_body to designate it as the Draggable Container
use the draggable_item prop on the table/table_row to designate it as the Draggable Item. Make sure to also pass id to the drag_id prop here.

<% initial_items = [
  {
    id: "1",
    title: "Task 1",
    assignee_name: "Terry Miles",
    assignee_img: "https://randomuser.me/api/portraits/men/44.jpg",
  },
  {
    id: "2",
    title: "Task 2",
    assignee_name: "Sophia Miles",
    assignee_img: "https://randomuser.me/api/portraits/women/8.jpg",
  },
  {
    id: "3",
    title: "Task 3",
    assignee_name: "Alice Jones",
    assignee_img: "https://randomuser.me/api/portraits/women/10.jpg",
  },
  {
    id: "4",
    title: "Task 4",
    assignee_name: "Mike James",
    assignee_img: "https://randomuser.me/api/portraits/men/8.jpg",
  },
  {
    id: "5",
    title: "Task 5",
    assignee_name: "James Guy",
    assignee_img: "https://randomuser.me/api/portraits/men/18.jpg",
  }
] %>

<%= pb_rails("draggable", props: {initial_items: initial_items}) do %>
  <%= pb_rails("table", props: { size: "sm", responsive:"none" }) do %>
    <%= pb_rails("table/table_head") do %>
      <%= pb_rails("table/table_row") do %>
        <%= pb_rails("table/table_header", props: { text: "id"}) %>
        <%= pb_rails("table/table_header", props: { text: "name"}) %>
        <%= pb_rails("table/table_header", props: { text: "task number"}) %>
      <% end %>
    <% end %>

    <%= pb_rails("table/table_body", props: {draggable_container: true}) do %>
      <% initial_items.each do |item| %>
        <%= pb_rails("table/table_row", props:{drag_id: item[:id], draggable_item: true}) do %>
          <%= pb_rails("table/table_cell", props: { text: item[:id]}) %>
          <%= pb_rails("table/table_cell") do %>
            <%= pb_rails("flex", props:{align:"center"}) do %>
              <%= pb_rails("avatar", props: {size: "xs", image_url: item[:assignee_img]}) %>
              <%= pb_rails("body", props: {text: item[:assignee_name], padding_left:"sm"}) %>
            <% end %>
          <% end %>
          <%= pb_rails("table/table_cell", props: { text: item[:title]}) %>
        <% end %>
      <% end %>
    <% end %>
  <% end %>
<% end %>

Dragging Across Multiple Containers

To Do

Task 1

Bug fixes

Task 2

Documentation

Task 4

Add jest tests

In Progress

Task 3

Add a variant

Task 6

Release

Done

Task 5

Alpha testing

The Draggable kit can also be used to achieve more complex, multiple container functionality as shown here. This complex usage requires the full subcomponent structure.

<% containers = [
  "To Do",
  "In Progress",
  "Done"
] %>

<% items_data = [
  {
    id: "11",
    container: "To Do",
    title: "Task 1",
    description: "Bug fixes",
    assignee_name: "Terry Miles",
    assignee_img: "https://randomuser.me/api/portraits/men/44.jpg",
  },
  {
    id: "12",
    container: "To Do",
    title: "Task 2",
    description: "Documentation",
    assignee_name: "Sophia Miles",
    assignee_img: "https://randomuser.me/api/portraits/women/8.jpg",
  },
  {
    id: "13",
    container: "In Progress",
    title: "Task 3",
    description: "Add a variant",
    assignee_name: "Alice Jones",
    assignee_img: "https://randomuser.me/api/portraits/women/10.jpg",
  },
  {
    id: "14",
    container: "To Do",
    title: "Task 4",
    description: "Add jest tests",
    assignee_name: "Mike James",
    assignee_img: "https://randomuser.me/api/portraits/men/8.jpg",
  },
  {
    id: "15",
    container: "Done",
    title: "Task 5",
    description: "Alpha testing",
    assignee_name: "James Guy",
    assignee_img: "https://randomuser.me/api/portraits/men/18.jpg",
  },
  {
    id: "16",
    container: "In Progress",
    title: "Task 6",
    description: "Release",
    assignee_name: "Sally Jones",
    assignee_img: "https://randomuser.me/api/portraits/women/28.jpg",
  },
] %>

<%= pb_rails("draggable", props: { initial_items: items_data }) do %>
  <%= pb_rails("flex", props: { justify_content: "center" }) do %>
    <% containers.each do |container| %>
      <%= pb_rails("draggable/draggable_container", props: {
          container: container,
          width: "xs",
          padding: "sm",
          data: { container: container }
      }) do %>
        <%= pb_rails("caption", props: { text_align: "center" }) do %><%= container %><% end %>
        <%= pb_rails("flex", props: {align_items: "stretch", orientation: "column"}) do %>
          <% items_data.select { |item| item[:container] == container }.each do |item| %>
            <%= pb_rails("draggable/draggable_item", props: {
                container: container,
                drag_id: item[:id]
            }) do %>
              <%= pb_rails("card", props: { margin_bottom: "sm", padding: "sm"}) do %>
                <%= pb_rails("flex", props: { justify: "between" }) do %>
                  <%= pb_rails("flex/flex_item") do %>
                    <%= pb_rails("flex") do %>
                      <%= pb_rails("avatar", props: {
                          image_url: item[:assignee_img],
                          name: item[:assignee_name],
                          size: "xxs"
                      }) %>
                      <%= pb_rails("title", props: {
                          padding_left: "xs",
                          size: 4,
                          text: item[:title]
                      }) %>
                    <% end %>
                  <% end %>
                <% end %>
                <%= pb_rails("body", props: { padding_top: "xs", text: item[:description] }) %>
              <% end %>
            <% end %>
          <% end %>
        <% end %>
      <% end %>
    <% end %>
  <% end %>
<% end %>

Draggable Drop Zones

Shadow

Task 1

Task 2

Task 3

Outline

Task 1

Task 2

Task 3

<% data_shadow = [
  { id: "51", text: "Task 1" },
  { id: "52", text: "Task 2" },
  { id: "53", text: "Task 3" }
] %>

<% data_outline = [
  { id: "61", text: "Task 1" },
  { id: "62", text: "Task 2" },
  { id: "63", text: "Task 3" }
] %>

<%= pb_rails("flex", props: { justify: "around" }) do %>
  <%= pb_rails("flex/flex_item", props: { margin_right: "xl" }) do %>
    <%= pb_rails("draggable", props: { drop_zone_type: "shadow", initial_items: data_shadow }) do %>
      <%= pb_rails("caption", props: { margin_bottom: "xs", text: "Shadow", text_align: "center" }) %>
      <%= pb_rails("draggable/draggable_container", props: { html_options: { style: { width: "200px" } } }) do %>
        <% data_shadow.each do |item| %>
          <%= pb_rails("card", props: { drag_id: item[:id], draggable_item: true, margin_bottom: "xs", padding: "xs", padding_right: "xl" }) do %>
            <%= pb_rails("flex", props: { align_items: "stretch", flex_direction: "column" }) do %>
              <%= pb_rails("body", props: { text: item[:text] }) %>
            <% end %>
          <% end %>
        <% end %>
      <% end %>
    <% end %>
  <% end %>

  <%= pb_rails("flex/flex_item", props: { margin_right: "xl" }) do %>
    <%= pb_rails("draggable", props: { drop_zone_type: "outline", initial_items: data_outline }) do %>
      <%= pb_rails("caption", props: { margin_bottom: "xs", text: "Outline", text_align: "center" }) %>
      <%= pb_rails("draggable/draggable_container", props: { html_options: { style: { width: "200px" } } }) do %>
        <% data_outline.each do |item| %>
          <%= pb_rails("card", props: { drag_id: item[:id], draggable_item: true, margin_bottom: "xs", padding: "xs", padding_right: "xl" }) do %>
            <%= pb_rails("flex", props: { align_items: "stretch", flex_direction: "column" }) do %>
              <%= pb_rails("body", props: { text: item[:text] }) %>
            <% end %>
          <% end %>
        <% end %>
      <% end %>
    <% end %>
  <% end %>
<% end %>

Draggable Drop Zones Colors

The default color for Draggable kit drop zones is "neutral", with "primary" or "purple" as additional options.

<% initial_items = [
  {
    id: "141",
    url: "https://unsplash.it/500/400/?image=633",
  },
  {
    id: "142",
    url: "https://unsplash.it/500/400/?image=634",
  },
  {
    id: "143",
    url: "https://unsplash.it/500/400/?image=637",
  },
] %>

<% next_init_items = [
  {
    id: "151",
    url: "https://unsplash.it/500/400/?image=633",
  },
  {
    id: "152",
    url: "https://unsplash.it/500/400/?image=634",
  },
  {
    id: "153",
    url: "https://unsplash.it/500/400/?image=637",
  },
] %>

<%= pb_rails("draggable", props: {initial_items: initial_items, drop_zone_type: "shadow", drop_zone_color: "primary"}) do %>
  <%= pb_rails("draggable/draggable_container") do %>
    <%= pb_rails("flex", props: { gap: "sm" }) 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] }) %>
        <% end %>
      <% end %>
    <% end %>
  <% end %>
<% end %>

<br/>

<%= pb_rails("draggable", props: {initial_items: next_init_items, drop_zone_type: "outline", drop_zone_color: "purple"}) do %>
  <%= pb_rails("draggable/draggable_container") do %>
    <%= pb_rails("flex", props: { gap: "sm" }) 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] }) %>
        <% end %>
      <% end %>
    <% end %>
  <% end %>
<% end %>

Draggable Event Listeners

You can add drag event listeners for drag, dragend, dragenter, dragleave, dragover, dragstart, and drop.

<% initial_items = [
  {
    id: "100",
    url: "https://unsplash.it/500/400/?image=638",
  },
  {
    id: "200",
    url: "https://unsplash.it/500/400/?image=639",
  },
  {
    id: "300",
    url: "https://unsplash.it/500/400/?image=640",
  },
] %>

<%= 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 %>

<script>
  const itemIds = ["item_100", "item_200", "item_300"];

  itemIds.forEach((id) => {
    const element = document.getElementById(id);
    if (element) {
      element.addEventListener("dragstart", (event) => {
        console.log(`${id} drag start!`);
      });
      element.addEventListener("dragend", (event) => {
        console.log(`${id} drag end!`);
      });
    }
  });
</script>

Available Props

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 grid
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
drop_zone_type	enum	ghost shadow outline line	ghost
drop_zone_color	enum	neutral primary purple	neutral

Contribute to Playbook

When you start designing a new feature, you may come across a Design Token or Component that isn’t defined in Playbook. If so, you should open an issue or reach out to the team to make a contribution.

Contribute on GitHub

As the highest-rated residential remodeler in the nation, our international technology team builds a custom suite of products that continuously transform our business.

Power

Tech @ Power

Open Positions

About Power

Connect

Dribbble

Github

Connect Chat

Draggable

Joe Black

Nancy White

Bill Green

Task 1

Task 2

Task 4

Task 3

Task 6

Task 5

Available Props

gap

max_width

min_width

width

z_index

number_spacing

shadow

line_height

display

cursor

flex_direction

flex_wrap

justify_content

justify_self

align_items

align_content

align_self

flex

flex_grow

flex_shrink

order

position

hover

border_radius

text_align

overflow

truncate

left

top

right

bottom

vertical_align

height

min_height

max_height

overflow_x

overflow_y

margin

margin_bottom

margin_left

margin_right

margin_top

margin_x

margin_y

padding

padding_bottom

padding_left

padding_right

padding_top

padding_x

padding_y

classname

dark

group_hover

id

data

aria

html_options

children

style

initial_items

drop_zone_type

drop_zone_color

Contribute to Playbook

Power

Connect