diff --git a/docs/admin/views.mdx b/docs/admin/views.mdx index 50f138a9497..29f10439957 100644 --- a/docs/admin/views.mdx +++ b/docs/admin/views.mdx @@ -89,14 +89,14 @@ For more granular control, pass a configuration object instead. Payload exposes | Property | Description | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **`Component`** \* | Pass in the component path that should be rendered when a user navigates to this route. | -| **`path`** \* | Any valid URL path or array of paths that [`path-to-regexp`](https://www.npmjs.com/package/path-to-regex) understands. | +| **`Component`** * | Pass in the component path that should be rendered when a user navigates to this route. | +| **`path`** * | Any valid URL path or array of paths that [`path-to-regexp`](https://www.npmjs.com/package/path-to-regex) understands. | | **`exact`** | Boolean. When true, will only match if the path matches the `usePathname()` exactly. | | **`strict`** | When true, a path that has a trailing slash will only match a `location.pathname` with a trailing slash. This has no effect when there are additional URL segments in the pathname. | | **`sensitive`** | When true, will match if the path is case sensitive.| | **`meta`** | Page metadata overrides to apply to this view within the Admin Panel. [More details](./metadata). | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ### Adding New Views diff --git a/docs/authentication/custom-strategies.mdx b/docs/authentication/custom-strategies.mdx index 027080d8a0a..c8fdb2dbd6c 100644 --- a/docs/authentication/custom-strategies.mdx +++ b/docs/authentication/custom-strategies.mdx @@ -19,15 +19,15 @@ A strategy is made up of the following: | Parameter | Description | | --------------------------- | ------------------------------------------------------------------------- | -| **`name`** \* | The name of your strategy | -| **`authenticate`** \* | A function that takes in the parameters below and returns a user or null. | +| **`name`** * | The name of your strategy | +| **`authenticate`** * | A function that takes in the parameters below and returns a user or null. | The `authenticate` function is passed the following arguments: | Argument | Description | | ------------------- | ------------------------------------------------------------------------------------------------- | -| **`headers`** \* | The headers on the incoming request. Useful for retrieving identifiable information on a request. | -| **`payload`** \* | The Payload class. Useful for authenticating the identifiable information against Payload. | +| **`headers`** * | The headers on the incoming request. Useful for retrieving identifiable information on a request. | +| **`payload`** * | The Payload class. Useful for authenticating the identifiable information against Payload. | | **`isGraphQL`** | Whether or not the request was made from a GraphQL endpoint. Default is `false`. | diff --git a/docs/configuration/collections.mdx b/docs/configuration/collections.mdx index 41cdf0192a3..a8699f38970 100644 --- a/docs/configuration/collections.mdx +++ b/docs/configuration/collections.mdx @@ -67,19 +67,19 @@ The following options are available: | **`defaultSort`** | Pass a top-level field to sort by default in the Collection List View. Prefix the name of the field with a minus symbol ("-") to sort in descending order. Multiple fields can be specified by using a string array. | | **`dbName`** | Custom table or Collection name depending on the Database Adapter. Auto-generated from slug if not defined. | | **`endpoints`** | Add custom routes to the REST API. Set to `false` to disable routes. [More details](../rest-api/overview#custom-endpoints). | -| **`fields`** \* | Array of field types that will determine the structure and functionality of the data stored within this Collection. [More details](../fields/overview). | +| **`fields`** * | Array of field types that will determine the structure and functionality of the data stored within this Collection. [More details](../fields/overview). | | **`graphQL`** | Manage GraphQL-related properties for this collection. [More](#graphql) | | **`hooks`** | Entry point for Hooks. [More details](../hooks/overview#collection-hooks). | | **`labels`** | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined. | | **`lockDocuments`** | Enables or disables document locking. By default, document locking is enabled. Set to an object to configure, or set to `false` to disable locking. [More details](../admin/locked-documents). | -| **`slug`** \* | Unique, URL-friendly string that will act as an identifier for this Collection. | +| **`slug`** * | Unique, URL-friendly string that will act as an identifier for this Collection. | | **`timestamps`** | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps. | | **`typescript`** | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined. | | **`upload`** | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](../upload/overview) documentation. | | **`versions`** | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#collection-config). | | **`defaultPopulate`** | Specify which fields to select when this Collection is populated from another document. [More Details](../queries/select#defaultpopulate-collection-config-property). | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ### Fields diff --git a/docs/configuration/globals.mdx b/docs/configuration/globals.mdx index 0ec2c665e60..7fde9cf60c3 100644 --- a/docs/configuration/globals.mdx +++ b/docs/configuration/globals.mdx @@ -73,16 +73,16 @@ The following options are available: | **`dbName`** | Custom table or collection name for this Global depending on the Database Adapter. Auto-generated from slug if not defined. | | **`description`** | Text or React component to display below the Global header to give editors more information. | | **`endpoints`** | Add custom routes to the REST API. [More details](../rest-api/overview#custom-endpoints). | -| **`fields`** \* | Array of field types that will determine the structure and functionality of the data stored within this Global. [More details](../fields/overview). | +| **`fields`** * | Array of field types that will determine the structure and functionality of the data stored within this Global. [More details](../fields/overview). | | **`graphQL`** | Manage GraphQL-related properties related to this global. [More details](#graphql) | | **`hooks`** | Entry point for Hooks. [More details](../hooks/overview#global-hooks). | | **`label`** | Text for the name in the Admin Panel or an object with keys for each language. Auto-generated from slug if not defined. | | **`lockDocuments`** | Enables or disables document locking. By default, document locking is enabled. Set to an object to configure, or set to `false` to disable locking. [More details](../admin/locked-documents). | -| **`slug`** \* | Unique, URL-friendly string that will act as an identifier for this Global. | +| **`slug`** * | Unique, URL-friendly string that will act as an identifier for this Global. | | **`typescript`** | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined. | | **`versions`** | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#globals-config). | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ### Fields diff --git a/docs/configuration/localization.mdx b/docs/configuration/localization.mdx index 93a72866296..64e3097e808 100644 --- a/docs/configuration/localization.mdx +++ b/docs/configuration/localization.mdx @@ -93,12 +93,12 @@ The locale codes do not need to be in any specific format. It's up to you to def | Option | Description | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| **`code`** \* | Unique code to identify the language throughout the APIs for `locale` and `fallbackLocale` | +| **`code`** * | Unique code to identify the language throughout the APIs for `locale` and `fallbackLocale` | | **`label`** | A string to use for the selector when choosing a language, or an object keyed on the i18n keys for different languages in use. | | **`rtl`** | A boolean that when true will make the admin UI display in Right-To-Left. | | **`fallbackLocale`** | The code for this language to fallback to when properties of a document are not present. | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Field Localization diff --git a/docs/configuration/overview.mdx b/docs/configuration/overview.mdx index d304da7f2d0..d1ed657b7f8 100644 --- a/docs/configuration/overview.mdx +++ b/docs/configuration/overview.mdx @@ -68,7 +68,7 @@ The following options are available: | **`admin`** | The configuration options for the Admin Panel, including Custom Components, Live Preview, etc. [More details](../admin/overview#admin-options). | | **`bin`** | Register custom bin scripts for Payload to execute. | | **`editor`** | The Rich Text Editor which will be used by `richText` fields. [More details](../rich-text/overview). | -| **`db`** \* | The Database Adapter which will be used by Payload. [More details](../database/overview). | +| **`db`** * | The Database Adapter which will be used by Payload. [More details](../database/overview). | | **`serverURL`** | A string used to define the absolute URL of your app. This includes the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port. | | **`collections`** | An array of Collections for Payload to manage. [More details](./collections). | | **`compatibility`** | Compatibility flags for earlier versions of Payload. [More details](#compatibility-flags). | @@ -95,11 +95,11 @@ The following options are available: | **`endpoints`** | An array of Custom Endpoints added to the Payload router. [More details](../rest-api/overview#custom-endpoints). | | **`custom`** | Extension point for adding custom data (e.g. for plugins). | | **`i18n`** | Internationalization configuration. Pass all i18n languages you'd like the admin UI to support. Defaults to English-only. [More details](./i18n). | -| **`secret`** \* | A secure, unguessable string that Payload will use for any encryption workflows - for example, password salt / hashing. | +| **`secret`** * | A secure, unguessable string that Payload will use for any encryption workflows - for example, password salt / hashing. | | **`sharp`** | If you would like Payload to offer cropping, focal point selection, and automatic media resizing, install and pass the Sharp module to the config here. | | **`typescript`** | Configure TypeScript settings here. [More details](#typescript). | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ **Note:** @@ -139,7 +139,7 @@ For Payload command-line scripts, we need to be able to locate your Payload Conf 1. The `compilerOptions` in your `tsconfig`* 1. The `dist` directory* -_\* Config location detection is different between development and production environments. See below for more details._ +_* Config location detection is different between development and production environments. See below for more details._ **Important:** diff --git a/docs/database/postgres.mdx b/docs/database/postgres.mdx index 0501d0ad920..c624a1b0f85 100644 --- a/docs/database/postgres.mdx +++ b/docs/database/postgres.mdx @@ -59,7 +59,7 @@ export default buildConfig({ | Option | Description | | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `pool` \* | [Pool connection options](https://orm.drizzle.team/docs/quick-postgresql/node-postgres) that will be passed to Drizzle and `node-postgres` or to `@vercel/postgres` | +| `pool` * | [Pool connection options](https://orm.drizzle.team/docs/quick-postgresql/node-postgres) that will be passed to Drizzle and `node-postgres` or to `@vercel/postgres` | | `push` | Disable Drizzle's [`db push`](https://orm.drizzle.team/kit-docs/overview#prototyping-with-db-push) in development mode. By default, `push` is enabled for development mode only. | | `migrationDir` | Customize the directory that migrations are stored. | | `schemaName` (experimental) | A string for the postgres schema to use, defaults to 'public'. | diff --git a/docs/database/sqlite.mdx b/docs/database/sqlite.mdx index cf1b3a33863..93cd338e37c 100644 --- a/docs/database/sqlite.mdx +++ b/docs/database/sqlite.mdx @@ -36,7 +36,7 @@ export default buildConfig({ | Option | Description | | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `client` \* | [Client connection options](https://orm.drizzle.team/docs/get-started-sqlite#turso) that will be passed to `createClient` from `@libsql/client`. | +| `client` * | [Client connection options](https://orm.drizzle.team/docs/get-started-sqlite#turso) that will be passed to `createClient` from `@libsql/client`. | | `push` | Disable Drizzle's [`db push`](https://orm.drizzle.team/kit-docs/overview#prototyping-with-db-push) in development mode. By default, `push` is enabled for development mode only. | | `migrationDir` | Customize the directory that migrations are stored. | | `logger` | The instance of the logger to be passed to drizzle. By default Payload's will be used. | @@ -172,7 +172,7 @@ sqliteAdapter({ }) ``` -Make sure Payload doesn't overlap table names with its collections. For example, if you already have a collection with slug "users", you should either change the slug or `dbName` to change the table name for this collection. +Make sure Payload doesn't overlap table names with its collections. For example, if you already have a collection with slug "users", you should either change the slug or `dbName` to change the table name for this collection. ### afterSchemaInit diff --git a/docs/email/overview.mdx b/docs/email/overview.mdx index 880f2a994fa..6ecf46b6d08 100644 --- a/docs/email/overview.mdx +++ b/docs/email/overview.mdx @@ -24,8 +24,8 @@ An email adapter will require at least the following fields: | Option | Description | | --------------------------- | -------------------------------------------------------------------------------- | -| **`defaultFromName`** \* | The name part of the From field that will be seen on the delivered email | -| **`defaultFromAddress`** \* | The email address part of the From field that will be used when delivering email | +| **`defaultFromName`** * | The name part of the From field that will be seen on the delivered email | +| **`defaultFromAddress`** * | The email address part of the From field that will be used when delivering email | ### Official Email Adapters diff --git a/docs/fields/array.mdx b/docs/fields/array.mdx index a3c2b1150c4..096f7583824 100644 --- a/docs/fields/array.mdx +++ b/docs/fields/array.mdx @@ -41,9 +41,9 @@ export const MyArrayField: Field = { | Option | Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`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. | -| **`fields`** \* | Array of field types to correspond to each row of the Array. | +| **`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](../admin/overview) and the backend. [More](/docs/fields/overview#validation) | | **`minRows`** | A number for the fewest allowed items during validation when a value is present. | | **`maxRows`** | A number for the most allowed items during validation when a value is present. | @@ -62,7 +62,7 @@ export const MyArrayField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options diff --git a/docs/fields/blocks.mdx b/docs/fields/blocks.mdx index 2c8de6453b1..fde324f4f6e 100644 --- a/docs/fields/blocks.mdx +++ b/docs/fields/blocks.mdx @@ -41,9 +41,9 @@ export const MyBlocksField: Field = { | Option | Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`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. | +| **`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) | | **`minRows`** | A number for the fewest allowed items during validation when a value is present. | | **`maxRows`** | A number for the most allowed items during validation when a value is present. | @@ -60,7 +60,7 @@ export const MyBlocksField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options @@ -145,8 +145,8 @@ Blocks are defined as separate configs of their own. | Option | Description | | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`slug`** \* | Identifier for this block type. Will be saved on each block as the `blockType` property. | -| **`fields`** \* | Array of fields to be stored in this block. | +| **`slug`** * | Identifier for this block type. Will be saved on each block as the `blockType` property. | +| **`fields`** * | Array of fields to be stored in this block. | | **`labels`** | Customize the block labels that appear in the Admin dashboard. Auto-generated from slug if not defined. | | **`imageURL`** | Provide a custom image thumbnail to help editors identify this block in the Admin UI. | | **`imageAltText`** | Customize this block's image thumbnail alt text. | diff --git a/docs/fields/checkbox.mdx b/docs/fields/checkbox.mdx index d5cfdf9cc46..6ac9c303bd6 100644 --- a/docs/fields/checkbox.mdx +++ b/docs/fields/checkbox.mdx @@ -30,7 +30,7 @@ export const MyCheckboxField: Field = { | Option | Description | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`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 an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | @@ -46,7 +46,7 @@ export const MyCheckboxField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Example diff --git a/docs/fields/code.mdx b/docs/fields/code.mdx index 005a2457e59..ffcd24a6d71 100644 --- a/docs/fields/code.mdx +++ b/docs/fields/code.mdx @@ -31,7 +31,7 @@ export const MyBlocksField: Field = { | Option | Description | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`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 an [index](/docs/database#overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | @@ -50,7 +50,7 @@ export const MyBlocksField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options diff --git a/docs/fields/collapsible.mdx b/docs/fields/collapsible.mdx index 0c75ca295c6..18cafa31702 100644 --- a/docs/fields/collapsible.mdx +++ b/docs/fields/collapsible.mdx @@ -35,12 +35,12 @@ export const MyCollapsibleField: Field = { | Option | Description | | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`label`** \* | A label to render within the header of the collapsible component. This can be a string, function or react component. Function/components receive `({ data, path })` as args. | -| **`fields`** \* | Array of field types to nest within this Collapsible. | +| **`label`** * | A label to render within the header of the collapsible component. This can be a string, function or react component. Function/components receive `({ data, path })` as args. | +| **`fields`** * | Array of field types to nest within this Collapsible. | | **`admin`** | Admin-specific configuration. [More details](#admin-options). | | **`custom`** | Extension point for adding custom data (e.g. for plugins) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options diff --git a/docs/fields/date.mdx b/docs/fields/date.mdx index 79c2a9ca70a..322239568e0 100644 --- a/docs/fields/date.mdx +++ b/docs/fields/date.mdx @@ -30,7 +30,7 @@ export const MyDateField: Field = { | Option | Description | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`label`** | Text used as a field label in the Admin Panel or an object with keys for each language. | | **`index`** | Build an [index](/docs/database/overview) 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) | @@ -46,7 +46,7 @@ export const MyDateField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options @@ -70,17 +70,17 @@ The Date Field inherits all of the default options from the base [Field Admin Co | **`placeholder`** | Placeholder text for the field. | | **`date`** | Pass options to customize date field appearance. | | **`date.displayFormat`** | Format date to be shown in field **cell**. | -| **`date.pickerAppearance`** \* | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`. | -| **`date.monthsToShow`** \* | Number of months to display max is 2. Defaults to 1. | -| **`date.minDate`** \* | Min date value to allow. | -| **`date.maxDate`** \* | Max date value to allow. | -| **`date.minTime`** \* | Min time value to allow. | -| **`date.maxTime`** \* | Max date value to allow. | -| **`date.overrides`** \* | Pass any valid props directly to the [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md) | -| **`date.timeIntervals`** \* | Time intervals to display. Defaults to 30 minutes. | -| **`date.timeFormat`** \* | Determines time format. Defaults to `'h:mm aa'`. | - -_\* This property is passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). ._ +| **`date.pickerAppearance`** * | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`. | +| **`date.monthsToShow`** * | Number of months to display max is 2. Defaults to 1. | +| **`date.minDate`** * | Min date value to allow. | +| **`date.maxDate`** * | Max date value to allow. | +| **`date.minTime`** * | Min time value to allow. | +| **`date.maxTime`** * | Max date value to allow. | +| **`date.overrides`** * | Pass any valid props directly to the [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md) | +| **`date.timeIntervals`** * | Time intervals to display. Defaults to 30 minutes. | +| **`date.timeFormat`** * | Determines time format. Defaults to `'h:mm aa'`. | + +_* This property is passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). ._ ### Display Format and Picker Appearance diff --git a/docs/fields/email.mdx b/docs/fields/email.mdx index 6f5c75a0024..22b1ebaba8c 100644 --- a/docs/fields/email.mdx +++ b/docs/fields/email.mdx @@ -30,7 +30,7 @@ export const MyEmailField: Field = { | Option | Description | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`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 an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | @@ -47,7 +47,7 @@ export const MyEmailField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options diff --git a/docs/fields/group.mdx b/docs/fields/group.mdx index c91dfe2e588..036113f32a9 100644 --- a/docs/fields/group.mdx +++ b/docs/fields/group.mdx @@ -35,8 +35,8 @@ export const MyGroupField: Field = { | Option | Description | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | -| **`fields`** \* | Array of field types to nest within this Group. | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`fields`** * | Array of field types to nest within this Group. | | **`label`** | Used as a heading in the Admin Panel and to name the generated GraphQL type. | | **`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/overview), include its data in the user JWT. | @@ -51,7 +51,7 @@ export const MyGroupField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options diff --git a/docs/fields/join.mdx b/docs/fields/join.mdx index c82db603748..c512dba0d4e 100644 --- a/docs/fields/join.mdx +++ b/docs/fields/join.mdx @@ -123,9 +123,9 @@ powerful Admin UI. | Option | Description | |------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **`name`** \* | To be used as the property name when retrieved from the database. [More](/docs/fields/overview#field-names) | -| **`collection`** \* | The `slug`s having the relationship field. | -| **`on`** \* | The name of the relationship or upload field that relates to the collection document. Use dot notation for nested paths, like 'myGroup.relationName'. | +| **`name`** * | To be used as the property name when retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`collection`** * | The `slug`s having the relationship field. | +| **`on`** * | The name of the relationship or upload field that relates to the collection document. Use dot notation for nested paths, like 'myGroup.relationName'. | | **`where`** | A `Where` query to hide related documents from appearing. Will be merged with any `where` specified in the request. | | **`maxDepth`** | Default is 1, Sets a maximum population depth for this field, regardless of the remaining depth when this field is reached. [Max Depth](/docs/getting-started/concepts#field-level-max-depth). | | **`label`** | Text used as a field label in the Admin Panel or an object with keys for each language. | @@ -138,7 +138,7 @@ powerful Admin UI. | **`typescriptSchema`** | Override field type generation with providing a JSON schema. | | **`graphQL`** | Custom graphQL configuration for the field. [More details](/docs/graphql/overview#field-complexity) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Config Options diff --git a/docs/fields/json.mdx b/docs/fields/json.mdx index efba417c8e4..1a1527e0b98 100644 --- a/docs/fields/json.mdx +++ b/docs/fields/json.mdx @@ -31,7 +31,7 @@ export const MyJSONField: Field = { | Option | Description | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`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 an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | @@ -49,7 +49,7 @@ export const MyJSONField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options diff --git a/docs/fields/number.mdx b/docs/fields/number.mdx index 6a3c0bc5480..a93fd034416 100644 --- a/docs/fields/number.mdx +++ b/docs/fields/number.mdx @@ -30,7 +30,7 @@ export const MyNumberField: Field = { | Option | Description | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`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. | @@ -52,7 +52,7 @@ export const MyNumberField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options diff --git a/docs/fields/point.mdx b/docs/fields/point.mdx index 9c9f172dde4..c462bc05b0c 100644 --- a/docs/fields/point.mdx +++ b/docs/fields/point.mdx @@ -35,7 +35,7 @@ export const MyPointField: Field = { | Option | Description | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`label`** | Used as a field label in the Admin Panel and to name the generated GraphQL type. | | **`unique`** | Enforce that each entry in the Collection has a unique value for this field. | | **`index`** | Build an [index](/docs/database/overview) for this field to produce faster queries. To support location queries, point index defaults to `2dsphere`, to disable the index set to `false`. | @@ -52,7 +52,7 @@ export const MyPointField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Example diff --git a/docs/fields/radio.mdx b/docs/fields/radio.mdx index 919404becf1..ed5eda9b984 100644 --- a/docs/fields/radio.mdx +++ b/docs/fields/radio.mdx @@ -35,8 +35,8 @@ export const MyRadioField: Field = { | Option | Description | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | -| **`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. | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`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`** | 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 an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. | @@ -53,7 +53,7 @@ export const MyRadioField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ **Important:** diff --git a/docs/fields/relationship.mdx b/docs/fields/relationship.mdx index a8a291d0c84..c1efd1a86ff 100644 --- a/docs/fields/relationship.mdx +++ b/docs/fields/relationship.mdx @@ -39,8 +39,8 @@ export const MyRelationshipField: Field = { | Option | Description | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | -| **`relationTo`** \* | Provide one or many collection `slug`s to be able to assign relationships to. | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`relationTo`** * | Provide one or many collection `slug`s to be able to assign relationships to. | | **`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. | | **`minRows`** | A number for the fewest allowed items during validation when a value is present. Used with `hasMany`. | @@ -63,7 +63,7 @@ export const MyRelationshipField: Field = { | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | | **`graphQL`** | Custom graphQL configuration for the field. [More details](/docs/graphql/overview#field-complexity) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ **Tip:** diff --git a/docs/fields/rich-text.mdx b/docs/fields/rich-text.mdx index 5ea9425cc2d..6cabf213570 100644 --- a/docs/fields/rich-text.mdx +++ b/docs/fields/rich-text.mdx @@ -6,12 +6,12 @@ desc: The Rich Text field allows dynamic content to be written through the Admin keywords: rich text, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs --- -The Rich Text Field lets editors write and format dynamic content in a familiar interface. +The Rich Text Field lets editors write and format dynamic content in a familiar interface. The content is saved as JSON in the database and can be converted to HTML or any other format needed. -Consistent with Payload's goal of making you learn as little of Payload as possible, customizing +Consistent with Payload's goal of making you learn as little of Payload as possible, customizing and using the Rich Text Editor does not involve learning how to develop for a Payload rich text editor. -Instead, you can invest your time and effort into learning the underlying open-source tools that will allow +Instead, you can invest your time and effort into learning the underlying open-source tools that will allow you to apply your learnings elsewhere as well. **Important:** diff --git a/docs/fields/tabs.mdx b/docs/fields/tabs.mdx index 58dff50d3f2..579eb6c137a 100644 --- a/docs/fields/tabs.mdx +++ b/docs/fields/tabs.mdx @@ -35,7 +35,7 @@ export const MyTabsField: Field = { | Option | Description | | ------------- | ------------------------------------------------------------------------------------------------------------------------ | -| **`tabs`** \* | Array of tabs to render within this Tabs field. | +| **`tabs`** * | Array of tabs to render within this Tabs field. | | **`admin`** | Admin-specific configuration. [More details](../admin/fields#admin-options). | | **`custom`** | Extension point for adding custom data (e.g. for plugins) | @@ -47,12 +47,12 @@ Each tab must have either a `name` or `label` and the required `fields` array. Y | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **`name`** | Groups field data into an object when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`label`** | The label to render on the tab itself. Required when name is undefined, defaults to name converted to words. | -| **`fields`** \* | The fields to render within this tab. | +| **`fields`** * | The fields to render within this tab. | | **`description`** | Optionally render a description within this tab to describe the contents of the tab itself. | | **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). (`name` must be present) | | **`virtual`** | Provide `true` to disable field in the database (`name` must be present). See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Example diff --git a/docs/fields/text.mdx b/docs/fields/text.mdx index d73e4f8a8ea..7abb0705d2f 100644 --- a/docs/fields/text.mdx +++ b/docs/fields/text.mdx @@ -30,7 +30,7 @@ export const MyTextField: Field = { | Option | Description | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`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. | @@ -52,7 +52,7 @@ export const MyTextField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options diff --git a/docs/fields/textarea.mdx b/docs/fields/textarea.mdx index fae61edc11b..d128f308a11 100644 --- a/docs/fields/textarea.mdx +++ b/docs/fields/textarea.mdx @@ -30,7 +30,7 @@ export const MyTextareaField: Field = { | Option | Description | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | | **`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. | @@ -49,7 +49,7 @@ export const MyTextareaField: Field = { | **`typescriptSchema`** | Override field type generation with providing a JSON schema | | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Admin Options diff --git a/docs/fields/ui.mdx b/docs/fields/ui.mdx index 9ddc6d3b5e8..2e31a74fa14 100644 --- a/docs/fields/ui.mdx +++ b/docs/fields/ui.mdx @@ -30,14 +30,14 @@ export const MyUIField: Field = { | Option | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| **`name`** \* | A unique identifier for this field. | +| **`name`** * | A unique identifier for this field. | | **`label`** | Human-readable label for this UI field. | -| **`admin.components.Field`** \* | React component to be rendered for this field within the Edit View. [More](../admin/components/#field) | +| **`admin.components.Field`** * | React component to be rendered for this field within the Edit View. [More](../admin/components/#field) | | **`admin.components.Cell`** | React component to be rendered as a Cell within collection List views. [More](../admin/components/#field) | | **`admin.disableListColumn`** | Set `disableListColumn` to `true` to prevent the UI field from appearing in the list view column selector. | | **`custom`** | Extension point for adding custom data (e.g. for plugins) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Example diff --git a/docs/fields/upload.mdx b/docs/fields/upload.mdx index be9d32fb167..f5abe8a807d 100644 --- a/docs/fields/upload.mdx +++ b/docs/fields/upload.mdx @@ -45,8 +45,8 @@ export const MyUploadField: Field = { | Option | Description | |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | -| **`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.** | +| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) | +| **`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-upload-options). | | **`hasMany`** | Boolean which, if set to true, allows this field to have many relations instead of only one. | | **`minRows`** | A number for the fewest allowed items during validation when a value is present. Used with hasMany. | @@ -70,7 +70,7 @@ export const MyUploadField: Field = { | **`virtual`** | Provide `true` to disable field in the database. See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) | | **`graphQL`** | Custom graphQL configuration for the field. [More details](/docs/graphql/overview#field-complexity) | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ## Example diff --git a/docs/live-preview/client.mdx b/docs/live-preview/client.mdx index e018ce91b9e..f386e9d54a8 100644 --- a/docs/live-preview/client.mdx +++ b/docs/live-preview/client.mdx @@ -18,12 +18,12 @@ By default, all hooks accept the following args: | Path | Description | | ------------------ | -------------------------------------------------------------------------------------- | -| **`serverURL`** \* | The URL of your Payload server. | +| **`serverURL`** * | The URL of your Payload server. | | **`initialData`** | The initial data of the document. The live data will be merged in as changes are made. | | **`depth`** | The depth of the relationships to fetch. Defaults to `0`. | | **`apiRoute`** | The path of your API route as defined in `routes.api`. Defaults to `/api`. | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ And return the following values: @@ -151,8 +151,8 @@ The `subscribe` function takes the following args: | Path | Description | | ------------------ | ------------------------------------------------------------------------------------------- | -| **`callback`** \* | A callback function that is called with `data` every time a change is made to the document. | -| **`serverURL`** \* | The URL of your Payload server. | +| **`callback`** * | A callback function that is called with `data` every time a change is made to the document. | +| **`serverURL`** * | The URL of your Payload server. | | **`initialData`** | The initial data of the document. The live data will be merged in as changes are made. | | **`depth`** | The depth of the relationships to fetch. Defaults to `0`. | diff --git a/docs/live-preview/overview.mdx b/docs/live-preview/overview.mdx index 0b8b10d8dcc..3ff9e3efa53 100644 --- a/docs/live-preview/overview.mdx +++ b/docs/live-preview/overview.mdx @@ -43,12 +43,12 @@ The following options are available: | Path | Description | | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`url`** \* | String, or function that returns a string, pointing to your front-end application. This value is used as the iframe `src`. [More details](#url). | +| **`url`** * | String, or function that returns a string, pointing to your front-end application. This value is used as the iframe `src`. [More details](#url). | | **`breakpoints`** | Array of breakpoints to be used as “device sizes” in the preview window. Each item appears as an option in the toolbar. [More details](#breakpoints). | | **`collections`** | Array of collection slugs to enable Live Preview on. | | **`globals`** | Array of global slugs to enable Live Preview on. | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ ### URL @@ -150,12 +150,12 @@ The following options are available for each breakpoint: | Path | Description | | --------------- | --------------------------------------------------------------------------- | -| **`label`** \* | The label to display in the drop-down. This is what the user will see. | -| **`name`** \* | The name of the breakpoint. | -| **`width`** \* | The width of the breakpoint. This is used to set the width of the iframe. | -| **`height`** \* | The height of the breakpoint. This is used to set the height of the iframe. | +| **`label`** * | The label to display in the drop-down. This is what the user will see. | +| **`name`** * | The name of the breakpoint. | +| **`width`** * | The width of the breakpoint. This is used to set the width of the iframe. | +| **`height`** * | The height of the breakpoint. This is used to set the height of the iframe. | -_\* An asterisk denotes that a property is required._ +_* An asterisk denotes that a property is required._ {/* IMAGE OF TOOLBAR HERE */} diff --git a/docs/rich-text/slate.mdx b/docs/rich-text/slate.mdx index 9dad22c6d4e..ee97ec86d8a 100644 --- a/docs/rich-text/slate.mdx +++ b/docs/rich-text/slate.mdx @@ -151,8 +151,8 @@ Once you're up to speed with the general concepts involved, you can pass in your | Property | Description | | --------------- | ---------------------------------------------------------- | -| **`name`** \* | The default name to be used as a `type` for this element. | -| **`Button`** \* | A React component to be rendered in the Rich Text toolbar. | +| **`name`** * | The default name to be used as a `type` for this element. | +| **`Button`** * | A React component to be rendered in the Rich Text toolbar. | | **`plugins`** | An array of plugins to provide to the Rich Text editor. | | **`type`** | A type that overrides the default type used by `name` | diff --git a/docs/troubleshooting/troubleshooting.mdx b/docs/troubleshooting/troubleshooting.mdx index 473bc7556a9..aa0fa6c1f2a 100644 --- a/docs/troubleshooting/troubleshooting.mdx +++ b/docs/troubleshooting/troubleshooting.mdx @@ -12,7 +12,7 @@ keywords: admin, components, custom, customize, documentation, Content Managemen This means that your auth cookie is not being set or accepted correctly upon logging in. To resolve heck the following settings in your Payload Config: -- CORS - If you are using the '\*', try to explicitly only allow certain domains instead including the one you have specified. +- CORS - If you are using the '*', try to explicitly only allow certain domains instead including the one you have specified. - CSRF - Do you have this set? if so, make sure your domain is whitelisted within the csrf domains. If not, probably not the issue, but probably can't hurt to whitelist it anyway. - Cookie settings. If these are completely undefined, then that's fine. but if you have cookie domain set, or anything similar, make sure you don't have the domain misconfigured diff --git a/docs/upload/storage-adapters.mdx b/docs/upload/storage-adapters.mdx index 5d16fd8a7f5..c461cfd4ef6 100644 --- a/docs/upload/storage-adapters.mdx +++ b/docs/upload/storage-adapters.mdx @@ -309,14 +309,14 @@ This plugin is configurable to work across many different Payload collections. A | Option | Type | Description | | ---------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `collections` \* | `Record` | Object with keys set to the slug of collections you want to enable the plugin for, and values set to collection-specific options. | +| `collections` * | `Record` | Object with keys set to the slug of collections you want to enable the plugin for, and values set to collection-specific options. | | `enabled` | `boolean` | To conditionally enable/disable plugin. Default: `true`. | ## Collection-specific options | Option | Type | Description | | ----------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `adapter` \* | [Adapter](https://github.com/payloadcms/plugin-cloud-storage/blob/master/src/types.ts#L51) | Pass in the adapter that you'd like to use for this collection. You can also set this field to `null` for local development if you'd like to bypass cloud storage in certain scenarios and use local storage. | +| `adapter` * | [Adapter](https://github.com/payloadcms/plugin-cloud-storage/blob/master/src/types.ts#L51) | Pass in the adapter that you'd like to use for this collection. You can also set this field to `null` for local development if you'd like to bypass cloud storage in certain scenarios and use local storage. | | `disableLocalStorage` | `boolean` | Choose to disable local storage on this collection. Defaults to `true`. | | `disablePayloadAccessControl` | `true` | Set to `true` to disable Payload's Access Control. [More](#payload-access-control) | | `prefix` | `string` | Set to `media/images` to upload files inside `media/images` folder in the bucket. |