Skip to main content

Interface: UnifiedSearchSectionProvidedContext

Search context provided for its section.

See

useUnifiedSearchSection

Properties

PropertyModifierTypeDescription

isSectionActive

readonly

boolean

Whether this section is active (displayed to the user).

searchStore

readonly

SearchInputStore<string>

Controlled state store for the search input in this section.

setSectionActive

readonly

(active: boolean, searchExtra?: object) => void

Requests the search to activate or deactivate this section.

shouldRender

readonly

boolean

Whether this section must be rendered because its opened the first time.

This is useful for optimization purpose to allow lazy-loading for the section content.