Filter widgets
Filters are added on a View's Filters tab. Each one has a Select type that decides which widget it is. Widgets marked attribute need an Included Attribute: a field from the view's index to filter on.
Meta filters
Meta filters work on the content in your index.
| Widget | Attribute | Use it for |
|---|---|---|
| Search Box | The search field. Set its Placeholder text. | |
| Autocomplete | A search field with a suggestions dropdown. See Autocomplete. Use it instead of a Search Box, not alongside one on the same index. | |
| Refinement List | Yes | Picking several values from a list of checkboxes. |
| Menu | Yes | Picking one value from a list. |
| Menu Select | Yes | Picking one value from a dropdown. |
| Toggle Refinement | Yes | A single checkbox that switches one condition on or off. Set its Checkbox label and the On value it filters for. |
| Sort By | Letting visitors change the sort order. See below. | |
| Current Refinements | Showing the filters that are active, each with a way to remove it. | |
| Clear Refinements | A button that resets every filter. | |
| Powered By (Algolia) | The Algolia logo. Required on Algolia's free Build plan. Choose the logo for a light or dark background. |
Refinement List, Menu and Menu Select also support preselected values, renamed facet values and custom sort orders. See Filter settings.
User filters
User filters narrow results by the visitor's own relationship to the content, such as courses they're enrolled in. They're listed separately under User Filters and use the [tgbl_searchsync_user_filter] shortcode.
| Widget | Needs | Use it for |
|---|---|---|
| Course Statuses Refinement List | LearnDash | Filtering by not started, in progress or completed. |
| Enrollment Status Refinement List | LearnDash | Filtering by enrolled, not enrolled or completed. |
| Favorites ("Only show my favorites") | Tangible Favorites | A toggle that shows only the visitor's favourites. |
For each status list, choose which statuses to include. See Integrations for how personalised filtering works.
Sort By
A Sort By widget lists the sort orders visitors can choose from. Each row has a Label and the Index to sort by; set the Default Sort Index for the initial order. How sorting works depends on your backend:
| Backend | How to sort |
|---|---|
| Algolia | Pick a replica index as-is. Create replicas from the index's Sort orders panel. |
| Meilisearch | Add a Sort Suffix such as post_date:desc. The field is made sortable the next time index settings are pushed. |
| Local | Add a Sort Suffix using sort_text, sort_date or sort_number. Other fields fall back to relevance. |