VexClientConfig
Defined in: packages/core/src/config/types.ts:518
Resolved client-side Vex CMS configuration after defineConfig() applies
defaults. Structurally contained by VexConfig — every field here
is also readable on a full VexConfig, so server code written against the
old monolithic shape continues to compile.
- VexClientConfigInput for the user-facing input type
- defineConfig for the config function
Extended by
Section titled “Extended by”Properties
Section titled “Properties”access?
Section titled “access?”
optionalaccess?:VexAccessConfig<Record<string,SubjectEntry>, readonlyAccessResource[],string,string|undefined,Partial<Record<string,CustomActionsInput>>>
Defined in: packages/core/src/config/types.ts:521
admin:
AdminConfig
Defined in: packages/core/src/config/types.ts:520
Resolved admin panel configuration — always fully populated after defaults are applied.
authCollections
Section titled “authCollections”authCollections:
AuthCollectionConfig[]
Defined in: packages/core/src/config/types.ts:547
Auth collections built by the project’s auth package’s client-safe
builder (e.g. betterAuthCollections() from @vexcms/better-auth/client),
before merging into collections. Always present; defaults to [] for a
project with no auth.
AuthCollectionConfig for the shape
basePath
Section titled “basePath”basePath:
string
Defined in: packages/core/src/config/types.ts:549
URL prefix for all admin panel routes — always set after defaults are applied.
collections
Section titled “collections”collections:
CollectionConfig<{ }, { },string,Record<string,AdminField>,ComponentHKT,boolean,boolean,string>[]
Defined in: packages/core/src/config/types.ts:529
All registered content collections — user-defined collections merged
with authCollections and internal collections, in that order. Always
an array after defaults are applied.
mergeAuthCollections for the merge order and precedence rules
editor?
Section titled “editor?”
optionaleditor?:VexEditorAdapter<ComponentHKT>
Defined in: packages/core/src/config/types.ts:576
Resolved root editor adapter — present only when the project configured
one. undefined when the project has no rich-text fields.
VexEditorAdapter for the adapter shape
fields
Section titled “fields”fields:
VexFieldsConfig
Defined in: packages/core/src/config/types.ts:578
Resolved project-wide field behavior defaults — always fully populated.
globals
Section titled “globals”globals:
GlobalConfig<{ }, { },string,Record<string,AdminField<{ }>>,ComponentHKT,boolean>[]
Defined in: packages/core/src/config/types.ts:531
Resolved global configs. Always present; defaults to [].
mediaCollections
Section titled “mediaCollections”mediaCollections:
MediaCollectionConfig[]
Defined in: packages/core/src/config/types.ts:538
Media collections declared on the client config, validated against
upload() field references. Always present; defaults to [].
MediaCollectionConfig for the resolved shape
routes?
Section titled “routes?”
optionalroutes?:VexRoutesConfig
Defined in: packages/core/src/config/types.ts:554
Resolved route map. undefined when the project never configured
routes — it is opt-in.
schema
Section titled “schema”schema:
SchemaConfig
Defined in: packages/core/src/config/types.ts:567
Resolved schema generation configuration — always fully populated after defaults are applied. Consumed by the CLI only; present on the client config because it is inert settings data, not a bundle hazard.
storage
Section titled “storage”storage:
object
Defined in: packages/core/src/config/types.ts:561
Client-side upload functions, keyed by storage adapter slug. Always
present; defaults to {}.
clientUploads
Section titled “clientUploads”clientUploads:
ClientUploadMap
ClientUploadMap for the value shape
types:
TypesConfig
Defined in: packages/core/src/config/types.ts:569
Resolved type generation configuration — always fully populated after defaults are applied.