Skip to content

Commit d91478c

Browse files
r1tsuur1tsuu
authored
docs: virtual fields linking with relationship fields (#12145)
Adds docs for these changes #11805
1 parent 6dc61ae commit d91478c

19 files changed

+396
-357
lines changed

‎docs/configuration/collections.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -120,25 +120,25 @@ export const MyCollection: CollectionConfig = {
120120

121121
The following options are available:
122122

123-
| Option | Description |
124-
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
125-
| `group` | Text or localization object used to group Collection and Global links in the admin navigation. Set to `false` to hide the link from the navigation while keeping its routes accessible. |
126-
| `hidden` | Set to true or a function, called with the current user, returning true to exclude this Collection from navigation and admin routing. |
127-
| `hooks` | Admin-specific hooks for this Collection. [More details](../hooks/collections). |
128-
| `useAsTitle` | Specify a top-level field to use for a document title throughout the Admin Panel. If no field is defined, the ID of the document is used as the title. A field with `virtual: true` cannot be used as the title. |
129-
| `description` | Text to display below the Collection label in the List View to give editors more information. Alternatively, you can use the `admin.components.Description` to render a React component. [More details](#custom-components). |
130-
| `defaultColumns` | Array of field names that correspond to which columns to show by default in this Collection's List View. |
131-
| `disableCopyToLocale` | Disables the "Copy to Locale" button while editing documents within this Collection. Only applicable when localization is enabled. |
132-
| `hideAPIURL` | Hides the "API URL" meta field while editing documents within this Collection. |
133-
| `enableRichTextLink` | The [Rich Text](../fields/rich-text) field features a `Link` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default. |
134-
| `enableRichTextRelationship` | The [Rich Text](../fields/rich-text) field features a `Relationship` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default. |
135-
| `meta` | Page metadata overrides to apply to this Collection within the Admin Panel. [More details](../admin/metadata). |
136-
| `preview` | Function to generate preview URLs within the Admin Panel that can point to your app. [More details](../admin/preview). |
137-
| `livePreview` | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview). |
138-
| `components` | Swap in your own React components to be used within this Collection. [More details](#custom-components). |
139-
| `listSearchableFields` | Specify which fields should be searched in the List search view. [More details](#list-searchable-fields). |
140-
| `pagination` | Set pagination-specific options for this Collection. [More details](#pagination). |
141-
| `baseListFilter` | You can define a default base filter for this collection's List view, which will be merged into any filters that the user performs. |
123+
| Option | Description |
124+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
125+
| `group` | Text or localization object used to group Collection and Global links in the admin navigation. Set to `false` to hide the link from the navigation while keeping its routes accessible. |
126+
| `hidden` | Set to true or a function, called with the current user, returning true to exclude this Collection from navigation and admin routing. |
127+
| `hooks` | Admin-specific hooks for this Collection. [More details](../hooks/collections). |
128+
| `useAsTitle` | Specify a top-level field to use for a document title throughout the Admin Panel. If no field is defined, the ID of the document is used as the title. A field with `virtual: true` cannot be used as the title, unless it's linked to a relationship'. |
129+
| `description` | Text to display below the Collection label in the List View to give editors more information. Alternatively, you can use the `admin.components.Description` to render a React component. [More details](#custom-components). |
130+
| `defaultColumns` | Array of field names that correspond to which columns to show by default in this Collection's List View. |
131+
| `disableCopyToLocale` | Disables the "Copy to Locale" button while editing documents within this Collection. Only applicable when localization is enabled. |
132+
| `hideAPIURL` | Hides the "API URL" meta field while editing documents within this Collection. |
133+
| `enableRichTextLink` | The [Rich Text](../fields/rich-text) field features a `Link` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default. |
134+
| `enableRichTextRelationship` | The [Rich Text](../fields/rich-text) field features a `Relationship` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default. |
135+
| `meta` | Page metadata overrides to apply to this Collection within the Admin Panel. [More details](../admin/metadata). |
136+
| `preview` | Function to generate preview URLs within the Admin Panel that can point to your app. [More details](../admin/preview). |
137+
| `livePreview` | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview). |
138+
| `components` | Swap in your own React components to be used within this Collection. [More details](#custom-components). |
139+
| `listSearchableFields` | Specify which fields should be searched in the List search view. [More details](#list-searchable-fields). |
140+
| `pagination` | Set pagination-specific options for this Collection. [More details](#pagination). |
141+
| `baseListFilter` | You can define a default base filter for this collection's List view, which will be merged into any filters that the user performs. |
142142

143143
### Custom Components
144144

0 commit comments

Comments
 (0)