Appearance
Glossary
Builder names
Some concepts have a different name on each screen. This table lists the name each screen uses.
| Concept | Meaning | Where it is set | Names on screen |
|---|---|---|---|
| Endpoint | The Search API Decoupled endpoint that answers the searches of a page, e.g., /api/search/content. | Configuration › Search and metadata › Search API › Endpoints | Decoupled Search Endpoint on the layout section and the facet blocks. Endpoint and Endpoint URL in Canvas. url in Twig. |
| Search root | The element that runs the searches and shares them with the components inside it. | A layout or Twig | Search root in Canvas. search-root in Twig. |
| Component | One web component, e.g., the sort. | Canvas or Twig | Search sort in Canvas. search_web_components:search-sort in Twig. |
| Block | A Drupal block that renders one component. | Layout Builder or the block layout | Sort, Results, and the other blocks in the category Search Components. |
| Layout | A Layout Builder layout or Canvas layout component that renders a search root with regions. | Layout Builder or Canvas | Search Components: One Column and Search Components: Two Column in Layout Builder. Search layout, one column and Search layout, two columns in Canvas. |
| Listing layout | How the results list is laid out, e.g., List and Grid. | Endpoint, Listing layouts | Results display switcher block. Override available options on that block. Default result display on the layout and in Canvas. Display options on the Canvas switcher. When results are shown as in result elements. |
| Result element | The element that renders one result, picked by the result's value in the match field. | Endpoint, Result elements | "mapping" in the endpoint form's messages and in the screen reader names of its Edit and Remove buttons. Result mappings in Canvas. mappings in Twig. |
| Match field | The field whose value picks the result element. | Endpoint, Result elements | Match on field on the endpoint and the Results block. Result field in Canvas. resultField in Twig. |
| All values | A result element row that matches every value. | Endpoint, Result elements | All values on the endpoint. Stored and typed as default on the Results block and in mappings. "Any value" or "<field> is any value" in the row summary. |
| Page size | How many results each page of results shows. | Endpoint, Items per page options | Size on the endpoint. Results per page block. Page size on that block. Default results per page on the layout. Page size options in Canvas. The endpoint's Limit is the starting page size. |
| Sort option | One way to order the results, e.g., A-Z. | Endpoint, Sort options | Sort block. Override available sorts on that block. Sort options in Canvas. |
| Then sort by | A further field that orders results which tie on the first. | A sort option row | Then sort by when editing. Then by in the table. "tie-breaker" in its error message. |
| Sort alias | A sort option's name in the page URL, e.g., title-asc in ?sort=title-asc. | A sort option row, Alias | Alias on the endpoint and on the Sort block. |
| Facet source | The endpoint a facet belongs to. | The facet's add form | Facet source, listed by the endpoint's label, e.g., Content. |
| Facet URL alias | A facet's name in the page URL, e.g., category in f[category]=Desserts. | The facet's edit form, URL alias | URL alias. It is separate from the sort alias. |
| Filter dialog | A region of the two-column layout that opens as a dialog on narrow screens. | The layout section or the Canvas layout | Left Third (dialog) in Layout Builder. Sidebar 3 (dialog controlled) in Canvas. Dialog Toggle block. |
What "key" means in code
In attributes, events, and the endpoint response, key names a different thing in each place:
| Where | key is | Example |
|---|---|---|
A facet element's key attribute | The facet's machine name. | key="recipe_category" |
Facet events and applyFacet() | The facet's URL alias. | category |
A facet option in the response (results[].key) | The option's raw value. | 12 for a taxonomy term id |
sorts items ({key, order, label}) | The sort field. | {key: 'title', order: 'asc', label: 'A-Z'} |
options items of search-results-per-page | The page size. | {key: '25', label: '25'} |
options items of search-results-switcher | The listing layout key. | {key: 'grid', label: 'Grid'} |
mappings items (keys) | Values of the match field, optionally followed by a hyphen and a listing layout key. | ["recipe", "recipe-grid", "default"] |