From 4f0d75a6e933e383d64cd960e2fc169b8bffec3d Mon Sep 17 00:00:00 2001 From: Alessio Gravili Date: Mon, 30 Dec 2024 23:33:49 -0700 Subject: [PATCH] fix docs --- docs/fields/rich-text.mdx | 10 ++-------- docs/rich-text/overview.mdx | 9 ++++++++- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/fields/rich-text.mdx b/docs/fields/rich-text.mdx index 6cabf21357..3e1ca83a7f 100644 --- a/docs/fields/rich-text.mdx +++ b/docs/fields/rich-text.mdx @@ -45,7 +45,7 @@ _* An asterisk denotes that a property is required._ ## Admin Options -The customize the appearance and behavior of the Rich Text Field in the [Admin Panel](../admin/overview), you can use the `admin` option: +The customize the appearance and behavior of the Rich Text Field in the [Admin Panel](../admin/overview), you can use the `admin` option. The Rich Text Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options) ```ts import type { Field } from 'payload' @@ -58,13 +58,7 @@ export const MyRichTextField: Field = { } ``` -The Rich Text Field inherits all of the default options from the base [Field Admin Config](../admin/fields#admin-options), plus the following additional options: - -| Property | Description | -| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | -| **`placeholder`** | Set this property to define a placeholder string for the field. | -| **`hideGutter`** | Set this property to `true` to hide this field's gutter within the Admin Panel. | -| **`rtl`** | Override the default text direction of the Admin Panel for this field. Set to `true` to force right-to-left text direction. | +Further customization can be done with editor-specific options. ## Editor-specific Options diff --git a/docs/rich-text/overview.mdx b/docs/rich-text/overview.mdx index b9cad4e5e3..514e5d69e4 100644 --- a/docs/rich-text/overview.mdx +++ b/docs/rich-text/overview.mdx @@ -301,9 +301,16 @@ Lexical does not generate the accurate type definitions for your richText fields ## Admin customization +The Rich Text Field editor configuration has an `admin` property with the following options: + +| Property | Description | +| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| **`placeholder`** | Set this property to define a placeholder string for the field. | +| **`hideGutter`** | Set this property to `true` to hide this field's gutter within the Admin Panel. | + ### Disable the gutter -You can disable the gutter (the vertical line padding between the editor and the left edge of the screen) by setting the `hideGutter` prop to `true`: +You can disable the gutter (the vertical line padding between the editor and the left edge of the screen) by setting the `hideGutter` prop to `true`: ```ts {