Skip to main content
The Facets component in UI Studio provides interactive filters that allow users to refine search results by selecting categories, attributes, and values. Use facets to narrow down large datasets by criteria like manufacturer, category, price range, or any custom field from your data.

Basic usage

Add a facets component to your UI Studio page to enable filtering capabilities. To build a minimal facets component, you must set a value for the Datastore field and a facet category to display.
If no facets are available for the provided datastore, the component displays an empty state message: “No facets found. Please try adjusting your search criteria.” To add a facet, click the + next to the Facets selector. Facets display in a vertical list.

Searchable facet values

Enable search within facet values for categories with many options. When enabled, a search box appears within each facet category, allowing users to quickly find specific values. This is especially useful for facets with many values, for example, cities or product models. Toggle the Searchable Facet Values switch to turn this feature on or off.

Collapsible facets

Collapsible facets let users show or hide individual facet categories to reduce visual clutter.
When enabled, each facet category displays a chevron icon. Users can click to collapse categories they’re not using, creating a cleaner interface. The collapsed state persists during the user’s session. Enabling collapsible facets is recommended when you have many facet categories. Users can focus on the filters they’re actively using while hiding others. Toggle the Collapsible switch to turn collapsible facet categories on or off.

Inclusive and exclusive filtering

Enable advanced filtering with inclusion and exclusion operators. These filters let users include or exclude a facet from their search results and create complex filter combinations such as “show products from Sony or Samsung, but not refurbished items.” When enabled, each facet value displays plus and minus icons:
  • + (Plus): Include results that match this facet value.
  • - (Minus): Exclude results that match this facet value.
Use inclusive and exclusive filtering for complex filtering through many facets. For simpler interfaces, turn this setting off to avoid overwhelming users with additional controls. Toggle the Inclusive/Exclusive switch to turn this setting on or off.

Selected facet pills

Use facet pills to display selected filters as removable pills before the facet categories. These facet pills provide a visual indicator to users about the facets they’re actively filtering by. Users can select individual facet pills to remove that filter from their current search results. A Clear All link also appears, letting users remove all active filters at once.
Toggle the Selected Facet Pills switch to turn this feature on or off.

Configuration properties

Datastore
dropdown
required
Data source that provides facet categories and values. Must be configured in your UI Studio application.
Facets Title
string
default:""
Optional text label displayed as the heading above the facets panel.
Facets
array
Configure individual facet fields to display in the component.
Searchable Facet Values
boolean
default:"false"
When enabled, adds a search box within each facet category for filtering values. This setting is recommended for facets with ten or more values.
Collapsible
boolean
default:"false"
When enabled, facet categories can be collapsed and expanded with chevron icons. The collapsed state persists in the user’s session.
Inclusive/Exclusive
boolean
default:"false"
When enabled, displays + and - icons next to facet values for inclusive or exclusive filtering. This allows complex filter combinations like “include Sony or Samsung, but exclude refurbished”.
Selected Facet Pills
boolean
default:"false"
When enabled, displays active filters as removable pills at the top with a Clear All option. Shows inclusive (+) or exclusive (-) indicators when Inclusive/Exclusive mode is enabled.
Facets Title Font
group
Typography settings for the main facets heading or title.
Facet Field Font
group
Typography settings for facet category titles (for example, “Manufacturer”, “Color”).
Facet Value Font
group
Typography settings for facet values (for example, “Sony”, “Purple”).
Search Input
group
Typography settings for the search input field within facet categories. Used when Searchable Facet Values is enabled.
Selected Filters Header
group
Typography settings for the “Selected Filters:” header text when Selected Facet Pills is enabled.
Selected Filter Pill
group
Typography settings for the filter pill text when Selected Facet Pills is enabled.
Colors
group
Color scheme for the facets component.