@coveo/headless
    Preparing search index...

    Interface StandaloneSearchBoxOptions

    interface StandaloneSearchBoxOptions {
        clearFilters?: boolean;
        enableQuerySyntax?: boolean;
        highlightOptions?: SuggestionHighlightingOptions;
        id?: string;
        numberOfSuggestions?: number;
        overwrite?: boolean;
        redirectionUrl: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    clearFilters? enableQuerySyntax? highlightOptions? id? numberOfSuggestions? overwrite? redirectionUrl

    Properties

    clearFilters?: boolean

    Whether to clear all active query filters when the end user submits a new query from the search box. Setting this option to "false" is not recommended & can lead to an increasing number of queries returning no results.

    enableQuerySyntax?: boolean

    Whether to interpret advanced Coveo Cloud query syntax in the query.

    false

    highlightOptions?: SuggestionHighlightingOptions

    Specifies delimiters to highlight parts of a query suggestion that e.g match, do not match the query.

    id?: string

    A unique identifier for the controller. By default, a unique random identifier is generated.

    numberOfSuggestions?: number

    The number of query suggestions to request from Coveo ML (e.g., 3).

    Using the value 0 disables the query suggest feature.

    5

    overwrite?: boolean

    Whether to overwrite the existing standalone search box with the same id.

    redirectionUrl: string

    The default Url the user should be redirected to, when a query is submitted. If a query pipeline redirect is triggered, it will redirect to that Url instead.

    Settings

    Member Visibility

    On This Page

    Properties