@coveo/headless
    Preparing search index...

    Interface StandaloneSearchBox

    The StandaloneSearchBox headless controller offers a high-level interface for designing a common search box UI controller. Meant to be used for a search box that will redirect instead of executing a query.

    Example: standalone-search-box.fn.tsx

    interface StandaloneSearchBox {
        state: StandaloneSearchBoxState;
        afterRedirection(): void;
        clear(): void;
        selectSuggestion(value: string): void;
        showSuggestions(): void;
        submit(): void;
        subscribe(listener: () => void): Unsubscribe;
        updateRedirectUrl(url: string): void;
        updateText(value: string): void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    afterRedirection clear selectSuggestion showSuggestions submit subscribe updateRedirectUrl updateText

    Properties

    state

    Methods

    Properties

    state: StandaloneSearchBoxState

    A scoped and simplified part of the headless state that is relevant to the StandaloneSearchBox controller.

    Settings

    Member Visibility

    On This Page

    Methods
    Properties