The Umami search page updated with web components
The Umami search page updated with web components from the advanced submodule

This project is not covered by Drupal’s security advisory policy.

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 /search in 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.SearchWebComponents with 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 .module file 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_canvas

Open /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

Supporting organizations: 

Project information

Releases