diff --git a/docs/configuration/globals.mdx b/docs/configuration/globals.mdx index d06b158b1..6516f1dd6 100644 --- a/docs/configuration/globals.mdx +++ b/docs/configuration/globals.mdx @@ -12,19 +12,19 @@ As with Collection configs, it's often best practice to write your Globals in se ## Options -| Option | Description | -|--------------------| -------------| -| **`slug`** * | Unique, URL-friendly string that will act as an identifier for this Global. | +| Option | Description | +|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **`slug`** * | Unique, URL-friendly string that will act as an identifier for this Global. | | **`fields`** * | Array of field types that will determine the structure and functionality of the data stored within this Global. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. | -| **`label`** | Singular label for use in identifying this Global throughout Payload. Auto-generated from slug if not defined. | -| **`description`** | Text or React component to display below the Global header to give editors more information. | -| **`admin`** | Admin-specific configuration. See below for [more detail](/docs/configuration/globals#admin-options). | -| **`hooks`** | Entry points to "tie in" to collection actions at specific points. [More](/docs/hooks/overview#global-hooks) | -| **`access`** | Provide access control functions to define exactly who should be able to do what with this Global. [More](/docs/access-control/overview/#globals) | -| **`versions`** | Set to true to enable default options, or configure with object properties. [More](/docs/versions/overview#globals-config)| -| **`endpoints`** | Add custom routes to the REST API. [More](/docs/rest-api/overview#custom-endpoints)| -| **`graphQL.name`** | Text used in schema generation. Auto-generated from slug if not defined. | -| **`typescript`** | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined. | +| **`label`** | Text for the name in the Admin panel or an object with keys for each language. Auto-generated from slug if not defined. | +| **`description`** | Text or React component to display below the Global header to give editors more information. | +| **`admin`** | Admin-specific configuration. See below for [more detail](/docs/configuration/globals#admin-options). | +| **`hooks`** | Entry points to "tie in" to collection actions at specific points. [More](/docs/hooks/overview#global-hooks) | +| **`access`** | Provide access control functions to define exactly who should be able to do what with this Global. [More](/docs/access-control/overview/#globals) | +| **`versions`** | Set to true to enable default options, or configure with object properties. [More](/docs/versions/overview#globals-config) | +| **`endpoints`** | Add custom routes to the REST API. [More](/docs/rest-api/overview#custom-endpoints) | +| **`graphQL.name`** | Text used in schema generation. Auto-generated from slug if not defined. | +| **`typescript`** | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined. | *\* An asterisk denotes that a property is required.* diff --git a/docs/fields/array.mdx b/docs/fields/array.mdx index f8ba6e5c2..c0d859f9c 100644 --- a/docs/fields/array.mdx +++ b/docs/fields/array.mdx @@ -21,21 +21,21 @@ keywords: array, fields, config, configuration, documentation, Content Managemen ### Config -| Option | Description | -| ---------------- | ----------- | -| **`name`** * | To be used as the property name when stored and retrieved from the database. | -| **`label`** | Used as a heading in the Admin panel and to name the generated GraphQL type. Auto-generated from name if not defined. | -| **`fields`** * | Array of field types to correspond to each row of the Array. | -| **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | -| **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. | -| **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | -| **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | -| **`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. | -| **`defaultValue`** | Provide an array of row data to be used for this field's default value. [More](/docs/fields/overview#default-values) | +| Option | Description | +| ---------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **`name`** * | To be used as the property name when stored and retrieved from the database. | +| **`label`** | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined. | +| **`fields`** * | Array of field types to correspond to each row of the Array. | +| **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | +| **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. | +| **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | +| **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) | +| **`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. | +| **`defaultValue`** | Provide an array of row data to be used for this field's default value. [More](/docs/fields/overview#default-values) | | **`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`. | -| **`required`** | Require this field to have a value. | -| **`labels`** | Customize the row labels appearing in the Admin dashboard. | -| **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | +| **`required`** | Require this field to have a value. | +| **`labels`** | Customize the row labels appearing in the Admin dashboard. | +| **`admin`** | Admin-specific configuration. See below for [more detail](#admin-config). | *\* An asterisk denotes that a property is required.* diff --git a/docs/fields/blocks.mdx b/docs/fields/blocks.mdx index 305a70ce3..72b15e933 100644 --- a/docs/fields/blocks.mdx +++ b/docs/fields/blocks.mdx @@ -25,7 +25,7 @@ keywords: blocks, fields, config, configuration, documentation, Content Manageme | Option | Description | |-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **`name`** * | To be used as the property name when stored and retrieved from the database. | -| **`label`** | Used as a heading in the Admin panel. | +| **`label`** | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined. | | **`blocks`** * | Array of [block configs](/docs/fields/blocks#block-configs) to be made available to this field. | | **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | | **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. | diff --git a/docs/fields/checkbox.mdx b/docs/fields/checkbox.mdx index 1e419676b..b768312f9 100644 --- a/docs/fields/checkbox.mdx +++ b/docs/fields/checkbox.mdx @@ -14,8 +14,8 @@ keywords: checkbox, fields, config, configuration, documentation, Content Manage | Option | Description | | ---------------- | ----------- | -| **`name`** * | To be used as the property name when stored and retrieved from the database. | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`name`** * | To be used as the property name when stored and retrieved from the database. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | | **`index`** | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | | **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. | diff --git a/docs/fields/code.mdx b/docs/fields/code.mdx index f7985523a..146e6bf12 100644 --- a/docs/fields/code.mdx +++ b/docs/fields/code.mdx @@ -18,7 +18,7 @@ This field uses `prismjs` for syntax highlighting and `react-simple-code-editor` | Option | Description | | ---------------- | ----------- | | **`name`** * | To be used as the property name when stored and retrieved from the database. | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | | **`index`** | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | | **`minLength`** | Used by the default validation function to ensure values are of a minimum character length. | diff --git a/docs/fields/date.mdx b/docs/fields/date.mdx index 60057c7b6..f367f3e42 100644 --- a/docs/fields/date.mdx +++ b/docs/fields/date.mdx @@ -18,7 +18,7 @@ This field uses [`react-datepicker`](https://www.npmjs.com/package/react-datepic | Option | Description | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`name`** \* | To be used as the property name when stored and retrieved from the database. | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`index`** | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | | **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | | **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. | diff --git a/docs/fields/email.mdx b/docs/fields/email.mdx index b2d895259..f639837fb 100644 --- a/docs/fields/email.mdx +++ b/docs/fields/email.mdx @@ -15,7 +15,7 @@ keywords: email, fields, config, configuration, documentation, Content Managemen | Option | Description | | ---------------- | ----------- | | **`name`** * | To be used as the property name when stored and retrieved from the database. | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | | **`index`** | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | | **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | diff --git a/docs/fields/number.mdx b/docs/fields/number.mdx index 2023080f2..f0663872c 100644 --- a/docs/fields/number.mdx +++ b/docs/fields/number.mdx @@ -15,7 +15,7 @@ keywords: number, fields, config, configuration, documentation, Content Manageme | Option | Description | | ---------------- | ----------- | | **`name`** * | To be used as the property name when stored and retrieved from the database. | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`min`** | Minimum value accepted. Used in the default `validation` function. | | **`max`** | Maximum value accepted. Used in the default `validation` function. | | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | diff --git a/docs/fields/radio.mdx b/docs/fields/radio.mdx index b3f85304c..1c1fdc93c 100644 --- a/docs/fields/radio.mdx +++ b/docs/fields/radio.mdx @@ -16,7 +16,7 @@ keywords: radio, fields, config, configuration, documentation, Content Managemen | ---------------- | ----------- | | **`name`** * | To be used as the property name when stored and retrieved from the database. | | **`options`** * | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing an `label` string and a `value` string. | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | | **`index`** | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | | **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. | diff --git a/docs/fields/relationship.mdx b/docs/fields/relationship.mdx index a64122d07..14547574d 100644 --- a/docs/fields/relationship.mdx +++ b/docs/fields/relationship.mdx @@ -25,7 +25,7 @@ keywords: relationship, fields, config, configuration, documentation, Content Ma | **`filterOptions`** | A query to filter which options appear in the UI and validate against. [More](#filtering-relationship-options). | | **`hasMany`** | Boolean when, if set to `true`, allows this field to have many relations instead of only one. | | **`maxDepth`** | Sets a number limit on iterations of related documents to populate when queried. [Depth](/docs/getting-started/concepts#depth) | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | | **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | | **`index`** | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | diff --git a/docs/fields/rich-text.mdx b/docs/fields/rich-text.mdx index ede954ee8..08324143f 100644 --- a/docs/fields/rich-text.mdx +++ b/docs/fields/rich-text.mdx @@ -21,7 +21,7 @@ The Admin component is built on the powerful [`slatejs`](https://docs.slatejs.or | Option | Description | | ---------------- | ----------- | | **`name`** * | To be used as the property name when stored and retrieved from the database. | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | | **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. | | **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) | diff --git a/docs/fields/select.mdx b/docs/fields/select.mdx index 9df50056c..424aca4f3 100644 --- a/docs/fields/select.mdx +++ b/docs/fields/select.mdx @@ -14,11 +14,11 @@ keywords: select, multi-select, fields, config, configuration, documentation, Co ### Config | Option | Description | -| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ------------------ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **`name`** \* | To be used as the property name when stored and retrieved from the database. | | **`options`** \* | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing a `label` string and a `value` string. | | **`hasMany`** | Boolean when, if set to `true`, allows this field to have many selections instead of only one. | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | | **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | | **`index`** | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | diff --git a/docs/fields/text.mdx b/docs/fields/text.mdx index a5bf0770a..a5b4344b6 100644 --- a/docs/fields/text.mdx +++ b/docs/fields/text.mdx @@ -14,8 +14,8 @@ keywords: text, fields, config, configuration, documentation, Content Management | Option | Description | | ---------------- | ----------- | -| **`name`** * | To be used as the property name when stored and retrieved from the database. | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`name`** * | To be used as the property name when stored and retrieved from the database. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | | **`minLength`** | Used by the default validation function to ensure values are of a minimum character length. | | **`maxLength`** | Used by the default validation function to ensure values are of a maximum character length. | diff --git a/docs/fields/textarea.mdx b/docs/fields/textarea.mdx index bbc0eccb8..3240c3840 100644 --- a/docs/fields/textarea.mdx +++ b/docs/fields/textarea.mdx @@ -15,7 +15,7 @@ keywords: textarea, fields, config, configuration, documentation, Content Manage | Option | Description | | ---------------- | ----------- | | **`name`** * | To be used as the property name when stored and retrieved from the database. | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | | **`minLength`** | Used by the default validation function to ensure values are of a minimum character length. | | **`maxLength`** | Used by the default validation function to ensure values are of a maximum character length. | diff --git a/docs/fields/upload.mdx b/docs/fields/upload.mdx index 6382ff9da..a2b1f92c4 100644 --- a/docs/fields/upload.mdx +++ b/docs/fields/upload.mdx @@ -29,7 +29,7 @@ keywords: upload, images media, fields, config, configuration, documentation, Co | **`*relationTo`** * | Provide a single collection `slug` to allow this field to accept a relation to. Note: the related collection must be configured to support Uploads. | | **`filterOptions`** | A query to filter which options appear in the UI and validate against. [More](#filtering-relationship-options). | | **`maxDepth`** | Sets a number limit on iterations of related documents to populate when queried. [Depth](/docs/getting-started/concepts#depth) | -| **`label`** | Used as a field label in the Admin panel and to name the generated GraphQL type. | +| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. | | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | | **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) | | **`index`** | Build a [MongoDB index](https://docs.mongodb.com/manual/indexes/) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |