The SearchSource interface defines a section of search results in the search dropdown.

Search sources should be registered with the Search component class by extending the sourceItems method. When the user types a query, each search source will be prompted to load search results via the search method. When the dropdown is redrawn, it will be constructed by putting together the output from the view method of each source.

Hierarchy

  • SearchSource

Implemented by

Methods

Methods

  • Make a request to get results for the given query. The results will be updated internally in the search source, not exposed.

    Parameters

    • query: string

    Returns Promise<void>

  • Get an array of virtual

  • s that list the search results for the given query.

Parameters

Returns Vnode<{}, {}>[]

Generated using TypeDoc v0.23.24