atomic-search-interface
atomic-search-interface
This is for:
DeveloperThe atomic-search-interface
component is the parent to all other atomic components in a search page. It handles the headless search engine and localization configurations.
Properties
Property | Attribute | Description | Type | Default |
---|---|---|---|---|
|
|
Whether analytics should be enabled. |
|
|
|
|
Whether the relevance inspector shortcut should be enabled for this interface. The relevance inspector can be opened by holding the Alt key (Option on Mac) while over the interface, and performing a double click. The relevance inspector allows to troubleshoot and debug queries. |
|
|
|
The search interface headless engine. |
|
||
|
|
A list of non-default fields to include in the query results. Specify the property as an array using a JSON string representation:
|
|
|
|
The search interface i18next instance. |
|
|
|
|
|
The icon assets path. By default, this will be a relative URL pointing to Example: "/mypublicpath/icons" |
|
|
|
|
The search interface language. |
|
|
|
|
The language assets path. By default, this will be a relative URL pointing to Example: "/mypublicpath/languages" |
|
|
|
|
The severity level of the messages to log in the console. |
|
|
|
|
The search interface query pipeline. If the search interface is initialized using |
|
|
|
|
Whether the state should be reflected in the URL parameters. |
|
|
|
|
The CSS selector for the container where the interface will scroll back to. |
|
|
|
|
The search interface search hub. If the search interface is initialized using [ |
|
|
|
|
The tz database identifier of the time zone to use to correctly interpret dates in the query expression, facets, and result items. By default, the timezone will be guessed. Example: "America/Montreal" |
|
Methods
executeFirstSearch
Executes the first search and logs the interface load event to analytics, after initializing connection to the headless search engine.
Signature: executeFirstSearch() => Promise<void>
Returns: Promise<void>
initialize
Initializes the connection with the headless search engine using options for accessToken
(required), organizationId
(required), renewAccessToken
, and platformUrl
.
Signature: initialize(options: InitializationOptions) => Promise<void>
Returns: Promise<void>
initializeWithSearchEngine
Initializes the connection with an already preconfigured headless search engine, as opposed to the initialize
method which will internally create a new search engine instance.
This bypasses the properties set on the component, such as analytics, searchHub, pipeline, language, timezone & logLevel.
Signature: initializeWithSearchEngine(engine: SearchEngine) => Promise<void>
Returns: Promise<void>