Interface SearchSource

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

Index

Properties

Methods

fullPage gotoItem isCached search title view

Properties

resource

resource: string

The resource type that this search source is responsible for.

Methods

fullPage

fullPage(query): null | Vnode<{}, {}>
Get a list item for the full search results page.
Parameters
- query: string
Returns null | Vnode<{}, {}>
- Defined in framework/core/js/src/forum/components/Search.tsx:58

gotoItem

gotoItem(id): null | string
Get to the result item page. Only called if each list item has a data-id.
Parameters
- id: string
Returns null | string
- Defined in framework/core/js/src/forum/components/Search.tsx:63

isCached

isCached(query): boolean
Check if a query has been cached for this search source.
Parameters
- query: string
Returns boolean
- Defined in framework/core/js/src/forum/components/Search.tsx:41

search

search(query, limit): Promise<void>
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
- limit: number
Returns Promise<void>
- Defined in framework/core/js/src/forum/components/Search.tsx:47

title

title(): string
Get the title for this search source.

Returns string
- Defined in framework/core/js/src/forum/components/Search.tsx:36

view

view(query): Vnode<{}, {}>[]
Get an array of virtual
s that list the search results for the given query.

Parameters

query: string

Returns Vnode<{}, {}>[]

Generated using TypeDoc v0.24.8