Skip to main content

UseSearchResult

What useSearch returns: the accumulated results, their state, and the actions.

Properties​

query​

query: string;

The most recent (trimmed) query passed to search.

results​

results: SearchResult[];

All results loaded so far, across every page fetched.

isSearching​

isSearching: boolean;

True while the first page of a new search is loading.

isLoadingMore​

isLoadingMore: boolean;

True while an additional page is loading via loadMore.

isSupported​

isSupported: boolean;

Whether the current publication supports full-text search.

hasMore​

hasMore: boolean;

True while more pages remain; drives infinite scroll / loadMore.

totalCount?​

optional totalCount?: number;

Total number of matches, when known. Note this is a running tally that grows as pages are loaded — Readium can rarely report a final total before the whole publication has been searched.

search: (query, options?) => Promise<void>;

Starts a new search, replacing any results from a previous one.

Parameters​

ParameterType
querystring
options?SearchOptions

Returns​

Promise<void>

loadMore​

loadMore: () => Promise<void>;

Loads the next page of results for the in-flight search.

Returns​

Promise<void>

clear​

clear: () => void;

Clears results and cancels any in-flight search.

Returns​

void