富文本字段

富文本字段允许通过管理面板编写动态内容。了解如何使用 Rich Text 字段，查看示例和配置选项。

富文本字段（Rich Text Field）让编辑者能够在熟悉的界面中编写和格式化动态内容。这些内容会以 JSON 格式保存在数据库中，并可转换为 HTML 或其他所需格式。

与 Payload 让你尽可能少学习 Payload 的目标一致，定制和使用富文本编辑器并不需要学习如何为 Payload 开发富文本编辑器。

相反，你可以将时间和精力投入到学习底层的开源工具上，这些知识也能应用到其他领域。

管理面板中的富文本字段截图

配置选项

选项	描述
`name` *	作为属性名用于数据库存储和检索。了解更多
`label`	在 Admin Panel 中用作字段标签的文本，或为每种语言提供键值对的对象。
`validate`	提供自定义验证函数，该函数将在 Admin Panel 和后端执行。了解更多
`saveToJWT`	如果该字段是顶级字段且嵌套在支持身份验证的配置中，则将其数据包含在用户 JWT 中。
`hooks`	提供字段钩子来控制该字段的逻辑。更多详情。
`access`	提供字段访问控制，指定用户可以对该字段数据执行的操作。更多详情。
`hidden`	完全限制该字段在所有 API 中的可见性。仍会保存到数据库，但不会出现在任何 API 或 Admin Panel 中。
`defaultValue`	提供用于该字段默认值的数据。了解更多
`localized`	启用该字段的本地化功能。需要在基础配置中启用本地化。
`required`	要求该字段必须有值。
`admin`	特定于 Admin Panel 的配置。更多详情。
`editor`	自定义或覆盖富文本编辑器。更多详情。
`custom`	用于添加自定义数据（例如插件）的扩展点
`typescriptSchema`	通过提供 JSON schema 来覆盖字段类型生成
`virtual`	设置为 `true` 以禁用数据库中的字段，或提供字符串路径来将字段与关系链接。参见虚拟字段

*_ 星号表示该属性为必填项。_

要自定义 Admin Panel 中富文本字段的外观和行为，可以使用 admin 选项。富文本字段继承了基础 Field Admin Config 的所有默认选项。

import type { Field } from 'payload'

export const MyRichTextField: Field = {
  // ...
  admin: {
    // highlight-line
    // ...
  },
}

可以通过编辑器特定选项进行更深入的定制。

如需了解更多编辑器特定选项，包括如何直接在编辑器中构建自定义富文本元素，请参阅富文本编辑器文档。

连接字段

行字段