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

Property	Attribute	Description	Type	Default
`analytics`	`analytics`	Whether analytics should be enabled.	`boolean`	`true`
`engine`		The search interface headless engine.	`SearchEngine<{}> \| undefined`
`i18n`		The search interface i18next instance.	`i18n`	`i18next.createInstance()`
`language`	`language`	The search interface language.	`string`	`'en'`
`logLevel`	`log-level`	The severity level of the messages to log in the console.	`"debug" \| "error" \| "fatal" \| "info" \| "silent" \| "trace" \| "warn" \| undefined`
`pipeline`	`pipeline`	The search interface query pipeline.	`string \| undefined`
`reflectStateInUrl`	`reflect-state-in-url`	Whether the state should be reflected in the URL parameters.	`boolean`	`true`
`scrollContainer`	`scroll-container`	The CSS selector for the container where the interface will scroll back to.	`string`	`'atomic-search-interface'`
`searchHub`	`search-hub`	The search interface search hub.	`string`	`'default'`
`timezone`	`timezone`	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.	`string \| undefined`

analytics

Whether analytics should be enabled.

boolean

true

engine

The search interface headless engine.

SearchEngine<{}> | undefined

i18n

The search interface i18next instance.

i18n

i18next.createInstance()

language

The search interface language.

string

'en'

logLevel

log-level

The severity level of the messages to log in the console.

pipeline

The search interface query pipeline.

string | undefined

reflectStateInUrl

reflect-state-in-url

Whether the state should be reflected in the URL parameters.

boolean

true

scrollContainer

scroll-container

The CSS selector for the container where the interface will scroll back to.

string

'atomic-search-interface'

searchHub

search-hub

The search interface search hub.

string

'default'

timezone

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.

string | undefined

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>