Swap in your own React components
The Payload Admin Panel is designed to be as minimal and straightforward as possible to allow for both easy customization and full control over the UI. In order for Payload to support this level of customization, Payload provides a pattern for you to supply your own React components through your Payload Config.
All Custom Components in Payload are React Server Components by default, with the exception of Custom Providers. This enables the use of the Local API directly on the front-end. Custom Components are available for nearly every part of the Admin Panel for extreme granularity and control.
There are four main types of Custom Components in Payload:
To swap in your own Custom Component, consult the list of available components. Determine the scope that corresponds to what you are trying to accomplish, then author your React component(s) accordingly.
Defining Custom Components in the Payload Config
In the Payload Config, you can define custom React Components to enhance the admin interface. However, these components should not be imported directly into the server-only Payload Config to avoid including client-side code. Instead, you specify the path to the component. Here’s how you can do it:
src/components/Logout.tsx
payload.config.ts:
In the path /src/components/Logout#MyComponent
, /src/components/Logout
is the file path, and MyComponent
is the named export. If the component is the default export, the export name can be omitted. Path and export name are separated by a #
.
Configuring the Base Directory
Component paths, by default, are relative to your working directory - this is usually where your Next.js config lies. To simplify component paths, you have the option to configure the base directory using the admin.baseDir.baseDir
property:
In this example, we set the base directory to the src
directory - thus we can omit the /src/
part of our component path string.
Passing Props
Each React Component in the Payload Config is typed as PayloadComponent
. This usually is a string, but can also be an object containing the following properties:
Property | Description |
---|---|
clientProps | Props to be passed to the React Component if it's a Client Component |
exportName | Instead of declaring named exports using # in the component path, you can also omit them from path and pass them in here. |
path | Path to the React Component. Named exports can be appended to the end of the path, separated by a # |
serverProps | Props to be passed to the React Component if it's a Server Component |
To pass in props from the config, you can use the clientProps
and/or serverProps
properties. This alleviates the need to use an HOC (Higher-Order-Component) to declare a React Component with props passed in.
Here is an example:
src/components/Logout.tsx
payload.config.ts:
Import Maps
It's essential to understand how PayloadComponent
paths function behind the scenes. Directly importing React Components into your Payload Config using import statements can introduce client-only modules like CSS into your server-only config. This could error when attempting to load the Payload Config in server-only environments and unnecessarily increase the size of the Payload Config, which should remain streamlined and efficient for server use.
Instead, we utilize component paths to reference React Components. This method enhances the Payload Config with actual React Component imports on the client side, without affecting server-side usage. A script is deployed to scan the Payload Config, collecting all component paths and creating an importMap.js
. This file, located in app/(payload)/admin/importMap.js, must be statically imported by your Next.js root page and layout. The script imports all the React Components from the specified paths into a Map, associating them with their respective paths (the ones you defined).
When constructing the ClientConfig
, Payload uses the component paths as keys to fetch the corresponding React Component imports from the Import Map. It then substitutes the PayloadComponent
with a MappedComponent
. A MappedComponent
includes the React Component and additional metadata, such as whether it's a server or a client component and which props it should receive. These components are then rendered through the <RenderComponent />
component within the Payload Admin Panel.
Import maps are regenerated whenever you modify any element related to component paths. This regeneration occurs at startup and whenever Hot Module Replacement (HMR) runs. If the import maps fail to regenerate during HMR, you can restart your application and execute the payload generate:importmap
command to manually create a new import map. If you encounter any errors running this command, see the Troubleshooting section.
Component paths in external packages
Component paths are resolved relative to your project's base directory, which is either your current working directory or the directory specified in config.admin.baseDir
. When using custom components from external packages, you can't use relative paths. Instead, use an import path that's accessible as if you were writing an import statement in your project's base directory.
For example, to export a field with a custom component from an external package named my-external-package
:
Despite MyFieldComponent
living in src/components/MyFieldComponent.tsx
in my-external-package
, this will not be accessible from the consuming project. Instead, we recommend exporting all custom components from one file in the external package. For example, you can define a src/client.ts file in
my-external-package`:
Then, update the package.json of `my-external-package:
This setup allows you to specify the component path as my-external-package/client#MyFieldComponent
as seen above. The import map will generate:
which is a valid way to access MyFieldComponent that can be resolved by the consuming project.
Custom Components from unknown locations
By default, any component paths from known locations are added to the import map. However, if you need to add any components from unknown locations to the import map, you can do so by adding them to the admin.dependencies
array in your Payload Config. This is mostly only relevant for plugin authors and not for regular Payload users.
Example:
This way, TestComponent
is added to the import map, no matter if it's referenced in a known location or not. On the client, you can then use the component like this:
Root Components
Root Components are those that effect the Admin Panel generally, such as the logo or the main nav.
To override Root Components, use the admin.components
property in your Payload Config:
For details on how to build Custom Components, see Building Custom Components.
The following options are available:
Path | Description |
---|---|
Nav | Contains the sidebar / mobile menu in its entirety. |
beforeNavLinks | An array of Custom Components to inject into the built-in Nav, before the links themselves. |
afterNavLinks | An array of Custom Components to inject into the built-in Nav, after the links. |
beforeDashboard | An array of Custom Components to inject into the built-in Dashboard, before the default dashboard contents. |
afterDashboard | An array of Custom Components to inject into the built-in Dashboard, after the default dashboard contents. |
beforeLogin | An array of Custom Components to inject into the built-in Login, before the default login form. |
afterLogin | An array of Custom Components to inject into the built-in Login, after the default login form. |
logout.Button | The button displayed in the sidebar that logs the user out. |
graphics.Icon | The simplified logo used in contexts like the the Nav component. |
graphics.Logo | The full logo used in contexts like the Login view. |
providers | Custom React Context providers that will wrap the entire Admin Panel. More details. |
actions | An array of Custom Components to be rendered within the header of the Admin Panel, providing additional interactivity and functionality. |
header | An array of Custom Components to be injected above the Payload header. |
views | Override or create new views within the Admin Panel. More details. |
Custom Providers
As you add more and more Custom Components to your Admin Panel, you may find it helpful to add additional React Context(s). Payload allows you to inject your own context providers in your app so you can export your own custom hooks, etc.
To add a Custom Provider, use the admin.components.providers
property in your Payload Config:
Then build your Custom Provider as follows:
Building Custom Components
All Custom Components in Payload are React Server Components by default, with the exception of Custom Providers. This enables the use of the Local API directly on the front-end, among other things.
To make building Custom Components as easy as possible, Payload automatically provides common props, such as the payload
class and the i18n
object. This means that when building Custom Components within the Admin Panel, you do not have to get these yourself.
Here is an example:
Each Custom Component receives the following props by default:
Custom Components also receive various other props that are specific to the context in which the Custom Component is being rendered. For example, Custom Views receive the user
prop. For a full list of available props, consult the documentation related to the specific component you are working with.
Client Components
When Building Custom Components, it's still possible to use client-side code such as useState
or the window
object. To do this, simply add the use client
directive at the top of your file. Payload will automatically detect and remove all default, non-serializable props before rendering your component.
Accessing the Payload Config
From any Server Component, the Payload Config can be accessed directly from the payload
prop:
But, the Payload Config is non-serializable by design. It is full of custom validation functions, React components, etc. This means that the Payload Config, in its entirety, cannot be passed directly to Client Components.
For this reason, Payload creates a Client Config and passes it into the Config Provider. This is a serializable version of the Payload Config that can be accessed from any Client Component via the useConfig
hook:
All Field Components automatically receive their respective Field Config through a common field
prop:
Using Hooks
To make it easier to build your Custom Components, you can use Payload's built-in React Hooks in any Client Component. For example, you might want to interact with one of Payload's many React Contexts:
Getting the Current Language
All Custom Components can support multiple languages to be consistent with Payload's Internationalization. To do this, first add your translation resources to the I18n Config.
From any Server Component, you can translate resources using the getTranslation
function from @payloadcms/translations
. All Server Components automatically receive the i18n
object as a prop by default.
The best way to do this within a Client Component is to import the useTranslation
hook from @payloadcms/ui
:
Getting the Current Locale
All Custom Views can support multiple locales to be consistent with Payload's Localization. They automatically receive the locale
object as a prop by default. This can be used to scope API requests, etc.:
The best way to do this within a Client Component is to import the useLocale
hook from @payloadcms/ui
:
Styling Custom Components
Payload has a robust CSS Library that you can use to style your Custom Components similarly to Payload's built-in styling. This will ensure that your Custom Components match the existing design system, and so that they automatically adapt to any theme changes that might occur.
To apply custom styles, simply import your own .css
or .scss
file into your Custom Component:
Then to colorize your Custom Component's background, for example, you can use the following CSS:
Payload also exports its SCSS library for reuse which includes mixins, etc. To use this, simply import it as follows into your .scss
file: