Catalog Block – searchable tiles with filters and groups¶
The catalog shows the records of a query as tiles. Users search the tiles, narrow them with filter chips and open groups that interest them. It suits offerings users browse: a service catalogue, a product range, templates.
This page is part of the widget reference.
1. At a glance¶
| Purpose | Records as tiles with search, filter chips and groups |
| Typical use | IT service catalogue, product catalogue, document templates |
| Related | Query Results, Query Result List |
2. Settings¶
In addition, the widget has the settings every widget has.
| Setting | Meaning | Default |
|---|---|---|
| "Query" | The query that provides the records | none – required |
| "Tile Form" | The form drawn inside each tile, opened on the record of the tile | none – required |
| "Filter Field" | A field whose distinct values are offered as filter chips above the tiles | none – no chips |
| "Group Field" | A field whose distinct values split the tiles into collapsible groups | none – one block of tiles |
| "Groups Initially Collapsed" | The groups start closed | off |
| "Sort By" | A sort order of the records, applied in the order the fields are picked | the order of the query |
| "Tile Click Action" | An action run against the record of the clicked tile | none – tiles are not clickable |
| "Display Search" | Shows a search box above the filter chips | on |
| "Search Placeholder" | Hint inside the search box | – |
| "Max Records" | How many records are loaded at most | 100 |
| "Title", "Subtitle" | Headline and secondary text above the tiles | none |
| "All Filter Label" | Label of the chip that clears the filter | "All" |
| "Empty Result Text" | Message when neither search nor filter match any record | "No entries match the current search." |
| "Empty Group Label" | Heading of the group of records whose group field is empty | "Other" |
| "Min Tile Width" | Minimum width of a tile as a CSS length. The catalog fits as many tiles in a row as the width allows. | 260px |
3. Behaviour¶
- Loading: the catalog loads at most "Max Records" records, sorted by "Sort By" first – so the sort order decides which records are included.
- Search: where the entity takes part in the full-text search, the search runs as a full-text search in the database. Otherwise it matches the field values of the loaded records.
- Filter chips are built from the values of "Filter Field" among the loaded records. "All" shows everything again.
- Groups are built from the values of "Group Field"; records without a value go to "Empty Group Label". A group the user opened stays open when the search changes.
- Read limits of the viewing user apply.
- With "Auto Refresh" the catalog searches again with the text the user entered.
4. Example¶
IT service catalogue. "Query" "Active services", "Tile Form" "Service tile" (icon, name, short
description), "Filter Field" "Audience", "Group Field" "Category", "Sort By" "Name",
"Tile Click Action" "Request service", "Min Tile Width" 240px.
5. Limitations¶
- No paging: records beyond "Max Records" are not loaded. Raise the value or narrow the query.
- Filter chips only offer values that occur in the loaded records.
- Every tile is a form. Several hundred tiles take noticeably longer to draw.