searchcraft-popover-form

Overview

This web component is designed to display search results in a popover container that dynamically appears when the user interacts with a search input field, or when a popover-button is pressed.

Usage

<!-- index.html -->
<searchcraft-popover-form type="fullscreen" />

// index.js
const popoverForm = document.querySelector('searchcraft-popover-form');

popoverForm.popoverResultMappings = {
 containerHref: {
  fieldNames: [
   {
     fieldName: 'canonical_link',
     dataType: 'text',
   },
 ],
 };

Properties

Property	Attribute	Description	Type	Default
`hotkey`	`hotkey`	The hotkey that activates the popover.	`string`	`'k'`
`hotkeyModifier`	`hotkey-modifier`	The hotkey modifier that activates the popover. Used together with the `hotkey` prop.	`"alt" \| "ctrl" \| "meta" \| "option"`	`'meta'`
`popoverResultMappings`	--	Formats the content rendered for each result.	`undefined \| { title?: SearchResultMapping \| undefined; subtitle?: SearchResultMapping \| undefined; imageSource?: SearchResultMapping \| undefined; imageAlt?: SearchResultMapping \| undefined; href?: SearchResultMapping \| undefined; }`	`undefined`
`type`	`type`	The type of popover form to render. - `inline` - Renders inline with the rest of the content on the page. The search results pop over the page content. - `fullscreen` - Renders in fullscreen view. Used together with the `searchcraft-popover-button` component. - `modal` - Renders in a modal view. Used together with the `searchcraft-popover-button` component.	`"fullscreen" \| "inline" \| "modal"`	`'inline'`

Dependencies

Used by

searchcraft-popover-form

Depends on

Graph

graph TD;
  searchcraft-popover-form --> searchcraft-popover-form
  searchcraft-input-form --> searchcraft-button
  searchcraft-input-form --> searchcraft-input-label
  searchcraft-input-form --> searchcraft-error-message
  searchcraft-popover-list-view --> searchcraft-ad
  searchcraft-popover-list-view --> searchcraft-popover-list-item
  style searchcraft-popover-form fill:#f9f,stroke:#333,stroke-width:4px

Built with StencilJS