Select

Select displays multiple options for a user to pick from in a dropdown menu. User selects one option.

Summary

Default

Favorite Food

<%= pb_rails("select", props: {
  label: "Favorite Food",
  name: "food",
  options: [
    {
      value: "1",
      value_text: "Burgers",
    },
    {
      value: "2",
      selected: true,
      value_text: "Pizza",
    },
    {
      value: "3",
      value_text: "Tacos",
    },
    {
      value: "4",
      value_text: "BBQ",
    },
  ]
}) %>

Blank Selection Text

Where do you live

<%= pb_rails("select", props: {
  label: "Where do you live",
  name: "location",
  blank_selection: "Select One...",
  options: [
    {
      value: "USA",
    },
    {
      value: "Canada",
    },
    {
      value: "Brazil",
    },
    {
      value: "Philippines",
    },
  ]
}) %>

Disabled Options

Favorite Coffee

<%= pb_rails("select", props: {
  label: "Favorite Coffee",
  name: "coffee",
  options: [
    {
      value: "1",
      disabled: true,
      value_text: "Espresso",
    },
    {
      value: "2",
      selected: true,
      value_text: "Americano",
    },
    {
      value: "3",
      disabled: true,
      value_text: "Cappuccino",
    },
    {
      value: "4",
      value_text: "Mocha",
    },
    {
      value: "5",
      value_text: "Flat White",
    },
    {
      value: "6",
      value_text: "Latte",
    },
  ]
}) %>

Disabled Select Field

Favorite Dessert

<%= pb_rails("select", props: {
  label: "Favorite Dessert",
  disabled: true,
  name: "dessert",
  options: [
    {
      value: "Apple Pie",
    },
    {
      value: "Cookies",
    },
    {
      value: "Ice Cream",
    },
    {
      value: "Brownies",
    },
  ]
}) %>

Required Select Field

Which shoe do you tie first?

<%= pb_rails("select", props: {
  label: "Which shoe do you tie first?",
  required: true,
  name: "shoe",
  blank_selection: "Select One...",
  options: [
    {
      value: "Left",
    },
    {
      value: "Right",
    },
    {
      value: "I go without laces",
    },
  ]
}) %>

Equal option value and value text

Favorite Sport

<%= pb_rails("select", props: {
  label: "Favorite Sport",
  name: "sports",
  options: [
    {
      value: "Football",
    },
    {
      value: "Baseball",
    },
    {
      value: "Basketball",
    },
    {
      value: "Hockey",
    },
  ]
}) %>

Custom Select

Favorite Holiday

<%= pb_rails("select", props: { label: "Favorite Holiday" }) do %>
  <select name="holiday" id="holiday">
    <option value="1">Christmas</option>
    <option value="2">Thanksgiving</option>
    <option value="3">Halloween</option>
    <option value="4">Fourth of July</option>
  </select>
<% end %>

Select w/ Error

Favorite Food

Please make a valid selection

Select w/ Error shows that the radio option must be selected or is invalid (ie when used in a form it signals a user to fix an error).

<%= pb_rails("select", props: {
  error: "Please make a valid selection",
  label: "Favorite Food",
  name: "food",
  options: [
    {
      value: "1",
      value_text: "Burgers",
    },
    {
      value: "2",
      selected: true,
      value_text: "Pizza",
    },
    {
      value: "3",
      value_text: "Tacos",
    },
    {
      value: "4",
      value_text: "BBQ",
    },
  ]
}) %>

Select Inline

Favorite Food

<%= pb_rails("select", props: {
  label: "Favorite Food",
  name: "food",
  inline: true,
  options: [
    {
      value: "1",
      value_text: "Burgers",
    },
    {
      value: "2",
      value_text: "Pizza",
    },
    {
      value: "3",
      value_text: "Tacos",
    },
    {
      value: "4",
      value_text: "BBQ",
    },
  ]
}) %>

Select Inline (Always Show Arrow)

Favorite Food

<%= pb_rails("select", props: {
  label: "Favorite Food",
  name: "food",
  inline: true,
  options: [
    {
      value: "1",
      value_text: "Burgers",
    },
    {
      value: "2",
      value_text: "Pizza",
    },
    {
      value: "3",
      value_text: "Tacos",
    },
    {
      value: "4",
      value_text: "BBQ",
    },
  ],
  show_arrow: true
}) %>

Select Inline Compact

Favorite Food

<%= pb_rails("select", props: {
  label: "Favorite Food",
  name: "food",
  inline: true,
  compact: true,
  options: [
    {
      value: "1",
      value_text: "Burgers",
    },
    {
      value: "2",
      value_text: "Pizza",
    },
    {
      value: "3",
      value_text: "Tacos",
    },
    {
      value: "4",
      value_text: "BBQ",
    },
  ]
}) %>

Select W/ Attributes

Favorite Food

Inspect the element and notice the data-attribute being added to the <select> element

<%= pb_rails("select", props: {
  attributes: {
    data: { options: "data_attribute" },
  },
  label: "Favorite Food",
  name: "food",
  options: [
    {
      value: "1",
      value_text: "Burgers",
    },
    {
      value: "2",
      selected: true,
      value_text: "Pizza",
    },
    {
      value: "3",
      value_text: "Tacos",
    },
    {
      value: "4",
      value_text: "BBQ",
    },
  ]
}) %>

Select Multiple

Favorite Food

The multiple prop enables multiple selections; however, for a better user experience, we recommend our Typeahead kit.

<%= pb_rails("select", props: {
  label: "Favorite Food",
  name: "food",
  multiple: true,
  options: [
    {
      value: "1",
      value_text: "Burgers",
    },
    {
      value: "2",
      selected: true,
      value_text: "Pizza",
    },
    {
      value: "3",
      value_text: "Tacos",
    },
    {
      value: "4",
      value_text: "BBQ",
    },
    {
      value: "4",
      value_text: "Sushi",
    },
    {
      value: "4",
      value_text: "Chinese",
    },
    {
      value: "4",
      value_text: "Hot Dogs",
    },
  ]
}) %>

Things to Avoid

Try to avoid using select when there are limited options to choose from (ie either or questions, yes/no questions, etc).

Available Props

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%
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	Default
attributes	hashprop
blank_selection	string
compact	boolean	false
disabled	boolean	false
error	string
include_blank	string
inline	boolean	false
label	string
multiple	boolean	false
name	string
onchange	string
options	hasharray
show_arrow	boolean	false
required	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

Select

Things to Avoid

Available Props

max_width

min_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

attributes

blank_selection

compact

disabled

error

include_blank

inline

label

multiple

name

onchange

options

show_arrow

required

Contribute to Playbook

Power

Connect