Skip to content

Commit fff60c8

Browse files
deepshekhardasdeepshekhardasPatrikKozak
authored
docs: fix links to virtual relationship documentation in both Blocks and Array field documentation (#15888)
Corrects links to virtual relationship documentation in both Blocks and Array field documentation --------- Co-authored-by: deepshekhardas <deepshekharadas1234@gmail.com> Co-authored-by: Patrik Kozak <35232443+PatrikKozak@users.noreply.github.com>
1 parent fd64504 commit fff60c8

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

docs/fields/array.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export const MyArrayField: Field = {
6060
| **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). |
6161
| **`dbName`** | Custom table name for the field when using SQL Database Adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined. |
6262
| **`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/relationship#linking-virtual-fields-with-relationships). See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) |
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) |
6464

6565
_\* An asterisk denotes that a property is required._
6666

docs/fields/blocks.mdx

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -42,26 +42,26 @@ This page is divided into two parts: first, the settings of the Blocks Field, an
4242

4343
### Block Config Options
4444

45-
| Option | Description |
46-
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
47-
| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More details](/docs/fields/overview#field-names). |
48-
| **`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. |
49-
| **`blocks`** \* | Array of [block configs](/docs/fields/blocks#config-options) to be made available to this field. |
50-
| **`validate`** | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More details](/docs/fields/overview#validation). |
51-
| **`minRows`** | A number for the fewest allowed items during validation when a value is present. |
52-
| **`maxRows`** | A number for the most allowed items during validation when a value is present. |
53-
| **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT. |
54-
| **`hooks`** | Provide Field Hooks to control logic for this field. [More details](../hooks/fields). |
55-
| **`access`** | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields). |
56-
| **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API response or the Admin Panel. |
57-
| **`defaultValue`** | Provide an array of block data to be used for this field's default value. [More details](/docs/fields/overview#default-values). |
58-
| **`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 field will be kept, so there is no need to specify each nested field as `localized`. |
59-
| **`unique`** | Enforce that each entry in the Collection has a unique value for this field. |
60-
| **`labels`** | Customize the block row labels appearing in the Admin dashboard. |
61-
| **`admin`** | Admin-specific configuration. [More details](#admin-options). |
62-
| **`custom`** | Extension point for adding custom data (e.g. for plugins) |
63-
| **`typescriptSchema`** | Override field type generation with providing a JSON schema |
64-
| **`virtual`** | Provide `true` to disable field in the database, or provide a string path to [link the field with a relationship](/docs/fields/relationship#linking-virtual-fields-with-relationships). See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) |
45+
| Option | Description |
46+
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
47+
| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More details](/docs/fields/overview#field-names). |
48+
| **`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. |
49+
| **`blocks`** \* | Array of [block configs](/docs/fields/blocks#config-options) to be made available to this field. |
50+
| **`validate`** | Provide a custom validation function that will be executed on both the Admin Panel and the backend. [More details](/docs/fields/overview#validation). |
51+
| **`minRows`** | A number for the fewest allowed items during validation when a value is present. |
52+
| **`maxRows`** | A number for the most allowed items during validation when a value is present. |
53+
| **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/overview), include its data in the user JWT. |
54+
| **`hooks`** | Provide Field Hooks to control logic for this field. [More details](../hooks/fields). |
55+
| **`access`** | Provide Field Access Control to denote what users can see and do with this field's data. [More details](../access-control/fields). |
56+
| **`hidden`** | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API response or the Admin Panel. |
57+
| **`defaultValue`** | Provide an array of block data to be used for this field's default value. [More details](/docs/fields/overview#default-values). |
58+
| **`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 field will be kept, so there is no need to specify each nested field as `localized`. |
59+
| **`unique`** | Enforce that each entry in the Collection has a unique value for this field. |
60+
| **`labels`** | Customize the block row labels appearing in the Admin dashboard. |
61+
| **`admin`** | Admin-specific configuration. [More details](#admin-options). |
62+
| **`custom`** | Extension point for adding custom data (e.g. for plugins) |
63+
| **`typescriptSchema`** | Override field type generation with providing a JSON schema |
64+
| **`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) |
6565

6666
_\* An asterisk denotes that a property is required._
6767

0 commit comments

Comments
 (0)