Default

Select...

United States

Canada

Pakistan

This kit's options prop requires an array of objects, each of which will be used as the selectable options within the dropdown. Each option object can support any number of key-value pairs, but each must contain label and value.

<% 
  options = [
    { label: 'United States', value: 'United States', id: 'us' },
    { label: 'Canada', value: 'Canada', id: 'ca' },
    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
  ]

%>

<%= pb_rails("dropdown", props: {options: options}) %>

Autocomplete

United States

United Kingdom

Pakistan

The autocomplete prop can be used to add autocomplete or typeahead functionality to the Dropdown's default Trigger. This prop is set to 'false' by default.

<% 
  options = [
    {
      label: "United States",
      value: "United States",
      areaCode: "+1",
      icon: "🇺🇸",
      id: "us"
    },
    {
      label: "United Kingdom",
      value: "United Kingdom",
      areaCode: "+44",
      icon: "🇬🇧", 
      id: "gb"
    },
    {
      label: "Pakistan",
      value: "Pakistan",
      areaCode: "+92",
      icon: "🇵🇰",
      id: "pk"
    }
  ]

%>

<%= pb_rails("dropdown", props: {options: options, autocomplete: true}) %>

Subtle Variant

Select...

United States

Canada

Pakistan

For the subtle variant, it is recommended that you set the Separators prop to false to remove the separator lines between the options for a cleaner look.

<% 
  options = [
    { label: 'United States', value: 'United States', id: 'us' },
    { label: 'Canada', value: 'Canada', id: 'ca' },
    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
  ]

%>

<%= pb_rails("dropdown", props: { options: options, variant: "subtle", separators: false }) %>

Subcomponent Structure

Select...

United States

Canada

Pakistan

The dropdown is built using all of the following required subcomponents:

dropdown/dropdown_trigger is the UI component that users interact with to toggle the dropdown.
dropdown/dropdown_container is the floating container that wraps the list of dropdown options.
dropdown/dropdown_option renders options that are passed to the container.
Each of these subcomponents can be altered using global props and/or their respective props. See doc examples below for more information on each.

<% 
  options = [
    { label: 'United States', value: 'United States', id: 'us' },
    { label: 'Canada', value: 'Canada', id: 'ca' },
    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
  ]

%>

<%= pb_rails("dropdown", props: {options: options}) do %>
    <%= pb_rails("dropdown/dropdown_trigger") %>
    <%= pb_rails("dropdown/dropdown_container") do %>
        <% options.each do |option| %>
            <%= pb_rails("dropdown/dropdown_option", props: {option: option}) %>
        <% end %>
    <% end %>
<% end %>

Autocomplete with Subcomponent Structure

Jasper Furniss

PHL • Lead UX Engineer

Offline

Ramon Ruiz

PHL • Senior UX Designer

Away

Carlos Lima

PHL • Nitro Developer

Online

Courtney Long

PHL • Lead UX Designer

Online

autocomplete prop can also be used in conjunction with the subcomponent structure.

<% 
   options = [
    {
      label: "Jasper Furniss",
      value: "Jasper Furniss",
      territory: "PHL",
      title: "Lead UX Engineer",
      id: "jasper-furniss",
      status: "Offline"
    },
    {
      label: "Ramon Ruiz",
      value: "Ramon Ruiz",
      territory: "PHL",
      title: "Senior UX Designer",
      id: "ramon-ruiz",
      status: "Away"
    },
    {
      label: "Carlos Lima",
      value: "Carlos Lima",
      territory: "PHL",
      title: "Nitro Developer",
      id: "carlos-lima",
      status: "Online"
    },
    {
      label: "Courtney Long",
      value: "Courtney Long",
      territory: "PHL",
      title: "Lead UX Designer",
      id: "courtney-long",
      status: "Online"
    }
  ];

%>

<%= pb_rails("dropdown", props: {options: options}) do %>
    <%= pb_rails("dropdown/dropdown_trigger", props: {placeholder: "Search...", autocomplete: true}) %>
    <%= pb_rails("dropdown/dropdown_container") do %>
        <% options.each do |option| %>
            <%= pb_rails("dropdown/dropdown_option", props: {option: option}) do %>
              <%= pb_rails("flex", props: {
                align: "center",
                justify: "between",
                }) do %>
                  <%= pb_rails("flex/flex_item") do %>
                      <%= pb_rails("user", props: {name: option[:label], align:"left", avatar: true, orientation:"horizontal", territory:option[:territory], title: option[:title]}) %>
                  <% end %>
                  <%= pb_rails("flex/flex_item") do %>
                      <%= pb_rails("badge", props: {rounded: true, dark: true, text: option[:status], variant: option[:status] == "Offline" ? "neutral" : option[:status] == "Online" ? "success" : "warning" }) %>
                  <% end %>
              <% end %>
            <% end %>
        <% end %>
    <% end %>
<% end %>

With Label

Select a Country

Select...

United States

Canada

Pakistan

The top-level Dropdown component optionally accepts any string through a label prop to produce a label above your trigger element.

<% 
  options = [
    { label: 'United States', value: 'United States', id: 'us' },
    { label: 'Canada', value: 'Canada', id: 'ca' },
    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
  ]

%>

<%= pb_rails("dropdown", props: {options: options, label: "Select a Country"}) %>

Custom Options

Select...

🇺🇸

United States

🇨🇦

Canada

🇵🇰

Pakistan

+92

dropdown/dropdown_option subcomponent accepts any child components to customize the options' contents and display. By default, options are Body kit text that is set by the label value from the option object.

<% 
  options = [
    {
      label: "United States",
      value: "United States",
      areaCode: "+1",
      icon: "🇺🇸",
      id: "us"
    },
    {
      label: "Canada",
      value: "Canada",
      areaCode: "+1",
      icon: "🇨🇦",
      id: "ca"
    },
    {
      label: "Pakistan",
      value: "Pakistan",
      areaCode: "+92",
      icon: "🇵🇰",
      id: "pk"
    }
  ]

%>

<%= pb_rails("dropdown", props: {options: options}) do %>
    <%= pb_rails("dropdown/dropdown_trigger") %>
    <%= pb_rails("dropdown/dropdown_container") do %>
        <% options.each do |option| %>
            <%= pb_rails("dropdown/dropdown_option", props: {option: option}) do %>
              <%= pb_rails("flex", props: {
                align: "center",
                justify: "between",
                }) do %>
                  <%= pb_rails("flex/flex_item") do %>
                      <%= pb_rails("flex") do %>
                          <%= pb_rails("icon", props: {icon: option[:icon]}) %>
                          <%= pb_rails("body", props: {text: option[:label], padding_left:"xs"}) %>
                      <% end %>
                  <% end %>
                  <%= pb_rails("flex/flex_item") do %>
                      <%= pb_rails("body", props: {color:"light", text: option[:areaCode]}) %>
                  <% end %>
                <% end %>
            <% end %>
        <% end %>
    <% end %>
<% end %>

Custom Display

Select a User

Jasper Furniss

PHL • Lead UX Engineer

Offline

Ramon Ruiz

PHL • Senior UX Designer

Away

Carlos Lima

PHL • Nitro Developer

Online

Courtney Long

PHL • Lead UX Designer

Online

Optionally utilize custom_display on the dropdown/dropdown_trigger subcomponent to customize its content after an option is selected. The component passed to custom_display will be rendered to the left of the default text-based display. In this example the Avatar kit is being used.

The placeholder prop can also be used to customize the placeholder text for the default dropdown/dropdown_trigger.

The dropdown follows the typical rails pattern of utilizing hidden inputs for form submission. The hidden input value is the selected options' id.

<% 
   options = [
    {
      label: "Jasper Furniss",
      value: "Jasper Furniss",
      territory: "PHL",
      title: "Lead UX Engineer",
      id: "jasper-furniss",
      status: "Offline"
    },
    {
      label: "Ramon Ruiz",
      value: "Ramon Ruiz",
      territory: "PHL",
      title: "Senior UX Designer",
      id: "ramon-ruiz",
      status: "Away"
    },
    {
      label: "Carlos Lima",
      value: "Carlos Lima",
      territory: "PHL",
      title: "Nitro Developer",
      id: "carlos-lima",
      status: "Online"
    },
    {
      label: "Courtney Long",
      value: "Courtney Long",
      territory: "PHL",
      title: "Lead UX Designer",
      id: "courtney-long",
      status: "Online"
    }
  ];

%>

<%
  custom_display = capture do
    pb_rails("avatar", props: { name: "Courtney Long", size: "xs" })
  end
%>

<%= pb_rails("dropdown", props: {options: options}) do %>
    <%= pb_rails("dropdown/dropdown_trigger", props: {placeholder: "Select a User", custom_display: custom_display}) %>
    <%= pb_rails("dropdown/dropdown_container") do %>
        <% options.each do |option| %>
            <%= pb_rails("dropdown/dropdown_option", props: {option: option}) do %>
              <%= pb_rails("flex", props: {
                align: "center",
                justify: "between",
                }) do %>
                  <%= pb_rails("flex/flex_item") do %>
                      <%= pb_rails("user", props: {name: option[:label], align:"left", avatar: true, orientation:"horizontal", territory:option[:territory], title: option[:title]}) %>
                  <% end %>
                  <%= pb_rails("flex/flex_item") do %>
                      <%= pb_rails("badge", props: {rounded: true, dark: true, text: option[:status], variant: option[:status] == "Offline" ? "neutral" : option[:status] == "Online" ? "success" : "warning" }) %>
                  <% end %>
              <% end %>
            <% end %>
        <% end %>
    <% end %>
<% end %>

Custom Trigger

🇺🇸

United States

🇨🇦

Canada

🇵🇰

Pakistan

+92

Optionally replace the default trigger's select element by passing child components directly to the dropdown/dropdown_trigger.

<% 
  options = [
    {
      label: "United States",
      value: "United States",
      areaCode: "+1",
      icon: "🇺🇸",
      id: "us"
    },
    {
      label: "Canada",
      value: "Canada",
      areaCode: "+1",
      icon: "🇨🇦",
      id: "ca"
    },
    {
      label: "Pakistan",
      value: "Pakistan",
      areaCode: "+92",
      icon: "🇵🇰",
      id: "pk"
    }
  ]

%>

<%= pb_rails("dropdown", props: {options: options}) do %>
    <%= pb_rails("dropdown/dropdown_trigger") do %>
        <%= pb_rails("icon_circle", props: {icon:"flag", cursor: "pointer", variant:"royal"}) %>
    <% end %>
    <%= pb_rails("dropdown/dropdown_container", props:{max_width:"xs"}) do %>
        <% options.each do |option| %>
            <%= pb_rails("dropdown/dropdown_option", props: {option: option}) do %>
              <%= pb_rails("flex", props: {
                align: "center",
                justify: "between",
                }) do %>
                <%= pb_rails("flex/flex_item") do %>
                      <%= pb_rails("flex") do %>
                          <%= pb_rails("icon", props: {icon: option[:icon]}) %>
                          <%= pb_rails("body", props: {text: option[:label], padding_left:"xs"}) %>
                      <% end %>
                  <% end %>
                  <%= pb_rails("flex/flex_item") do %>
                      <%= pb_rails("body", props: {color:"light", text: option[:areaCode]}) %>
                  <% end %>
              <% end %>
            <% end %>
        <% end %>
    <% end %>
<% end %>

Custom Trigger Dropdown with Search

🇺🇸

United States

🇬🇧

United Kingdom

+44

🇵🇰

Pakistan

+92

The optional searchbar boolean prop can also be used on the dropdown/dropdown_container to render a searchbar with typeahead functionality within the dropdown itself. This is especially useful when a custom trigger is being used.
searchbar is set to false by default.

<% 
  options = [
    {
      label: "United States",
      value: "United States",
      areaCode: "+1",
      icon: "🇺🇸",
      id: "us"
    },
    {
      label: "United Kingdom",
      value: "United Kingdom",
      areaCode: "+44",
      icon: "🇬🇧",
      id: "gb"
    },
    {
      label: "Pakistan",
      value: "Pakistan",
      areaCode: "+92",
      icon: "🇵🇰",
      id: "pk"
    }
  ]

%>

<%= pb_rails("dropdown", props: {options: options}) do %>
    <%= pb_rails("dropdown/dropdown_trigger") do %>
        <%= pb_rails("icon_circle", props: {icon:"flag", cursor: "pointer", variant:"royal"}) %>
    <% end %>
    <%= pb_rails("dropdown/dropdown_container", props:{max_width:"xs", searchbar: true}) do %>
        <% options.each do |option| %>
            <%= pb_rails("dropdown/dropdown_option", props: {option: option}) do %>
              <%= pb_rails("flex", props: {
                align: "center",
                justify: "between",
                }) do %>
                <%= pb_rails("flex/flex_item") do %>
                      <%= pb_rails("flex") do %>
                          <%= pb_rails("icon", props: {icon: option[:icon]}) %>
                          <%= pb_rails("body", props: {text: option[:label], padding_left:"xs"}) %>
                      <% end %>
                  <% end %>
                  <%= pb_rails("flex/flex_item") do %>
                      <%= pb_rails("body", props: {color:"light", text: option[:areaCode]}) %>
                  <% end %>
              <% end %>
            <% end %>
        <% end %>
    <% end %>
<% end %>

Custom Option Padding

Select...

United States

Canada

Pakistan

By default, dropdown option paddingX is set to sm and paddingY is set to xs, but this padding can be overridden using our global padding props. In this example we are setting the option padding to sm all around.

<% 
  options = [
    { label: 'United States', value: 'United States', id: 'us' },
    { label: 'Canada', value: 'Canada', id: 'ca' },
    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
  ]

%>

<%= pb_rails("dropdown", props: {options: options}) do %>
    <%= pb_rails("dropdown/dropdown_trigger") %>
    <%= pb_rails("dropdown/dropdown_container") do %>
        <% options.each do |option| %>
            <%= pb_rails("dropdown/dropdown_option", props: {option: option, padding:"sm"}) %>
        <% end %>
    <% end %>
<% end %>

Dropdown with Error

Select...

United States

Canada

Pakistan

Please make a valid selection

<%
  options = [
    { label: 'United States', value: 'United States', id: 'us' },
    { label: 'Canada', value: 'Canada', id: 'ca' },
    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
  ]
%>

<%= pb_rails("dropdown", props: {
  error: raw(pb_rails("icon", props: { icon: "warning" }) + " Please make a valid selection"),
  options: options
}) %>

Default Value

Select...

United States

Canada

Pakistan

<% 
  options = [
    { label: 'United States', value: 'United States', id: 'us' },
    { label: 'Canada', value: 'Canada', id: 'ca' },
    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
  ]

%>

<%= pb_rails("dropdown", props: {options: options, default_value: options.last}) %>

Blank Selection

Select...

Select One...

United States

Canada

Pakistan

<% 
  options = [
    { label: 'United States', value: 'United States', id: 'us' },
    { label: 'Canada', value: 'Canada', id: 'ca' },
    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
  ]

%>

<%= pb_rails("dropdown", props: { blank_selection: "Select One...", options: options }) %>

Separators Hidden

Select...

United States

Canada

Pakistan

<% 
  options = [
    { label: 'United States', value: 'United States', id: 'us' },
    { label: 'Canada', value: 'Canada', id: 'ca' },
    { label: 'Pakistan', value: 'Pakistan', id: 'pk' },
  ]

%>
<%= pb_rails("dropdown", props: {options: options, separators: false}) %>

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
options	array
label	string
name	string
error	string
required	boolean		false
default_value	string
blank_selection	string
variant	enum	default subtle	default
separators	boolean		true
autocomplete	boolean		false
searchbar	boolean		false

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

Dropdown

Jasper Furniss

Ramon Ruiz

Carlos Lima

Courtney Long

Jasper Furniss

Ramon Ruiz

Carlos Lima

Courtney Long

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

options

label

name

error

required

default_value

blank_selection

variant

separators

autocomplete