GlobalsListView
GlobalsListView(
props):Element
Defined in: packages/react/src/components/views/GlobalsListView.tsx:15
Landing page listing every configured global as a clickable card.
Each card links to /admin/globals/{slug} for that global’s edit view.
Parameters
Section titled “Parameters”Component props.
config
Section titled “config”{ admin: { sidebar: { collapsible: "none" | "offcanvas" | "icon"; side: "left" | "right"; }; }; auth?: { collections: object[]; name: string; userCollection: string; }; basePath: string; collections: object[]; globals: object[]; mediaCollections: object[]; schema: { outputPath: string; }; storage?: { adapters: object[]; }; types: { outputPath: string; }; }
The client-side Vex config; reads config.globals.
config.admin
Section titled “config.admin”{ sidebar: { collapsible: "none" | "offcanvas" | "icon"; side: "left" | "right"; }; }
Resolved admin panel configuration — always fully populated after defaults are applied.
config.admin.sidebar
Section titled “config.admin.sidebar”{ collapsible: "none" | "offcanvas" | "icon"; side: "left" | "right"; }
Navigation sidebar configuration — always present after defaults are applied.
config.admin.sidebar.collapsible
Section titled “config.admin.sidebar.collapsible”"none" | "offcanvas" | "icon"
How the sidebar in the admin panel collapses
config.admin.sidebar.side
Section titled “config.admin.sidebar.side”"left" | "right"
Which side of the viewport the admin sidebar is anchored to.
config.auth?
Section titled “config.auth?”{ collections: object[]; name: string; userCollection: string; }
Auth adapter registered with this config. Auth collections are merged with user-defined collections — protected collections and locked fields are preserved during merge.
See
- VexAuthAdapter for the adapter interface
- better-auth/src!betterAuthAdapter for the Better Auth implementation
config.auth.collections
Section titled “config.auth.collections”object[]
Auth collections to register alongside user-defined collections.
These are merged into VexConfig.collections automatically by
defineConfig(). Each collection uses standard Vex field builders
(text(), relationship(), etc.) and may carry admin.readOnly
defaults on system fields.
config.auth.name
Section titled “config.auth.name”string
Provider identifier for debugging and telemetry.
config.auth.userCollection
Section titled “config.auth.userCollection”string
The slug of the collection that stores user documents.
Used by the admin panel to resolve user references and by auth-aware components to look up the current user collection.
config.basePath
Section titled “config.basePath”string
URL prefix for all admin panel routes — always set after defaults are applied.
config.collections
Section titled “config.collections”object[]
All registered content collections — always an array after defaults are applied.
config.globals
Section titled “config.globals”object[]
Resolved global configs. Always present; defaults to [].
config.mediaCollections
Section titled “config.mediaCollections”object[]
Media collections — processed by storage adapters and stored separately
from user-defined collections. These appear in the admin panel under a
dedicated “Media” section. Each collection is tagged with
meta.storageAdapterName indicating which adapter owns it.
config.schema
Section titled “config.schema”{ outputPath: string; }
Resolved schema generation configuration — always fully populated after defaults are applied.
config.schema.outputPath
Section titled “config.schema.outputPath”string
Path where vex.schema.ts is written. Always set after defaults are applied.
config.storage?
Section titled “config.storage?”{ adapters: object[]; }
Storage adapters registered with this config. Processed media collections
from all adapters are available via mediaCollections.
config.storage.adapters
Section titled “config.storage.adapters”object[]
Storage adapters configured for the project.
config.types
Section titled “config.types”{ outputPath: string; }
config.types.outputPath
Section titled “config.types.outputPath”string
Path where vex.types.ts is written. Always set after defaults are applied.
Returns
Section titled “Returns”Element
The grid of global cards.