-
Components
- atomic-aria-live
- atomic-breadbox
- atomic-category-facet
- atomic-color-facet
- atomic-component-error
- atomic-did-you-mean
- atomic-external
- atomic-facet
- atomic-facet-manager
- atomic-folded-result-list
- atomic-format-currency
- atomic-format-number
- atomic-format-unit
- atomic-icon
- atomic-layout-section
- atomic-load-more-children-results
- atomic-load-more-results
- atomic-no-results
- atomic-numeric-facet
- atomic-numeric-range
- atomic-pager
- atomic-query-error
- atomic-query-summary
- atomic-rating-facet
- atomic-rating-range-facet
- atomic-refine-modal
- atomic-refine-toggle
- atomic-relevance-inspector
- atomic-result
- atomic-result-children
- atomic-result-children-template
- atomic-result-list
- atomic-result-template
- atomic-results-per-page
- atomic-search-box
- atomic-search-box-query-suggestions
- atomic-search-box-recent-queries
- atomic-search-interface
- atomic-search-layout
- atomic-smart-snippet
- atomic-smart-snippet-feedback-modal
- atomic-smart-snippet-suggestions
- atomic-sort-dropdown
- atomic-sort-expression
- atomic-table-element
- atomic-text
- atomic-timeframe
- atomic-timeframe-facet
atomic-search-interface
The 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. |
|
|
|
The search interface headless engine. |
|
||
|
The search interface i18next instance. |
|
|
|
|
|
The icon assets path. By default, this will be a relative URL pointing to |
|
|
|
|
The search interface language. |
|
|
|
|
The language assets path. By default, this will be a relative URL pointing to |
|
|
|
|
The severity level of the messages to log in the console. |
|
|
|
|
The search interface query pipeline. |
|
|
|
|
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. |
|
|
|
|
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. |
|
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.
Signature: initializeWithSearchEngine(engine: SearchEngine) => Promise<void>
Returns: Promise<void>