@bridgeline-digital/hawksearch-handlebars-ui
    Preparing search index...

    Interface ConceptSearchFieldComponentConfig

    interface ConceptSearchFieldComponentConfig {
        disableAutofill?: boolean;
        disablePlaceholderAnimation?: boolean;
        searchDebounceValue?: number;
        searchMinCharacterCount?: number;
        searchOnKeyPress?: boolean;
        shadowDom?: boolean;
        strings?: { placeholder?: string | string[] };
        template?: string;
        useCustomStyle?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    disableAutofill? disablePlaceholderAnimation? searchDebounceValue? searchMinCharacterCount? searchOnKeyPress? shadowDom? strings? template? useCustomStyle?

    Properties

    disableAutofill?: boolean

    Specifies whether the input element should be pre-populared if "query" parameter exists on the URL.

    false

    disablePlaceholderAnimation?: boolean

    Specifies whether the placeholder animation should be disabled. When true and the placeholder is an array, a random item will be selected instead of animating.

    false

    searchDebounceValue?: number

    Specifies the debounce value between fetching data and keypress (ms)

    250 For more information, see Components.

    searchMinCharacterCount?: number

    Specifies the minimum length for a query to trigger a request.

    10 For more information, see Components.

    searchOnKeyPress?: boolean

    Specifies if a request is triggered on keypress.

    false For more information, see Components.

    shadowDom?: boolean

    Specifies whether the component should be rendered in the Shadow DOM. This is highly recommended to avoid CSS conflicts.

    true

    strings?: { placeholder?: string | string[] }
    template?: string

    Specifies a custom template to be used instead of the default template.

    For more information, see Components.

    useCustomStyle?: boolean

    Specifies whether the component should be rendered in the avoid injecting the css to head of the page. This would only effect when shadowDom false

    Settings

    Member Visibility

    On This Page

    Properties