createCollectionAdminOptions
Defines admin configuration for a Payload collection, such as base list filter, preview function, pagination, and hidden fields.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| baseListFilter | Yes | Function expression (e.g., "({ req }) => req.user.role === 'admin'") | |
| components | Yes | ||
| custom | Yes | ||
| defaultColumns | Yes | ||
| description | No | One of the allowed types | |
| disableCopyToLocale | Yes | ||
| enableRichTextLink | Yes | ||
| enableRichTextRelationship | Yes | ||
| group | No | One of the allowed types | |
| hidden | No | One of the allowed types | |
| hideAPIURL | Yes | ||
| listSearchableFields | Yes | ||
| livePreview | Yes | ||
| meta | Yes | any configuration object | |
| pagination | Yes | ||
| preview | Yes | Function expression (e.g., "({ req }) => req.user.role === 'admin'") | |
| useAsTitle | Yes |