Interface AutocompleteConfig<State>

Type Parameters

  • State

Hierarchy

  • AutocompleteConfig

Properties

dropdownSelector fetch googleAnalytics? historyEnabled? historySize? inputSelector minQueryLength? nostoAnalytics? render submit?

Properties

dropdownSelector

dropdownSelector: string | Element | Element[] | NodeListOf<Element> | ((input) => string | Element | Element[] | NodeListOf<Element>)

The dropdown element to attach the autocomplete to

Type declaration

    • (input): string | Element | Element[] | NodeListOf<Element>

    • Parameters

      • input: HTMLInputElement

      Returns string | Element | Element[] | NodeListOf<Element>

fetch

fetch: InputSearchQueryWithFields | ((input) => PromiseLike<State>)

The function to use to fetch the search state

Type declaration

    • (input): PromiseLike<State>

    • Parameters

      • input: string

      Returns PromiseLike<State>

Optional googleAnalytics

googleAnalytics?: boolean | GoogleAnalyticsConfig

Google Analytics configuration. Set to false to disable.

Optional historyEnabled

historyEnabled?: boolean

Enable history

Optional historySize

historySize?: number

Max number of history items to show

inputSelector

inputSelector: string | Element | Element[] | NodeListOf<Element>

The input element to attach the autocomplete to

Optional minQueryLength

minQueryLength?: number

Minimum length of the query before searching

Optional nostoAnalytics

nostoAnalytics?: boolean

Enable Nosto Analytics

render

render: ((container, state) => void | PromiseLike<void>)

Type declaration

    • (container, state): void | PromiseLike<void>

    • The function to use to render the dropdown

      Parameters

      • container: HTMLElement
      • state: State

      Returns void | PromiseLike<void>

Optional submit

submit?: ((query, config, options?) => void)

Type declaration

    • (query, config, options?): void

    • The function to use to submit the search

      Parameters

      • query: string
      • config: AutocompleteConfig<State>
      • Optional options: SearchAutocompleteOptions

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc