UsePaginatedQueryProps
Defined in: packages/react/src/hooks/usePaginatedQuery.ts:21
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:44
Items to show per ‘Load More’
enabled?
Section titled “enabled?”
optionalenabled?:boolean
Defined in: packages/react/src/hooks/usePaginatedQuery.ts:53
Whether the underlying query runs at all.
Default
Section titled “Default”true
useVexListQuery calls this hook unconditionally from both its
find-mode and search-mode branches, flipping enabled per branch so
only the active one issues a real request.
initialData?
Section titled “initialData?”
optionalinitialData?:PaginationResult<TDocument>
Defined in: packages/react/src/hooks/usePaginatedQuery.ts:29
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:39
Query arguments for the ‘find()’ api function.
FindClientArgs
Count is fetched only on first page load. Returns null if
collection has >32k documents.