Standards Docs

useSearchRecords

Search records using full-text search

Search records using full-text search

Signature

<TValues extends Record<string, unknown> = Record<string, unknown>, TSelected = ListResponse<TypedRecord<TValues>>>(objectName: string, query: string, options?: (Omit<UseSearchRecordsOptions, "select"> & { ...; }) | undefined): UseQueryResult<...>

Examples

```tsx
// Basic search
const { data } = useSearchRecords("products", "nike");

// With pagination
const { data } = useSearchRecords("products", searchTerm, {
  limit: 20,
  offset: 0,
});

// With type inference
type Product = ExtractRecord<typeof PRODUCT>;
const { data } = useSearchRecords<Product["values"]>("products", searchTerm);

// With minimum query length
const { data } = useSearchRecords("products", searchTerm, {
  minQueryLength: 3, // Only search when query is at least 3 characters
});

On this page