AdminConfigInput

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

User-facing configuration input for the VexCMS admin panel.

All properties are optional — omitted properties fall back to the defaults below.

Defaults applied by defineConfig():

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

Example

// Move the sidebar to the right side
defineConfig({
  admin: { sidebar: { side: "right" } },
  collections: [posts],
})

See

• AdminConfig for the resolved type after defaults are applied
• defineConfig for the config function

Properties

sidebar?

optional sidebar?: object

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

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

collapsible?

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.

side?

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