CollectionListViewProps
Defined in: packages/core/src/framework.ts:69
Props passed to the CollectionListView component.
TCollectionSlug is inferred from the collection prop and narrows the collection type
to a specific slug after vex generate runs. TDoc defaults to VexDocument
and can be narrowed to a generated document interface when the caller has a
typed initial data array.
Type Parameters
Section titled “Type Parameters”TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends object = { }
TCollectionMeta
Section titled “TCollectionMeta”TCollectionMeta extends object = { }
TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends CollectionSlug = CollectionSlug
TDoc extends VexDocument = VexDocument
Properties
Section titled “Properties”collection
Section titled “collection”collection:
CollectionConfig<TFieldMeta,TCollectionMeta,TCollectionSlug>
Defined in: packages/core/src/framework.ts:76
The resolved collection configuration for the collection being listed.
initialData?
Section titled “initialData?”
optionalinitialData?:PaginationResult<TDoc>
Defined in: packages/core/src/framework.ts:82
Pre-fetched documents from the server. Passed as initialData to
the TanStack Query so the list renders immediately on first load.
Omit when rendering client-side only.