You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**`name`**\*| To be used as the property name when stored and retrieved from the database. [More details](/docs/fields/overview#field-names). |
45
-
|**`label`**| Text used as the heading in the [Admin Panel](../admin/overview) or an object with keys for each language. Auto-generated from name if not defined. |
46
-
|**`fields`**\*| Array of field types to correspond to each row of the Array. |
47
-
|**`validate`**| Provide a custom validation function that will be executed on both the [Admin Panel](../admin/overview) and the backend. [More details](/docs/fields/overview#validation). |
48
-
|**`minRows`**| A number for the fewest allowed items during validation when a value is present. |
49
-
|**`maxRows`**| A number for the most allowed items during validation when a value is present. |
50
-
|**`saveToJWT`**| If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT. |
51
-
|**`hooks`**| Provide Field Hooks to control logic for this field. [More details](../hooks/fields). |
52
-
|**`access`**| Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields). |
53
-
|**`hidden`**| Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel. |
54
-
|**`defaultValue`**| Provide an array of row data to be used for this field's default value. [More details](/docs/fields/overview#default-values). |
55
-
|**`localized`**| Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Array will be kept, so there is no need to specify each nested field as `localized`. |
56
-
|**`required`**| Require this field to have a value. |
57
-
|**`labels`**| Customize the row labels appearing in the Admin dashboard. |
|**`custom`**| Extension point for adding custom data (e.g. for plugins) |
60
-
|**`interfaceName`**| Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). |
61
-
|**`dbName`**| Custom table name for the field when using SQL Database Adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined. |
62
-
|**`typescriptSchema`**| Override field type generation with providing a JSON schema |
63
-
|**`virtual`**| Provide `true` to disable field in the database, or provide a string path to [link the field with a relationship](/docs/fields/overview#string-path-virtual-fields). See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges)|
|**`name`**\*| To be used as the property name when stored and retrieved from the database. [More details](/docs/fields/overview#field-names). |
45
+
|**`label`**| Text used as the heading in the [Admin Panel](../admin/overview) or an object with keys for each language. Auto-generated from name if not defined. |
46
+
|**`fields`**\*| Array of field types to correspond to each row of the Array. |
47
+
|**`validate`**| Provide a custom validation function that will be executed on both the [Admin Panel](../admin/overview) and the backend. [More details](/docs/fields/overview#validation). |
48
+
|**`minRows`**| A number for the fewest allowed items during validation when a value is present. |
49
+
|**`maxRows`**| A number for the most allowed items during validation when a value is present. |
50
+
|**`saveToJWT`**| If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT. |
51
+
|**`hooks`**| Provide Field Hooks to control logic for this field. [More details](../hooks/fields). |
52
+
|**`access`**| Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields). |
53
+
|**`hidden`**| Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin Panel. |
54
+
|**`defaultValue`**| Provide an array of row data to be used for this field's default value. [More details](/docs/fields/overview#default-values). |
55
+
|**`localized`**| Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config. If enabled, a separate, localized set of all data within this Array will be kept, so there is no need to specify each nested field as `localized`. |
56
+
|**`required`**| Require this field to have a value. |
57
+
|**`labels`**| Customize the row labels appearing in the Admin dashboard. |
|**`custom`**| Extension point for adding custom data (e.g. for plugins) |
60
+
|**`interfaceName`**| Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). |
61
+
|**`dbName`**| Custom table name for the field when using SQL Database Adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined. |
62
+
|**`jsonSchema`**| Override field json schema used for type generation and mcp validation|
63
+
|**`virtual`**| Provide `true` to disable field in the database, or provide a string path to [link the field with a relationship](/docs/fields/overview#string-path-virtual-fields). See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges)|
64
64
65
65
_\* An asterisk denotes that a property is required._
0 commit comments