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

See this kit in action in our sample UI

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: "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: "def2",
    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 %>

Popover Props

This kit uses the Popover kit under the hood for the Filter Popover which comes with its own set of props. If you want to apply certain Popover props to that underlying kit, you can do so by using the optional popover_props prop. This prop must be an object that contains valid Popover props. For a full list of Popover props, see here.

<%=
  pb_rails("filter", props: {
    id: "filter_popover_props",
    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: { width: "250px" },
  }) 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 %>

UI Samples using Filter Kit

Get the full picture. See how this kit is used in our samples.

Crm Client List

Available Props

Props	Type	Values
max_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
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
height	string
min_height	string

Props	Type	Values	Default
min_width	string		auto
max_height	string
filters	hasharray		[{:name=>""}]
sort_menu	hasharray		[{}]
results	numeric
template	enum	default single filter_only sort_only	default
background	boolean		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	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

Filter

See this kit in action in our sample UI

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:

UI Samples using Filter Kit

Crm Client List

Available Props

max_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

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