tabshift/payload
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix all missing vertical lines in tables (#10288)

Browse Source
This commit is contained in:
Said Akhrarov
2024-12-31 16:11:47 -05:00
committed by GitHub
parent 950f8ce80a
commit b6de432ab2
10 changed files with 75 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/admin/collections.mdx
View File

@@ -66,11 +66,11 @@ export const MyCollection: SanitizedCollectionConfig = {
The following options are available: The following options are available:
| Path | Description | | Path | Description |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| **`beforeList`** | An array of components to inject _before_ the built-in List View | | **`beforeList`** | An array of components to inject _before_ the built-in List View |
| **`beforeListTable`** | An array of components to inject _before_ the built-in List View's table | | **`beforeListTable`** | An array of components to inject _before_ the built-in List View's table |
| **`afterList`** | An array of components to inject _after_ the built-in List View | | **`afterList`** | An array of components to inject _after_ the built-in List View |
| **`afterListTable`** | An array of components to inject _after_ the built-in List View's table | **`afterListTable`** | An array of components to inject _after_ the built-in List View's table |
| **`Description`** | A component to render below the Collection label in the List View. An alternative to the `admin.description` property. | | **`Description`** | A component to render below the Collection label in the List View. An alternative to the `admin.description` property. |
| **`edit.SaveButton`** | Replace the default Save Button with a Custom Component. [Drafts](../versions/drafts) must be disabled. | | **`edit.SaveButton`** | Replace the default Save Button with a Custom Component. [Drafts](../versions/drafts) must be disabled. |
| **`edit.SaveDraftButton`** | Replace the default Save Draft Button with a Custom Component. [Drafts](../versions/drafts) must be enabled and autosave must be disabled. | | **`edit.SaveDraftButton`** | Replace the default Save Draft Button with a Custom Component. [Drafts](../versions/drafts) must be enabled and autosave must be disabled. |

8
docs/admin/fields.mdx
View File

@@ -243,8 +243,8 @@ _For details on how to build Custom Components, see [Building Custom Components]
All Field Components receive the following props by default: All Field Components receive the following props by default:
| Property | Description | | Property | Description |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`docPreferences`** | An object that contains the [Preferences](./preferences) for the document. | **`docPreferences`** | An object that contains the [Preferences](./preferences) for the document. |
| **`field`** | In Client Components, this is the sanitized Client Field Config. In Server Components, this is the original Field Config. Server Components will also receive the sanitized field config through the`clientField` prop (see below). | | **`field`** | In Client Components, this is the sanitized Client Field Config. In Server Components, this is the original Field Config. Server Components will also receive the sanitized field config through the`clientField` prop (see below). |
| **`locale`** | The locale of the field. [More details](../configuration/localization). | | **`locale`** | The locale of the field. [More details](../configuration/localization). |
| **`readOnly`** | A boolean value that represents if the field is read-only or not. | | **`readOnly`** | A boolean value that represents if the field is read-only or not. |
@@ -257,11 +257,11 @@ All Field Components receive the following props by default:
In addition to the above props, all Server Components will also receive the following props: In addition to the above props, all Server Components will also receive the following props:
| Property | Description | | Property | Description |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------------------------------------------------------------- |
| **`clientField`** | The serializable Client Field Config. | | **`clientField`** | The serializable Client Field Config. |
| **`field`** | The Field Config. [More details](../fields/overview). | | **`field`** | The Field Config. [More details](../fields/overview). |
| **`data`** | The current document being edited. | | **`data`** | The current document being edited. |
| **`i18n`** | The [i18n](../configuration/i18n) object. | **`i18n`** | The [i18n](../configuration/i18n) object. |
| **`payload`** | The [Payload](../local-api/overview) class. | | **`payload`** | The [Payload](../local-api/overview) class. |
| **`permissions`** | The field permissions based on the currently authenticated user. | | **`permissions`** | The field permissions based on the currently authenticated user. |
| **`siblingData`** | The data of the field's siblings. | | **`siblingData`** | The data of the field's siblings. |

2
docs/fields/blocks.mdx
View File

@@ -152,7 +152,7 @@ Blocks are defined as separate configs of their own.
| **`imageAltText`** | Customize this block's image thumbnail alt text. | | **`imageAltText`** | Customize this block's image thumbnail alt text. |
| **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). | | **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). |
| **`graphQL.singularName`** | Text to use for the GraphQL schema name. Auto-generated from slug if not defined. NOTE: this is set for deprecation, prefer `interfaceName`. | | **`graphQL.singularName`** | Text to use for the GraphQL schema name. Auto-generated from slug if not defined. NOTE: this is set for deprecation, prefer `interfaceName`. |
| **`dbName`** | Custom table name for this block type when using SQL Database Adapter ([Postgres](/docs/database/postgres)). Auto-generated from slug if not defined. | **`dbName`** | Custom table name for this block type when using SQL Database Adapter ([Postgres](/docs/database/postgres)). Auto-generated from slug if not defined. |
| **`custom`** | Extension point for adding custom data (e.g. for plugins) | | **`custom`** | Extension point for adding custom data (e.g. for plugins) |
### Auto-generated data per block ### Auto-generated data per block

8
docs/hooks/collections.mdx
View File

@@ -187,11 +187,11 @@ const beforeReadHook: CollectionBeforeReadHook = async ({
The following arguments are provided to the `beforeRead` hook: The following arguments are provided to the `beforeRead` hook:
| Option | Description | | Option | Description |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`collection`** | The [Collection](../configuration/collections) in which this Hook is running against. | | **`collection`** | The [Collection](../configuration/collections) in which this Hook is running against. |
| **`context`** | Custom context passed between hooks. [More details](./context). | | **`context`** | Custom context passed between hooks. [More details](./context). |
| **`doc`** | The resulting Document after changes are applied. | | **`doc`** | The resulting Document after changes are applied. |
| **`query`** | The [Query](../queries/overview) of the request. | **`query`** | The [Query](../queries/overview) of the request. |
| **`req`** | The [Web Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object. This is mocked for [Local API](../local-api/overview) operations. | | **`req`** | The [Web Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object. This is mocked for [Local API](../local-api/overview) operations. |
### afterRead ### afterRead
@@ -211,11 +211,11 @@ const afterReadHook: CollectionAfterReadHook = async ({
The following arguments are provided to the `afterRead` hook: The following arguments are provided to the `afterRead` hook:
| Option | Description | | Option | Description |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`collection`** | The [Collection](../configuration/collections) in which this Hook is running against. | | **`collection`** | The [Collection](../configuration/collections) in which this Hook is running against. |
| **`context`** | Custom context passed between hooks. [More details](./context). | | **`context`** | Custom context passed between hooks. [More details](./context). |
| **`doc`** | The resulting Document after changes are applied. | | **`doc`** | The resulting Document after changes are applied. |
| **`query`** | The [Query](../queries/overview) of the request. | **`query`** | The [Query](../queries/overview) of the request. |
| **`req`** | The [Web Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object. This is mocked for [Local API](../local-api/overview) operations. | | **`req`** | The [Web Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object. This is mocked for [Local API](../local-api/overview) operations. |
### beforeDelete ### beforeDelete

4
docs/hooks/globals.mdx
View File

@@ -164,12 +164,12 @@ const afterReadHook: GlobalAfterReadHook = async ({
The following arguments are provided to the `beforeRead` hook: The following arguments are provided to the `beforeRead` hook:
| Option | Description | | Option | Description |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`global`** | The [Global](../configuration/globals) in which this Hook is running against. | | **`global`** | The [Global](../configuration/globals) in which this Hook is running against. |
| **`context`** | Custom context passed between hooks. [More details](./context). | | **`context`** | Custom context passed between hooks. [More details](./context). |
| **`findMany`** | Boolean to denote if this hook is running against finding one, or finding many (useful in versions). | | **`findMany`** | Boolean to denote if this hook is running against finding one, or finding many (useful in versions). |
| **`doc`** | The resulting Document after changes are applied. | | **`doc`** | The resulting Document after changes are applied. |
| **`query`** | The [Query](../queries/overview) of the request. | **`query`** | The [Query](../queries/overview) of the request. |
| **`req`** | The [Web Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object. This is mocked for [Local API](../local-api/overview) operations. | | **`req`** | The [Web Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object. This is mocked for [Local API](../local-api/overview) operations. |
## TypeScript ## TypeScript

6
docs/plugins/stripe.mdx
View File

@@ -65,14 +65,14 @@ export default config
| Option | Type | Default | Description | | Option | Type | Default | Description |
| ------------------------------ | ------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------ | | ------------------------------ | ------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------ |
| `stripeSecretKey` \* | string | `undefined` | Your Stripe secret key | | `stripeSecretKey` * | string | `undefined` | Your Stripe secret key |
| `stripeWebhooksEndpointSecret` | string | `undefined` | Your Stripe webhook endpoint secret | | `stripeWebhooksEndpointSecret` | string | `undefined` | Your Stripe webhook endpoint secret |
| `rest` | boolean | `false` | When `true`, opens the `/api/stripe/rest` endpoint | | `rest` | boolean | `false` | When `true`, opens the `/api/stripe/rest` endpoint |
| `webhooks` | object \| function | `undefined` | Either a function to handle all webhooks events, or an object of Stripe webhook handlers, keyed to the name of the event | | `webhooks` | object or function | `undefined` | Either a function to handle all webhooks events, or an object of Stripe webhook handlers, keyed to the name of the event |
| `sync` | array | `undefined` | An array of sync configs | | `sync` | array | `undefined` | An array of sync configs |
| `logs` | boolean | `false` | When `true`, logs sync events to the console as they happen | | `logs` | boolean | `false` | When `true`, logs sync events to the console as they happen |
_\* An asterisk denotes that a property is required._ _* An asterisk denotes that a property is required._
## Endpoints ## Endpoints

22
docs/queries/pagination.mdx
View File

@@ -11,17 +11,17 @@ All collection `find` queries are paginated automatically. Responses are returne
**`Find` response properties:** **`Find` response properties:**
| Property | Description | | Property | Description |
| ------------- | --------------------------------------------------------- | | --------------- | --------------------------------------------------------- |
| docs | Array of documents in the collection | | `docs` | Array of documents in the collection |
| totalDocs | Total available documents within the collection | | `totalDocs` | Total available documents within the collection |
| limit | Limit query parameter - defaults to `10` | | `limit` | Limit query parameter - defaults to `10` |
| totalPages | Total pages available, based upon the `limit` queried for | | `totalPages` | Total pages available, based upon the `limit` queried for |
| page | Current page number | | `page` | Current page number |
| pagingCounter | `number` of the first doc on the current page | | `pagingCounter` | `number` of the first doc on the current page |
| hasPrevPage | `true/false` if previous page exists | | `hasPrevPage` | `true/false` if previous page exists |
| hasNextPage | `true/false` if next page exists | | `hasNextPage` | `true/false` if next page exists |
| prevPage | `number` of previous page, `null` if it doesn't exist | | `prevPage` | `number` of previous page, `null` if it doesn't exist |
| nextPage | `number` of next page, `null` if it doesn't exist | | `nextPage` | `number` of next page, `null` if it doesn't exist |
**Example response:** **Example response:**

3
docs/rich-text/building-custom-features.mdx
View File

@@ -191,8 +191,7 @@ import { lexicalEditor } from '@payloadcms/richtext-lexical';
}, },
``` ```
By default, this server feature does nothing - you haven't added any functionality yet. Depending on what you want your By default, this server feature does nothing - you haven't added any functionality yet. Depending on what you want your feature to do, the ServerFeature type exposes various properties you can set to inject custom functionality into the lexical editor.
feature to do, the ServerFeature type exposes various properties you can set to inject custom functionality into the lexical editor.
### i18n ### i18n

2
docs/troubleshooting/troubleshooting.mdx
View File

@@ -10,7 +10,7 @@ keywords: admin, components, custom, customize, documentation, Content Managemen
### "Unauthorized, you must be logged in to make this request" when attempting to log in ### "Unauthorized, you must be logged in to make this request" when attempting to log in
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: This means that your auth cookie is not being set or accepted correctly upon logging in. To resolve check 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. - 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.

2
docs/versions/overview.mdx
View File

@@ -56,7 +56,7 @@ Configuring Versions is done by adding the `versions` key to your Collection con
| Option | Description | | Option | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `maxPerDoc` | Use this setting to control how many versions to keep on a document by document basis. Must be an integer. Defaults to 100, use 0 to save all versions. | | `maxPerDoc` | Use this setting to control how many versions to keep on a document by document basis. Must be an integer. Defaults to 100, use 0 to save all versions. |
| `drafts ` | Enable [Drafts](/docs/versions/drafts) mode for this collection. To enable, set to `true` or pass an object with `draft` [options](/docs/versions/drafts#options). | | `drafts` | Enable [Drafts](/docs/versions/drafts) mode for this collection. To enable, set to `true` or pass an object with `draft` [options](/docs/versions/drafts#options). |
## Global config ## Global config