This module provides a sample web component-based search experience for the Umami demo. It replaces the default search functionality with a layout builder-driven interface that includes a search bar, paginator, sorting, and various facet examples. An advanced submodule offers additional features like collapsible facets and list/grid view switching.
Installs a preconfigured recipe search on the Umami demo site to explore and experiment with Search Web Components. It replaces Umami's search with a Search Web Components search box in the header and a search page at /search built in Layout Builder, on a Search API index of the Umami content.
Read the Search Web Components documentation
What it installs
- A Search API server and index of the Umami content, with the rendered result and the fields the facets and sorts use.
- A Search API Decoupled endpoint with sort options, page sizes, list and grid layouts, and a result element that renders each result in its view mode.
- Eight facets: author, recipe category, tags, content type, cooking time, difficulty, servings, and ingredients.
- A search page at
/searchin the two-column search layout: the search input, the result summary, applied filters, sort, page size, results, a no results message, a loading indicator, a pager, and the facets as buttons, checkboxes, and a dropdown, with a filter dialog on phones. - Example CSS for every component, in the Umami theme's colours.
The submodules
- Umami: Search Web Components Advanced adds a result element for recipes and a search component of the demo's own, both plain JavaScript on
window.SearchWebComponentswith no build step, in a library that depends on the module's bundle. It also adds a content type facet in the HTML dropdown widget, collapsible facets, facet reset buttons, the list and grid switcher, and the CSS for the HTML dropdowns. Read its two JavaScript files and its.modulefile for how a site adds components of its own. - Umami: Search Web Components Canvas builds the same search as a Drupal Canvas page at
/search-canvas, from the two-column search layout component and the Canvas versions of the components. Its install hook shows how a Canvas page is built from components in code. Needs Drupal 11.3 or later and Drupal Canvas.
Install
On a site installed with the Umami demo profile:
composer require drupal/umami_search_web_components drush en umami_search_web_components umami_search_web_components_adv
On a site with Drupal Canvas, then:
drush en umami_search_web_components_canvasOpen /search, or /search-canvas, and search. The install grants anonymous visitors the endpoint's permission and indexes the content.
To start from a fresh Umami site, drush site:install demo_umami --account-pass=admin installs the profile. It drops the current database.
Requirements
- The Umami demo profile.
- Search Web Components 1.0 or later, with its Blocks, Layouts, and Facets submodules, Search API with the database backend, Search API Decoupled, and Facets.
- Drupal Canvas 1.x and Drupal 11.3 or later, for the Canvas submodule only.
Ask your assistant about Umami: Search Web Components
Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works
Depends on
Dependencies of the latest stable release
No dependencies recorded for this project.
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.
Activity
Release Timeline
Releases
| Version | Type | Core | PHP | Release date | |
|---|---|---|---|---|---|
| 1.0.0-beta1 | Pre-release | 10–11 | Oct 15, 2026 | ||
| 1.0.0-alpha2 | Pre-release | 10 | Feb 12, 2024 | ||
| 1.0.0-alpha1 | Pre-release | 10 | Jan 29, 2024 | ||
| 1.0.x-dev | Dev | 10 | Jan 15, 2024 |