Skip to main content

Function: useTagSearch()

useTagSearch(query, params, options): UseQueryResult<{ cursor: string; hasMore: boolean; tags: object[]; total: number; }, Error>

Defined in: web/lib/hooks/use-tags.ts:327

Searches for tags matching a query.

Parameters

query

string

Search query

params

TagSearchParams = {}

Search parameters

options

UseTagsOptions = {}

Hook options

Returns

UseQueryResult<{ cursor: string; hasMore: boolean; tags: object[]; total: number; }, Error>

Query result with search results

Remarks

Full-text search across tag display forms and normalized forms. Results include quality scores and promotion status.

Example

const { data, isLoading } = useTagSearch('machine', {
minQuality: 0.5,
});

return (
<TagSearchResults
tags={data?.tags ?? []}
total={data?.total ?? 0}
hasMore={data?.hasMore ?? false}
/>
);