Typeahead

Typeahead is auto suggestion or completion based on what the user is starting to type, gets refined as the user types more.

Summary

Uses Icons

React Rendered

Javascript Enhanced

Default

<%
  options = [
    { label: 'Orange', value: '#FFA500' },
    { label: 'Red', value: '#FF0000' },
    { label: 'Green', value: '#00FF00' },
    { label: 'Blue', value: '#0000FF' },
  ]
%>

<%= pb_rails("typeahead", props: {
    id: "typeahead-default",
    placeholder: "All Colors",
    options: options,
    label: "Colors",
    name: :foo,
    is_multi: false
  })
%>

<%= javascript_tag defer: "defer" do %>
  document.addEventListener("pb-typeahead-kit-typeahead-default-result-option-select", function(event) {
    console.log('Single Option selected')
    console.dir(event.detail)
  })
  document.addEventListener("pb-typeahead-kit-typeahead-default-result-clear", function() {
    console.log('All options cleared')
  })
<% end %>

With Context

Colors

Crayola Crayons

<%= pb_rails("select", props: {
  label: "Colors",
  name: "foo",
  data: { context_select: true },
  options: [
    { value: "red", value_text: "Red" },
    { value: "orange", value_text: "Orange" },
    { value: "yellow", value_text: "Yellow" },
    { value: "green", value_text: "Green" },
    { value: "blue", value_text: "Blue" },
    { value: "purple", value_text: "Purple" },
  ]
  }) %>

  <%= pb_rails("typeahead", props: {
  label: "Crayola Crayons",
  name: :foo,
  data: {
    typeahead_example2: true,
    search_context_value_selector: "[data-context-select] select"
    }
  }) %>

<br><br><br>

<%= javascript_tag defer: "defer" do %>

  document.addEventListener("pb-typeahead-kit-search", function(event) {
    if (!event.target.dataset || !event.target.dataset.typeaheadExample2) return;

    const fuzzyMatch = function(string, term) {
      const ratio = 0.5;
      string = string.toLowerCase();
      const compare = term.toLowerCase();
      let matches = 0;

      if (string.indexOf(compare) > -1) return true;

      for (let index = 0; index < compare.length; index++) {
        if (string.indexOf(compare[index]) > -1) {
          matches += 1
        } else {
          matches -=1;
        }
      }

      return (matches / string.length >= ratio || term == "")
    };

    const colors = { red: ["Red", "Scarlet", "Chestnut", "Mahogany"],
                     orange: ["Orange", "Apricot", "Peach", "Melon", "Burnt Sienna", "Macaroni and Cheese"],
                     yellow: ["Yellow", "Gold", "Goldenrod", "Canary", "Laser Lemon"],
                     green: ["Green", "Olive Green", "Granny Smith Apple", "Spring Green", "Sea Green"],
                     blue: ["Blue", "Cerulean", "Bluetiful", "Sky Blue", "Cadet Blue", "Cornflower"],
                     purple: ["Violet", "Indigo", "Wisteria", "Purple Mountain Majesty", "Lavender"] };

    event.detail.setResults(colors[event.detail.searchingContext].filter((color) => fuzzyMatch(color, event.detail.searchingFor)).map((color) => document.createTextNode(color)));
  })
<% end %>

With Pills

Typeahead kit is data-driven. The minimum default fields are label and value.

This is an example of an option: { label: 'Windows', value: '#FFA500' }

Rails: Default Options

You can also pass default_options which will populate the initial pill selections:

default_options: [{ label: 'Windows', value: '#FFA500' }]

Rails: Subscribing to JS Events

JavaScript events are triggered based on actions you take within the kit such as selection, removal and clearing.
This kit utilizes a default id prop named react-select-input. It is highly advised to send your own unique id prop when using this kit to ensure these events do not unintentionally affect other instances of the kit in the same view. The examples below will use the unique id prop named typeahead-pills-example1:

pb-typeahead-kit-typeahead-pills-example1-result-option-select event to perform custom work when an option is clicked.
pb-typeahead-kit-typeahead-pills-example1-result-option-remove event to perform custom work when a pill is clicked.
pb-typeahead-kit-typeahead-pills-example1-result-option-clear event to perform custom work when all pills are removed upon clicking the X.

Rails: Publishing JS Events

The same rule regarding the id prop applies to publishing JS events. The examples below will use the unique id prop named typeahead-pills-example1:

pb-typeahead-kit-typeahead-pills-example1:clear event to clear all options.

<%
  options = [
    { label: 'Windows', value: '#FFA500' },
    { label: 'Siding', value: '#FF0000' },
    { label: 'Doors', value: '#00FF00' },
    { label: 'Roofs', value: '#0000FF' },
  ]
%>

<%= pb_rails("typeahead", props: { id: "typeahead-pills-example1", default_options: [options.first], options: options, label: "Colors", name: :foo, pills: true }) %>

<%= pb_rails("button", props: {id: "clear-pills", text: "Clear All Options", variant: "secondary"}) %>

<!-- This section is an example of the available JavaScript event hooks -->
<%= javascript_tag defer: "defer" do %>
  document.addEventListener("pb-typeahead-kit-typeahead-pills-example1-result-option-select", function(event) {
    console.log('Option selected')
    console.dir(event.detail)
  })
  document.addEventListener("pb-typeahead-kit-typeahead-pills-example1-result-option-remove", function(event) {
    console.log('Option removed')
    console.dir(event.detail)
  })
  document.addEventListener("pb-typeahead-kit-typeahead-pills-example1-result-clear", function() {
    console.log('All options cleared')
  })

  document.querySelector('#clear-pills').addEventListener('click', function() {
    document.dispatchEvent(new CustomEvent('pb-typeahead-kit-typeahead-pills-example1:clear'))
  })
<% end %>

Without Pills (Single Select)

Passing is_multi: false will allow the user to only select one option from the drop down. Note: this will disable pills prop.

<%
  options = [
    { label: 'Windows', value: '#FFA500' },
    { label: 'Siding', value: '#FF0000' },
    { label: 'Doors', value: '#00FF00' },
    { label: 'Roofs', value: '#0000FF' },
  ]
%>

<%= pb_rails("typeahead", props: {
    id: "typeahead-without-pills-example1",
    placeholder: "All Colors",
    options: options, 
    label: "Colors",
    name: :foo,
    is_multi: false
  })
%>

<!-- This section is an example of the available JavaScript event hooks -->
<%= javascript_tag defer: "defer" do %>
  document.addEventListener("pb-typeahead-kit-typeahead-without-pills-example1-result-option-select", function(event) {
    console.log('Single Option selected')
    console.dir(event.detail)
  })
  document.addEventListener("pb-typeahead-kit-typeahead-without-pills-example1-result-clear", function() {
    console.log('All options cleared')
  })

<% end %>

With Pills (Async Data)

Rails: Providing the `load_options` Promise

*Additional required props: * async: true, pills: true

The prop load_options, when used in conjunction with async: true and pills: true, points to a JavaScript function located within the global window namespace. This function should return a Promise which resolves with the list of formatted options as described in prior examples above. This function is identical to the function provided to the React version of this kit. See the code example for more details.

React

`loadOptions`

*Additional required props: * async: true

As outlined in the react-select Async docs, loadOptions expects to return a Promise that resolves resolves with the list of formatted options as described in prior examples above. See the code example for more details.

`getOptionLabel` + `getOptionValue`

If your server returns data that requires differing field names other than label and value

See react-select docs for more information: https://react-select.com/advanced#replacing-builtins

<%= pb_rails("typeahead", props: {
  async: true,
  get_option_label: 'getOptionLabel',
  get_option_value: 'getOptionValue',
  load_options: 'asyncPillsPromiseOptions',
  label: "Github Users",
  name: :foo,
  pills: true,
  placeholder: "type the name of a Github user"
}) %>

<!-- This section is an example of how to provide load_options prop for using dynamic options -->
<%= javascript_tag defer: "defer" do %>
  // Simple filter function, providing a list of results in the expected data format

  const filterResults = function(results) {
    return results.items.map(function(result) {
      return {
        name: result.login,
        id: result.id,
      }
    })
  }

  /* Note: Make sure you assign this to window or a namespace within window
  or it will not be accessible to the kit! */

  window.asyncPillsPromiseOptions = function(inputValue) {
    return new Promise(function(resolve) {
      if (inputValue) {
        fetch(`https://api.github.com/search/users?q=${inputValue}`)
          .then(function(response) { return response.json() })
          .then(function(results) { resolve(filterResults(results))})
      } else {
        resolve([])
      }
    })
  }

  window.getOptionLabel = function(option) {
    return option.name;
  }
  window.getOptionValue = function(option) {
    return option.id;
  }
<% end %>

With Pills (Async Data w/ Users)

If the data field imageUrl is present, FormPill will receive that field as a prop and display the image.

<%= pb_rails("typeahead", props: { async: true, load_options: 'asyncPillsPromiseOptionsUsers', label: "Github Users", name: :foo, pills: true, placeholder: "type the name of a Github user" }) %>

<%= javascript_tag defer: "defer" do %>
  const filterUserResults = function(results) {
    return results.items.map(function(result) {
      return {
        imageUrl: result.avatar_url,
        label: result.login,
        value: result.id,
      }
    })
  }

  window.asyncPillsPromiseOptionsUsers = function(inputValue) {
    return new Promise(function(resolve) {
      if (inputValue) {
        fetch(`https://api.github.com/search/users?q=${inputValue}`)
          .then(function(response) { return response.json() })
          .then(function(results) { resolve(filterUserResults(results))})
      } else {
        resolve([])
      }
    })
  }
<% end %>

Inline

<%
  synths = [
    { label: 'Oberheim', value: 'OBXa' },
    { label: 'Moog', value: 'Minimoog' },
    { label: 'Roland', value: 'Juno' },
    { label: 'Korg', value: 'MS-20' },
  ]
%>
<%
  cities = [
    { label: 'Budapest', value: 'Hungary' },
    { label: 'Singapore', value: 'Singapore' },
    { label: 'Oslo', value: 'Norway' },
    { label: 'Lagos', value: 'Nigeria' },
  ]
%>

<%= pb_rails("typeahead", props: {
  default_options: [synths.first],
  id: "typeahead-inline-example1",
  inline: true,
  options: synths,
  label: "Synths",
  placeholder: "Add synths",
  pills: true
}) %>

<%= pb_rails("typeahead", props: {
  id: "typeahead-inline-example2",
  inline: true,
  options: cities,
  label: "Cities",
  pills: true,
  placeholder: "Add cities",
  plus_icon: true
}) %>

Multi Kit Options

<%
  labels = [
    { label: 'Verve', value: '1956' },
    { label: 'Stax', value: '1957' },
    { label: 'Motown', value: '1959' },
    { label: 'Kudu', value: '1971' },
    { label: 'Stones Throw', value: '1996' },
  ]
%>
<%
  expressionists = [
    { label: 'Kandinsky', value: 'Russia' },
    { label: 'Klee', value: 'Switzerland' },
    { label: 'Kokoschka', value: 'Austria' },
    { label: 'Kirchner', value: 'Germany' },
  ]
%>

<%= pb_rails("typeahead", props: {
  default_options: [labels.first],
  id: "typeahead-multi-kit-example1",
  options: labels,
  label: "Badges",
  multi_kit: "badge",
  pills: true
}) %>

<%= pb_rails("typeahead", props: {
  default_options: [expressionists.first],
  id: "typeahead-multi-kit-example2",
  options: expressionists,
  label: "Small Pills",
  multi_kit: "smallPill",
  pills: true
}) %>

Error State

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

<%
  options = [
    { label: 'Windows', value: '#FFA500' },
    { label: 'Siding', value: '#FF0000' },
    { label: 'Doors', value: '#00FF00' },
    { label: 'Roofs', value: '#0000FF' },
  ]

%>

<%= pb_rails("typeahead", props: { id: "typeahead-error-example", options: options, error: "Please make a valid selection", label: "Products", name: :foo, is_multi: false }) %>

<!-- This section is an example of the available JavaScript event hooks -->
<%= javascript_tag defer: "defer" do %>
  document.addEventListener("pb-typeahead-kit-typeahead-error-example-result-option-select", function(event) {
    console.log('Option selected')
    console.dir(event.detail)
  })
<% end %>

Margin Bottom

<%
  options = [
    { label: 'Orange', value: '#FFA500' },
    { label: 'Red', value: '#FF0000' },
    { label: 'Green', value: '#00FF00' },
    { label: 'Blue', value: '#0000FF' },
  ]
%>

<%= pb_rails("typeahead", props: {
    id: "typeahead-default",
    placeholder: "All Colors",
    options: options,
    label: "None",
    name: :foo,
    is_multi: false,
    margin_bottom: "none",
  })
%>
<%= pb_rails("typeahead", props: {
    id: "typeahead-default",
    placeholder: "All Colors",
    options: options,
    label: "XXS",
    name: :foo,
    is_multi: false,
    margin_bottom: "xxs",
  })
%>
<%= pb_rails("typeahead", props: {
    id: "typeahead-default",
    placeholder: "All Colors",
    options: options,
    label: "XS",
    name: :foo,
    is_multi: false,
    margin_bottom: "xs",
  })
%>
<%= pb_rails("typeahead", props: {
    id: "typeahead-default",
    placeholder: "All Colors",
    options: options,
    label: "Default - SM",
    name: :foo,
    is_multi: false,
  })
%>
<%= pb_rails("typeahead", props: {
    id: "typeahead-default",
    placeholder: "All Colors",
    options: options,
    label: "MD",
    name: :foo,
    is_multi: false,
    margin_bottom: "md",
  })
%>
<%= pb_rails("typeahead", props: {
    id: "typeahead-default",
    placeholder: "All Colors",
    options: options,
    label: "LG",
    name: :foo,
    is_multi: false,
    margin_bottom: "lg",
  })
%>
<%= pb_rails("typeahead", props: {
    id: "typeahead-default",
    placeholder: "All Colors",
    options: options,
    label: "XL",
    name: :foo,
    is_multi: false,
    margin_bottom: "xl",
  })
%>

<%= javascript_tag defer: "defer" do %>
  document.addEventListener("pb-typeahead-kit-typeahead-default-result-option-select", function(event) {
    console.log('Single Option selected')
    console.dir(event.detail)
  })
  document.addEventListener("pb-typeahead-kit-typeahead-default-result-clear", function() {
    console.log('All options cleared')
  })
<% end %>

With Pills (Custom Color)

Change the form pill color by passing the optional pill_color prop. Product, Data, and Status colors are available options. Check them out here in the Form Pill colors example.

<%
  options = [
    { label: 'Windows', value: '#FFA500' },
    { label: 'Siding', value: '#FF0000' },
    { label: 'Doors', value: '#00FF00' },
    { label: 'Roofs', value: '#0000FF' },
  ]
%>

<%= pb_rails("typeahead", props: { id: "typeahead-pills-example1", pill_color: "neutral", default_options: [options.first], options: options, label: "Colors", name: :foo, pills: true }) %>

<%= pb_rails("button", props: {id: "clear-pills", text: "Clear All Options", variant: "secondary"}) %>

<!-- This section is an example of the available JavaScript event hooks -->
<%= javascript_tag defer: "defer" do %>
  document.addEventListener("pb-typeahead-kit-typeahead-pills-example1-result-option-select", function(event) {
    console.log('Option selected')
    console.dir(event.detail)
  })
  document.addEventListener("pb-typeahead-kit-typeahead-pills-example1-result-option-remove", function(event) {
    console.log('Option removed')
    console.dir(event.detail)
  })
  document.addEventListener("pb-typeahead-kit-typeahead-pills-example1-result-clear", function() {
    console.log('All options cleared')
  })

  document.querySelector('#clear-pills').addEventListener('click', function() {
    document.dispatchEvent(new CustomEvent('pb-typeahead-kit-typeahead-pills-example1:clear'))
  })
<% end %>

Things to Avoid

Avoid using on questionaires, surverys, text input and textarea when users answers/inputs will be individualized.

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%
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_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
data	hashprop
aria	hashprop
html_options	hashprop
children	proc
style	hashprop

Props	Type	Values	Default
margin_bottom	enum	none xxs xs sm md lg xl	sm
id	string
async	boolean		false
default_options	hasharray
error	string
get_option_label	string
get_option_value	string
inline	boolean		false
label	string
load_options	string
multi_kit	string
name	string
options	hasharray
input_options	hashprop
is_multi	boolean		true
pills	boolean		false
placeholder	string
plus_icon	boolean		false
search_term_minimum_length	string		3
search_debounce_timeout	string		250
value	string
pill_color	enum	primary neutral success warning error info data_1 data_2 data_3 data_4 data_5 data_6 data_7 data_8 windows siding roofing doors gutters solar insulation accessories	primary
required	boolean		false
validation	hashprop

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

Typeahead

Rails: Default Options

Rails: Subscribing to JS Events

Rails: Publishing JS Events

Rails: Providing the load_options Promise

React

loadOptions

getOptionLabel + getOptionValue

Things to Avoid

Available Props

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

data

aria

html_options

children

style

margin_bottom

id

async

default_options

error

get_option_label

get_option_value

inline

label

load_options

multi_kit

name

options

Rails: Providing the `load_options` Promise

`loadOptions`

`getOptionLabel` + `getOptionValue`