feat!: on demand rsc (#8364)

Currently, Payload renders all custom components on initial compile of
the admin panel. This is problematic for two key reasons:
1. Custom components do not receive contextual data, i.e. fields do not
receive their field data, edit views do not receive their document data,
etc.
2. Components are unnecessarily rendered before they are used

This was initially required to support React Server Components within
the Payload Admin Panel for two key reasons:
1. Fields can be dynamically rendered within arrays, blocks, etc.
2. Documents can be recursively rendered within a "drawer" UI, i.e.
relationship fields
3. Payload supports server/client component composition 

In order to achieve this, components need to be rendered on the server
and passed as "slots" to the client. Currently, the pattern for this is
to render custom server components in the "client config". Then when a
view or field is needed to be rendered, we first check the client config
for a "pre-rendered" component, otherwise render our client-side
fallback component.

But for the reasons listed above, this pattern doesn't exactly make
custom server components very useful within the Payload Admin Panel,
which is where this PR comes in. Now, instead of pre-rendering all
components on initial compile, we're able to render custom components
_on demand_, only as they are needed.

To achieve this, we've established [this
pattern](https://github.com/payloadcms/payload/pull/8481) of React
Server Functions in the Payload Admin Panel. With Server Functions, we
can iterate the Payload Config and return JSX through React's
`text/x-component` content-type. This means we're able to pass
contextual props to custom components, such as data for fields and
views.

## Breaking Changes

1. Add the following to your root layout file, typically located at
`(app)/(payload)/layout.tsx`:

    ```diff
    /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
    /* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
    + import type { ServerFunctionClient } from 'payload'

    import config from '@payload-config'
    import { RootLayout } from '@payloadcms/next/layouts'
    import { handleServerFunctions } from '@payloadcms/next/utilities'
    import React from 'react'

    import { importMap } from './admin/importMap.js'
    import './custom.scss'

    type Args = {
      children: React.ReactNode
    }

+ const serverFunctions: ServerFunctionClient = async function (args) {
    +  'use server'
    +  return handleServerFunctions({
    +    ...args,
    +    config,
    +    importMap,
    +  })
    + }

    const Layout = ({ children }: Args) => (
      <RootLayout
        config={config}
        importMap={importMap}
    +  serverFunctions={serverFunctions}
      >
        {children}
      </RootLayout>
    )

    export default Layout
    ```

2. If you were previously posting to the `/api/form-state` endpoint, it
no longer exists. Instead, you'll need to invoke the `form-state` Server
Function, which can be done through the _new_ `getFormState` utility:

    ```diff
    - import { getFormState } from '@payloadcms/ui'
    - const { state } = await getFormState({
    -   apiRoute: '',
    -   body: {
    -     // ...
    -   },
    -   serverURL: ''
    - })

    + const { getFormState } = useServerFunctions()
    +
    + const { state } = await getFormState({
    +   // ...
    + })
    ```

## Breaking Changes

```diff
- useFieldProps()
- useCellProps()
```

More details coming soon.

---------

Co-authored-by: Alessio Gravili <alessio@gravili.de>
Co-authored-by: Jarrod Flesch <jarrodmflesch@gmail.com>
Co-authored-by: James <james@trbl.design>
This commit is contained in:
Jacob Fletcher
2024-11-11 13:59:05 -05:00
committed by GitHub
parent 3e954f45c7
commit c96fa613bc
657 changed files with 34245 additions and 21057 deletions

View File

@@ -1,17 +1,18 @@
'use client'
import type { PayloadClientReactComponent, SanitizedConfig } from 'payload'
import type { CustomComponent, PayloadServerReactComponent } from 'payload'
import { RenderComponent, useConfig } from '@payloadcms/ui'
import { RenderServerComponent } from '@payloadcms/ui/elements/RenderServerComponent'
import React from 'react'
export const AfterDashboardClient: PayloadClientReactComponent<
SanitizedConfig['admin']['components']['afterDashboard'][0]
> = () => {
const { config } = useConfig()
import { Banner } from '../Banner/index.js'
export const AfterDashboardClient: PayloadServerReactComponent<CustomComponent> = ({ payload }) => {
return (
<div>
<Banner>
<p>Admin Dependency test component:</p>
<RenderComponent mappedComponent={config.admin.dependencies?.myTestComponent} />
</div>
<RenderServerComponent
Component={payload.config.admin.dependencies?.myTestComponent}
importMap={payload.importMap}
/>
</Banner>
)
}

View File

@@ -0,0 +1,19 @@
export function Banner(props: {
children?: React.ReactNode
description?: string
message?: string
}) {
const { children, description, message } = props
return (
<div
style={{
backgroundColor: 'var(--theme-warning-100)',
border: '1px dashed',
color: 'var(--theme-warning-750)',
padding: '1rem',
}}
>
{children || message || description || 'A custom banner component'}
</div>
)
}

View File

@@ -1,10 +1,9 @@
'use client'
import type { CellComponentProps } from 'payload'
import { useTableCell } from '@payloadcms/ui'
import type { DefaultCellComponentProps } from 'payload'
import React from 'react'
export const CustomCell: React.FC<CellComponentProps> = (props) => {
const context = useTableCell()
return <div>{`Custom cell: ${context.cellData || 'No data'}`}</div>
export const CustomCell: React.FC<DefaultCellComponentProps> = (props) => {
return <div>{`Custom cell: ${props?.rowData?.customCell || 'No data'}`}</div>
}

View File

@@ -12,7 +12,7 @@ export const CustomHeader: PayloadServerReactComponent<
className={baseClass}
style={{
alignItems: 'center',
backgroundColor: 'var(--theme-success-500)',
backgroundColor: 'var(--theme-success-100)',
display: 'flex',
minHeight: 'var(--app-header-height)',
padding: '0 var(--gutter-h)',
@@ -22,7 +22,7 @@ export const CustomHeader: PayloadServerReactComponent<
zIndex: 'var(--z-modal)',
}}
>
<p style={{ color: 'var(--theme-text)', margin: 0 }}>
<p style={{ color: 'var(--theme-success-750)', margin: 0 }}>
Here is a custom header inserted with admin.components.header
</p>
</div>

View File

@@ -2,5 +2,9 @@
import React from 'react'
export const TestComponent: React.FC = () => {
return <div>Test Component</div>
return (
<div>
Test Component from the global <code>admin.dependencies</code>
</div>
)
}

View File

@@ -1,7 +1,18 @@
'use client'
import type { StaticDescription } from 'payload'
import { ViewDescription as DefaultViewDescription } from '@payloadcms/ui'
import React from 'react'
export const ViewDescription: React.FC = () => {
return <p className="view-description">This is a custom view description component.</p>
import { Banner } from '../Banner/index.js'
export const ViewDescription: React.FC<{ description: StaticDescription }> = ({
description = 'This is a custom view description component.',
}) => {
return (
<Banner>
<DefaultViewDescription description={description} />
</Banner>
)
}

View File

@@ -0,0 +1,12 @@
export function Icon() {
return (
<div
style={{
backgroundColor: 'var(--theme-warning-400)',
borderRadius: '100%',
height: '18px',
width: '18px',
}}
/>
)
}

View File

@@ -0,0 +1,12 @@
export function Logo() {
return (
<div
style={{
backgroundColor: 'var(--theme-warning-400)',
borderRadius: '100%',
height: '18px',
width: '18px',
}}
/>
)
}