Skip to content

AdminConfigInput

Defined in: packages/core/src/config/types.ts:80

Root-level admin panel input configuration accepted by defineConfig() — live preview, sidebar, and admin extension-point (components) settings before defaults are applied.

optional components?: AdminComponentsInput

Defined in: packages/core/src/config/types.ts:126

Root-level admin extension points (S1) — resolved once by defineConfig(), merging BUILTIN_CONTRIBUTION_IDS defaults with this project’s own lists.

Experimental: breaking changes are still possible before this stabilizes.


optional livePreview?: LivePreviewConfigInput

Defined in: packages/core/src/config/types.ts:91

Live-preview config: the postMessage origin allowlist, the simulated viewport breakpoints, and per-collection/per-global settings.

Lives under admin because that is where a collection declares its own admin.livePreview, and layered settings should be found in the same place at both levels.

LivePreviewConfigInput for all available options


optional sidebar?: object

Defined in: packages/core/src/config/types.ts:103

Navigation sidebar configuration for the admin panel.

Controls the sidebar that houses collection links and navigation items. All properties are optional; omitted values fall back to the defaults below.

Defaults applied by defineConfig():

{ side: "left" } // sidebar rendered on the left side of the viewport

optional collapsible?: "none" | "offcanvas" | "icon"

How the sidebar in the admin panel collapses

  • "offcanvas" — A collapsible sidebar that slides in from the left or right.
  • "icon" — A sidebar that collapses to icons.
  • "none" — A non-collapsible sidebar.

optional side?: "left" | "right"

Which side of the viewport the admin sidebar is anchored to.

  • "left" — sidebar sits on the left (default)
  • "right" — sidebar sits on the right