AdminCollectionConfig
Defined in: packages/core/src/collections/types.ts:386
Resolved admin panel configuration for a collection after defaults are applied.
AdminCollectionConfigInput for the user-facing input type
Type Parameters
Section titled “Type Parameters”TFieldSlug
Section titled “TFieldSlug”TFieldSlug extends string = ConvexSystemField
TComponent
Section titled “TComponent”TComponent extends ComponentHKT = ComponentHKT
TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends CollectionSlug = CollectionSlug
Properties
Section titled “Properties”components
Section titled “components”components:
object&AdminListComponents
Defined in: packages/core/src/collections/types.ts:408
Collection-level edit.* slot contributions and built-in overrides, passed through
unresolved — resolveEditSlot applies every default when assembling one flat slot id at
render time. The seven list.* keys (headerActions/toolbar/filters/beforeTable/
afterTable/rowActions/bulkActions) are resolved and always present, every list
defaulted to [] and ordered (collections/config.ts’s components resolution, beside
the existing view/livePreview resolution) — unlike edit, which stays unresolved.
Type Declaration
Section titled “Type Declaration”
optionaledit?:EditComponentsConfigInput<TComponent>
optionalicon?:string
Defined in: packages/core/src/collections/types.ts:393
livePreview?
Section titled “livePreview?”
optionallivePreview?:AdminLivePreviewConfig<Partial<TDocument>>
Defined in: packages/core/src/collections/types.ts:399
Resolved live preview config. undefined when the collection omits it.
useAsTitle
Section titled “useAsTitle”useAsTitle:
"_id"|"_creationTime"|"_updatedAt"|NoInfer<TFieldSlug>
Defined in: packages/core/src/collections/types.ts:392
The field used as the document’s human-readable title in the admin panel.
view:
ResolvedDefaultView<TFieldSlug>
Defined in: packages/core/src/collections/types.ts:395
The resolved default (“All”) view — always present, and (Decision 45 FINAL) every collection-wide list setting that used to live on the now-deleted admin.table. See ResolvedDefaultView.
views:
VexViewConfig<TFieldSlug>[]
Defined in: packages/core/src/collections/types.ts:397
Resolved preset views, where intact — see the views warning on AdminCollectionConfigInput.