Skip to content

docs: add note about condition with custom field component #8440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
r1tsuu wants to merge 1 commit into from
Closed

docs: add note about condition with custom field component #8440

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/admin/fields.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,3 +569,20 @@ The `condition` function should return a boolean that will control if the field
]
}
```

<Banner type="warning">
<strong>Note:</strong>
When using [Custom Field Components](#field-components) and `condition` together, you need to wrap them with the `withCondition` HOC.
Example:
```tsx
'use client'
import { withCondition } from '@payloadcms/ui'
import React from 'react'

const Component: TextFieldClientComponent = ({ field }) => {
return <input placeholder="custom component" name={field.name} />
}

export const CustomTextFieldClient = withCondition(Component)
```
</Banner>