Filter

This kit can be implemented in a variety of ways.
To see examples of how to implement this kit in production visit the /dev_docs/search page in production.

Note
All React examples are wrapped in a {closePopover} method to ensure the popover closes on click of "Apply".

The min_width prop for the popover inside of filter is used in all the examples and is set to 360px. That is the min_width prop we recommend using as it is the same pixel value as our max_width sm global prop.

Summary

Uses Icons

Default

name

John Wick

city

San Francisco

Results:

sort by:

No Filter Selected

Results:

sort by:

To display the "No Filters Selected" text, the filters prop must be null. As a suggestion, check the values of each key in your filters object. If they are all falsy, return null.

<%=
  pb_rails("filter", props: {
    min_width: "360px",
    id: "filter-demo-1",
    margin_bottom: "xl",
    filters: [
      { name: "name", value: "John Wick" },
      { name: "city", value: "San Francisco"}
    ],
    sort_menu: [
      { item: "Popularity", link: "?q[sorts]=managers_popularity+asc", active: true, direction: "desc" },
      { item: "Mananger's Title", link: "?q[sorts]=managers_title+asc", active: false },
      { item: "Manager's Name", link: "?q[sorts]=managers_name+asc", active: false },
    ],
    template: "default",
    results: 1,
  }) do
%>
  <%
    example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away...", value: 5)
    ]
  %>
  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: { label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: {
        text: "Apply",
        data: {
          disable_with: "pb_rails('icon', props: { icon: 'spinner', spin: true, fixed_width: true })Searching...".html_safe
      },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

<%=
  pb_rails("filter", props: {
    min_width: "360px",
    id: "filter-demo-2",
    sort_menu: [
      { item: "Popularity", link: "?q[sorts]=managers_popularity+asc", active: true, direction: "desc" },
      { item: "Mananger's Title", link: "?q[sorts]=managers_title+asc", active: false },
      { item: "Manager's Name", link: "?q[sorts]=managers_name+asc", active: false },
    ],
    template: "default",
    results: 0,
  }) do
%>
  <%
    example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away...", value: 5)
    ]
  %>
  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: { label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: {
        text: "Apply",
        data: {
          disable_with: "pb_rails('icon', props: { icon: 'spinner', spin: true, fixed_width: true })Searching...".html_safe
      },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

No Background

name

John Wick

city

Las Vegas

3 Results

name

John Wick

city

Las Vegas

Results:

sort by:

To remove the background from a filter, add the prop background with a value of false.

<%=
  pb_rails("filter", props: {
    min_width: "360px",
    id: "3",
    margin_bottom: "xl",
    background: false,
    filters: [
      { name: "name", value: "John Wick" },
      { name: "city", value: "Las Vegas"}
    ],
    sort_menu: [
      { item: "Popularity", link: "?q[sorts]=managers_popularity+asc", active: true, direction: "desc" },
      { item: "Mananger's Title", link: "?q[sorts]=managers_title+asc", active: false },
      { item: "Manager's Name", link: "?q[sorts]=managers_name+asc", active: false },
    ],
    results: 3,
    template: "single"
  }) do
%>
  <%
     example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away...", value: 5)
    ]
  %>

  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: { label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: { text: "Apply", data: { disable_with: "<i class='far fa-spinner fa-spin mr-3'></i>Searching...".html_safe },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

<%=
  pb_rails("filter", props: {
    min_width: "360px",
    id: "4",
    background: false,
    filters: [
      { name: "name", value: "John Wick" },
      { name: "city", value: "Las Vegas"}
    ],
    sort_menu: [
      { item: "Popularity", link: "?q[sorts]=managers_popularity+asc", active: true, direction: "desc" },
      { item: "Mananger's Title", link: "?q[sorts]=managers_title+asc", active: false },
      { item: "Manager's Name", link: "?q[sorts]=managers_name+asc", active: false },
    ],
    results: 3,
  }) do
%>
  <%
    example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away...", value: 5)
    ]
  %>
  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: { label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: {
        text: "Apply",
        data: {
          disable_with: "pb_rails('icon', props: { icon: 'spinner', spin: true, fixed_width: true })Searching...".html_safe
      },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

Single

name

John Wick

546 Results

<%=
  pb_rails("filter", props: {
    min_width: "360px",
    id: "2",
    filters: [
      { name: "name", value: "John Wick" }
    ],
    sort_menu: [
      { item: "Popularity", link: "?q[sorts]=managers_popularity+asc", active: true, direction: "desc" },
      { item: "Mananger's Title", link: "?q[sorts]=managers_title+asc", active: false },
      { item: "Manager's Name", link: "?q[sorts]=managers_name+asc", active: false },
    ],
    results: 546,
    template: "single"
  }) do
%>
  <%
   example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away...", value: 5)
    ]
  %>

  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: { label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: {
        text: "Apply",
        data: {
          disable_with: "pb_rails('icon', props: { icon: 'spinner', spin: true, fixed_width: true })Searching...".html_safe
      },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

No Sort

name

John Wick

546 Results

To display results, use templates single or default.

<%=
  pb_rails("filter", props: {
    min_width: "360px",
    id: "nosort",
    filters: [
      { name: "name", value: "John Wick" }
    ],
    results: 546,
    template: "filter_only",
  }) do
%>
  <%
   example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away...", value: 5)
    ]
  %>

  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: { label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: {
        text: "Apply",
        data: {
          disable_with: "pb_rails('icon', props: { icon: 'spinner', spin: true, fixed_width: true })Searching...".html_safe
      },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

Filter Only

name

John Wick

<%=
  pb_rails("filter", props: {
    min_width: "360px",
    id: "fo",
    filters: [
      { name: "name", value: "John Wick" }
    ],
    template:"filter_only",
  }) do
%>
  <%
   example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away...", value: 5)
    ]
  %>
  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: { label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: {
        text: "Apply",
        data: {
          disable_with: "pb_rails('icon', props: { icon: 'spinner', spin: true, fixed_width: true })Searching...".html_safe
      },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

Sort Only

<%=
  pb_rails("filter", props: {
    id: "so",
    sort_menu: [
      { item: "Popularity", link: "?q[sorts]=managers_popularity+asc", active: true, direction: "desc" },
      { item: "Mananger's Title", link: "?q[sorts]=managers_title+asc", active: false },
      { item: "Manager's Name", link: "?q[sorts]=managers_name+asc", active: false },
    ],
    template:"sort_only",
  })
%>

Max Width for Popover Inside of Filter

name

John Wick

city

San Francisco

Results:

sort by:

Filter can leverage the max-width property. Learn more in our visual guidelines.

<%=
  pb_rails("filter", props: {
    min_width: "360px",
    id: "25",
    position: "top",
    filters: [
      { name: "name", value: "John Wick" },
      { name: "city", value: "San Francisco"}
    ],
    sort_menu: [
      { item: "Popularity", link: "?q[sorts]=managers_popularity+asc", active: true, direction: "desc" },
      { item: "Mananger's Title", link: "?q[sorts]=managers_title+asc", active: false },
      { item: "Manager's Name", link: "?q[sorts]=managers_name+asc", active: false },
    ],
    template: "default",
    results: 1,
  }) do
%>
  <%
   example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away, like really far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far away...", value: 5)
    ]
  %>
  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: {max_width: "sm", label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: {
        text: "Apply",
        data: {
          disable_with: "pb_rails('icon', props: { icon: 'spinner', spin: true, fixed_width: true })Searching...".html_safe
      },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

Max Height for Popover Inside of Filter

name

John Wick

city

San Francisco

Results:

sort by:

<%=
  pb_rails("filter", props: {
    max_height: "360px",
    id: "filter_max_height_rails",
    position: "top",
    filters: [
      { name: "name", value: "John Wick" },
      { name: "city", value: "San Francisco"}
    ],
    sort_menu: [
      { item: "Popularity", link: "?q[sorts]=managers_popularity+asc", active: true, direction: "desc" },
      { item: "Mananger's Title", link: "?q[sorts]=managers_title+asc", active: false },
      { item: "Manager's Name", link: "?q[sorts]=managers_name+asc", active: false },
    ],
    template: "default",
    results: 1,
  }) do
%>
  <%
   example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away, like really far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far away...", value: 5)
    ]
  %>
  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: {max_width: "sm", label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: {
        text: "Apply",
        data: {
          disable_with: "pb_rails('icon', props: { icon: 'spinner', spin: true, fixed_width: true })Searching...".html_safe
      },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

Filter Placement

name

John Wick

Click the filter button above to toggle the popover.

<%=
  pb_rails("filter", props: {
    min_width: "360px",
    id: "pla",
    filters: [
      { name: "name", value: "John Wick" }
    ],
    placement: "right",
    template:"filter_only",
  }) do
%>
  <%
   example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away...", value: 5)
    ]
  %>
  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: { label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: {
        text: "Apply",
        data: {
          disable_with: "pb_rails('icon', props: { icon: 'spinner', spin: true, fixed_width: true })Searching...".html_safe
      },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

Within Turbo Frames

name

John Wick

city

San Francisco

Results:

sort by:

By default, the filter popover attaches to the <body>. To attach it elsewhere, like inside a Turbo Frame, pass the append_to prop through popover_props. Set it to "parent" to place the tooltip inside its parent element, or pass any CSS selector (#id or .class) to specify a custom container.

<%=
  pb_rails("filter", props: {
    id: "filter_within_trubo_frames",
    position: "top",
    filters: [
      { name: "name", value: "John Wick" },
      { name: "city", value: "San Francisco"}
    ],
    sort_menu: [
      { item: "Popularity", link: "?q[sorts]=managers_popularity+asc", active: true, direction: "desc" },
      { item: "Mananger's Title", link: "?q[sorts]=managers_title+asc", active: false },
      { item: "Manager's Name", link: "?q[sorts]=managers_name+asc", active: false },
    ],
    template: "default",
    results: 1,
    popover_props: { append_to: "parent"  },
  }) do
%>
  <%
   example_collection = [
      OpenStruct.new(name: "USA", value: 1),
      OpenStruct.new(name: "Canada", value: 2),
      OpenStruct.new(name: "Brazil", value: 3),
      OpenStruct.new(name: "Philippines", value: 4),
      OpenStruct.new(name: "A galaxy far far away, like really far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far far away...", value: 5)
    ]
  %>
  <%= pb_rails("form", props: { form_system_options: { scope: :example, method: :get } }) do |form| %>
    <%= form.text_field :example_text_field, props: { label: true } %>
    <%= form.collection_select :example_collection_select, example_collection, :value, :name, props: {max_width: "sm", label: true } %>

    <%= form.actions do |action| %>
      <%= action.submit props: {
        text: "Apply",
        data: {
          disable_with: "pb_rails('icon', props: { icon: 'spinner', spin: true, fixed_width: true })Searching...".html_safe
      },}%>
      <%= action.button props: { type: "reset", text: "Clear", variant: "secondary" } %>
    <% end %>
  <% end %>
<% end %>

Available Props

Props	Type	Values
align_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
align_items	enum \| responsive	start end center
border_radius	enum	none xs sm md lg xl rounded
cursor	enum	auto default none contextMenu help pointer progress wait cell
dark	boolean	true false
flex	enum \| responsive	auto initial 0 1 2 3 4 5 6 7 8 9 10 11 12 none
flex_direction	enum \| responsive	row column rowReverse columnReverse
flex_wrap	enum \| responsive	wrap nowrap wrapReverse
justify_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
line_height	enum	loosest looser loose normal tight tighter tightest
margin_right	array	none xxs xs sm md lg xl
margin_left	array	none xxs xs sm md lg xl
margin_top	array	none xxs xs sm md lg xl
margin_bottom	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
margin	array	none xxs xs sm md lg xl
width	string
min_width	string
max_width	string
gap	string \| responsive
column_gap	string \| responsive
row_gap	string \| responsive
number_spacing	enum	tabular
order	enum \| responsive	none first 1 2 3 4 5 6 7 8 9 10 11 12
overflow_x	enum	scroll visible hidden auto
overflow_y	enum	scroll visible hidden auto
overflow	enum	scroll visible hidden auto
padding_right	array	none xxs xs sm md lg xl
padding_left	array	none xxs xs sm md lg xl
padding_top	array	none xxs xs sm md lg xl
padding_bottom	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
padding	array	none xxs xs sm md lg xl
position	enum	relative absolute fixed sticky static
shadow	enum	none deep deeper deepest
text_align	enum \| responsive	start end left right center justify justifyAll matchParent
truncate	enum	none 1 2 3 4 5
vertical_align	enum \| responsive	baseline super top middle bottom sub text-top text-bottom
z_index	enum \| responsive	1 2 3 4 5 6 7 8 9 10 max
top	enum \| object	xxs xs sm md lg xl xxl
inset	boolean	true false
right	enum \| object	xxs xs sm md lg xl xxl
bottom	enum \| object	xxs xs sm md lg xl xxl
left	enum \| object	xxs xs sm md lg xl xxl
height	string
max_height	string
min_height	string
hover	object
group_hover	boolean	true false

Props	Type	Values	Default
filters	array
sort_menu	array
results	string
template	enum	default single filter_only sort_only	default
background	boolean	true false	true
placement	enum	top bottom left right top-start top-end bottom-start bottom-end right-start right-end left-start left-end	bottom-start
popover_props	string

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

Github

Connect Chat

Filter

John Wick

San Francisco

Results:

Results:

John Wick

Las Vegas

John Wick

Las Vegas

Results:

John Wick

John Wick

John Wick

John Wick

San Francisco

Results:

John Wick

San Francisco

Results:

John Wick

John Wick

San Francisco

Results:

John Wick

San Francisco

Results:

Available Props

align_content

align_items

border_radius

cursor

dark

flex

flex_direction

flex_wrap

justify_content

line_height

margin_right

margin_left

margin_top

margin_bottom

margin_x

margin_y

margin

width

min_width

max_width

gap

column_gap

row_gap

number_spacing

order

overflow_x

overflow_y

overflow

padding_right

padding_left

padding_top

padding_bottom

padding_x

padding_y

padding

position

shadow

text_align

truncate

vertical_align

z_index

top

inset

right

bottom

left

height

max_height

min_height

hover

group_hover

filters

sort_menu