Components
/
Filter

Filter

Enter values into a filter component to use with other components.

Ways to use a filter

Provide input value for several components filters

By binding a single filter to multiple components (such as tables, detail or card lists), multiple sets of data can be filtered on a single criteria.

Example:
You add a filter component called CompanyName. You bind this to the Employees, Orders, and Inventory tables in your space to find records for a specific company.

We'll walk through an example using multiple components in the configuration details below.

Use its value to prefill fields in another component

Sometimes you may want to use what's input in the filter as a field in components like buttons or forms.

Example:
You have an “Activate” button that requires a UserID field. You can bind this to a filter component, so that whenever this button is clicked, the value in the filter component is used as the UserID.

Configuring your filter

Setting up a filter is quick - much of the work will happen when you bind to this filter in another component's configuration. Just give your filter a name and enter in the placeholder text inside the filter.

Example

Let's say we have a table of Companies and a card list of Employees that belong to each company. We want to create a tool that will allow us to search for a particular company and display only their employees in the card list.

We can create a filter called companyid and set the text to "Enter a Company ID".

Next, we'll go to the Companies table settings and set it to be filtered by the id column using the value from the companyid filter.

We'll also go to the Employees card list settings and set this to be filtered by the company id using the value from the companyid filter.

Once these are set up, whenever a user inputs a company id into the filter at the top, you'll see both the table and the card list filter the results to just that company.