UsePaginatedQueryProps
Defined in: packages/react/src/hooks/usePaginatedQuery.ts:20
Props for the usePaginatedQuery hook.
Type Parameters
Section titled “Type Parameters”TDocument
Section titled “TDocument”TDocument extends VexDocument = VexDocument
TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends CollectionSlug = CollectionSlug
Collection slug type
Defaults:
initialNumItems: 100depth: 1includeTotalCount: true
Properties
Section titled “Properties”clientPageSize?
Section titled “clientPageSize?”
optionalclientPageSize?:number
Defined in: packages/react/src/hooks/usePaginatedQuery.ts:43
Items to show per ‘Load More’
initialData?
Section titled “initialData?”
optionalinitialData?:PaginationResult<TDocument>
Defined in: packages/react/src/hooks/usePaginatedQuery.ts:28
Initial data from SSR (optional). Can be either an array of documents or a PaginationResult.
query:
FindClientPaginatedArgs<TCollectionSlug>
Defined in: packages/react/src/hooks/usePaginatedQuery.ts:38
Query arguments for the ‘find()’ api function.
FindClientArgs
Count is fetched only on first page load. Returns null if
collection has >32k documents.