Root Components

Root Components are those that affect the Admin Panel at a high-level, such as the logo or the main nav. You can swap out these components with your own Custom Components to create a completely custom look and feel.

When combined with Custom CSS, you can create a truly unique experience for your users, such as white-labeling the Admin Panel to match your brand.

To override Root Components, use the admin.components property at the root of your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      // ...
8    },
9  },
10})

Config Options

The following options are available:

Path	Description
`actions`	An array of Custom Components to be rendered within the header of the Admin Panel, providing additional interactivity and functionality. More details.
`afterDashboard`	An array of Custom Components to inject into the built-in Dashboard, after the default dashboard contents. More details.
`afterLogin`	An array of Custom Components to inject into the built-in Login, after the default login form. More details.
`afterNavLinks`	An array of Custom Components to inject into the built-in Nav, after the links. More details.
`beforeDashboard`	An array of Custom Components to inject into the built-in Dashboard, before the default dashboard contents. More details.
`beforeLogin`	An array of Custom Components to inject into the built-in Login, before the default login form. More details.
`beforeNavLinks`	An array of Custom Components to inject into the built-in Nav, before the links themselves. More details.
`graphics.Icon`	The simplified logo used in contexts like the `Nav` component. More details.
`graphics.Logo`	The full logo used in contexts like the `Login` view. More details.
`header`	An array of Custom Components to be injected above the Payload header. More details.
`logout.Button`	The button displayed in the sidebar that logs the user out. More details.
`Nav`	Contains the sidebar / mobile menu in its entirety. More details.
`settingsMenu`	An array of Custom Components to inject into a popup menu accessible via a gear icon above the logout button. More details.
`providers`	Custom React Context providers that will wrap the entire Admin Panel. More details.
`views`	Override or create new views within the Admin Panel. More details.

For details on how to build Custom Components, see Building Custom Components.

Components

actions

Actions are rendered within the header of the Admin Panel. Actions are typically used to display buttons that add additional interactivity and functionality, although they can be anything you'd like.

To add an action, use the actions property in your admin.components config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      actions: ['/path/to/your/component'],
8    },
9  },
10})

Here is an example of a simple Action component:

1export default function MyCustomAction() {
return (
  <button onClick={() => alert('Hello, world!')}>
    This is a custom action component
  </button>
)
7}

beforeDashboard

The beforeDashboard property allows you to inject Custom Components into the built-in Dashboard, before the default dashboard contents.

To add beforeDashboard components, use the admin.components.beforeDashboard property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      beforeDashboard: ['/path/to/your/component'],
8    },
9  },
10})

Here is an example of a simple beforeDashboard component:

1export default function MyBeforeDashboardComponent() {
2  return <div>This is a custom component injected before the Dashboard.</div>
3}

afterDashboard

Similar to beforeDashboard, the afterDashboard property allows you to inject Custom Components into the built-in Dashboard, after the default dashboard contents.

To add afterDashboard components, use the admin.components.afterDashboard property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      afterDashboard: ['/path/to/your/component'],
8    },
9  },
10})

Here is an example of a simple afterDashboard component:

1export default function MyAfterDashboardComponent() {
2  return <div>This is a custom component injected after the Dashboard.</div>
3}

beforeLogin

The beforeLogin property allows you to inject Custom Components into the built-in Login view, before the default login form.

To add beforeLogin components, use the admin.components.beforeLogin property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      beforeLogin: ['/path/to/your/component'],
8    },
9  },
10})

Here is an example of a simple beforeLogin component:

1export default function MyBeforeLoginComponent() {
2  return <div>This is a custom component injected before the Login form.</div>
3}

afterLogin

Similar to beforeLogin, the afterLogin property allows you to inject Custom Components into the built-in Login view, after the default login form.

To add afterLogin components, use the admin.components.afterLogin property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      afterLogin: ['/path/to/your/component'],
8    },
9  },
10})

Here is an example of a simple afterLogin component:

1export default function MyAfterLoginComponent() {
2  return <div>This is a custom component injected after the Login form.</div>
3}

beforeNavLinks

The beforeNavLinks property allows you to inject Custom Components into the built-in Nav Component, before the nav links themselves.

To add beforeNavLinks components, use the admin.components.beforeNavLinks property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      beforeNavLinks: ['/path/to/your/component'],
8    },
9  },
10})

Here is an example of a simple beforeNavLinks component:

1export default function MyBeforeNavLinksComponent() {
2  return <div>This is a custom component injected before the Nav links.</div>
3}

afterNavLinks

Similar to beforeNavLinks, the afterNavLinks property allows you to inject Custom Components into the built-in Nav, after the nav links.

To add afterNavLinks components, use the admin.components.afterNavLinks property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      afterNavLinks: ['/path/to/your/component'],
8    },
9  },
10})

Here is an example of a simple afterNavLinks component:

1export default function MyAfterNavLinksComponent() {
2  return <p>This is a custom component injected after the Nav links.</p>
3}

settingsMenu

The settingsMenu property allows you to inject Custom Components into a popup menu accessible via a gear icon in the navigation controls, positioned above the logout button. This is ideal for adding custom actions, utilities, or settings that are relevant at the admin level.

To add settingsMenu components, use the admin.components.settingsMenu property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      settingsMenu: ['/path/to/your/component#ComponentName'],
8    },
9  },
10})

Here is an example of a simple settingsMenu component:

1'use client'
2import { PopupList } from '@payloadcms/ui'
3
4export function MySettingsMenu() {
5  return (
6    <PopupList.ButtonGroup>
7      <PopupList.Button onClick={() => console.log('Action triggered')}>
8        Custom Action
9      </PopupList.Button>
10      <PopupList.Button onClick={() => window.open('/admin/custom-page')}>
11        Custom Page
12      </PopupList.Button>
13    </PopupList.ButtonGroup>
14  )
15}

You can pass multiple components to create organized groups of menu items:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      settingsMenu: [
8        '/components/SystemActions#SystemActions',
9        '/components/DataManagement#DataManagement',
10      ],
11    },
12  },
13})

Nav

The Nav property contains the sidebar / mobile menu in its entirety. Use this property to completely replace the built-in Nav with your own custom navigation.

To add a custom nav, use the admin.components.Nav property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      Nav: '/path/to/your/component',
8    },
9  },
10})

Here is an example of a simple Nav component:

1import { Link } from '@payloadcms/ui'
2
3export default function MyCustomNav() {
4  return (
5    <nav>
6      <ul>
7        <li>
8          <Link href="/dashboard">Dashboard</Link>
9        </li>
10      </ul>
11    </nav>
12  )
13}

graphics.Icon

The Icon property is the simplified logo used in contexts like the Nav component. This is typically a small, square icon that represents your brand.

To add a custom icon, use the admin.components.graphics.Icon property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      graphics: {
8        Icon: '/path/to/your/component',
9      },
10    },
11  },
12})

Here is an example of a simple Icon component:

1export default function MyCustomIcon() {
2  return <img src="/path/to/your/icon.png" alt="My Custom Icon" />
3}

graphics.Logo

The Logo property is the full logo used in contexts like the Login view. This is typically a larger, more detailed representation of your brand.

To add a custom logo, use the admin.components.graphics.Logo property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      graphics: {
8        Logo: '/path/to/your/component',
9      },
10    },
11  },
12})

Here is an example of a simple Logo component:

1export default function MyCustomLogo() {
2  return <img src="/path/to/your/logo.png" alt="My Custom Logo" />
3}

The header property allows you to inject Custom Components above the Payload header.

Examples of a custom header components might include an announcements banner, a notifications bar, or anything else you'd like to display at the top of the Admin Panel in a prominent location.

To add header components, use the admin.components.header property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      header: ['/path/to/your/component'],
8    },
9  },
10})

Here is an example of a simple header component:

1export default function MyCustomHeader() {
return (
  <header>
    <h1>My Custom Header</h1>
  </header>
)
7}

logout.Button

The logout.Button property is the button displayed in the sidebar that should log the user out when clicked.

To add a custom logout button, use the admin.components.logout.Button property in your Payload Config:

1import { buildConfig } from 'payload'
2
3export default buildConfig({
4  // ...
5  admin: {
6    components: {
7      logout: {
8        Button: '/path/to/your/component',
9      },
10    },
11  },
12})

Here is an example of a simple logout.Button component:

1export default function MyCustomLogoutButton() {
2  return <button onClick={() => alert('Logging out!')}>Log Out</button>
3}

See what others are building with Payload.

"Payload has transformed the way our clients manage content. It's an indispensable tool for any modern agency."

Get the resources you need to start building today

Microsoft chose Payload to tell the world about AI.