鸿蒙OpenHarmony【RichEditor】ArkTS文本与输入

支持图文混排和文本交互式编辑的组件。

说明

该组件从API Version 10开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

子组件

不包含子组件。

接口

RichEditor(value: RichEditorOptions)

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[RichEditorOptions]	是	富文本组件初始化选项。

RichEditor(options: RichEditorStyledStringOptions)12+

参数：

参数名	类型	必填	说明
options	[RichEditorStyledStringOptions]	是	富文本组件初始化选项。

属性

除支持[通用属性]外，还支持以下属性：

说明

align属性只支持上方、中间和下方位置的对齐方式。

不支持borderImage属性。

customKeyboard

customKeyboard(value: CustomBuilder, options?: KeyboardOptions)

设置自定义键盘。

当设置自定义键盘时，输入框激活后不会打开系统输入法，而是加载指定的自定义组件。

自定义键盘的高度可以通过自定义组件根节点的height属性设置，宽度不可设置，使用系统默认值。

自定义键盘无法获取焦点，但是会拦截手势事件。

默认在输入控件失去焦点时，关闭自定义键盘。

如果设备支持拍摄输入，设置自定义键盘后，该输入框会不支持拍摄输入。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[CustomBuilder]	是	自定义键盘。元服务API： 从API version 11开始，该接口支持在元服务中使用。
options12+	[KeyboardOptions]	否	设置自定义键盘是否支持避让功能。

bindSelectionMenu

bindSelectionMenu(spanType: RichEditorSpanType, content: CustomBuilder, responseType: ResponseType | RichEditorResponseType,

options?: SelectionMenuOptions)

设置自定义选择菜单。自定义菜单超长时，建议内部嵌套[Scroll]组件使用，避免键盘被遮挡。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
spanType	[RichEditorSpanType]	是	菜单的类型。默认值：RichEditorSpanType.TEXT
content	[CustomBuilder]	是	菜单的内容。
responseType	[ResponseType]	[RichEditorResponseType]	是
options	[SelectionMenuOptions]	否	菜单的选项。

copyOptions

copyOptions(value: CopyOptions)

设置组件是否支持文本内容可复制粘贴。

copyOptions不为CopyOptions.None时，长按组件内容，会弹出文本选择弹框。如果通过bindSelectionMenu等方式自定义文本选择菜单，则会弹出自定义的菜单。

设置copyOptions为CopyOptions.None，复制、剪切功能不生效。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[CopyOptions]	是	组件支持文本内容是否可复制粘贴。默认值：CopyOptions.LocalDevice卡片能力： 从API version 10开始，该接口支持在ArkTS卡片中使用。

enableDataDetector11+

enableDataDetector(enable: boolean)

设置是否进行文本特殊实体识别。

该接口依赖设备底层应具有文本识别能力，否则设置不会生效。

当enableDataDetector设置为true，同时不设置dataDetectorConfig属性时，默认识别所有类型的实体，所识别实体的color和decoration会被更改为如下样式：

color: '#ff007dff'
decoration:{
  type: TextDecorationType.Underline,
  color: '#ff007dff',
  style: TextDecorationStyle.SOLID
}

触摸点击和鼠标右键点击实体，会根据实体类型弹出对应的实体操作菜单，鼠标左键点击实体会直接响应菜单的第一个选项。

对addBuilderSpan的节点文本，该功能不会生效。

当copyOption设置为CopyOptions.None时，点击实体弹出的菜单没有选择文本和复制功能。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
enable	boolean	是	使能文本识别。默认值： false

dataDetectorConfig11+

dataDetectorConfig(config: TextDataDetectorConfig)

设置文本识别配置。

需配合[enableDataDetector]一起使用，设置enableDataDetector为true时，dataDetectorConfig的配置才能生效。

当有两个实体A、B重叠时，按以下规则保留实体：

1. 若A ⊂ B，则保留B，反之则保留A。

2. 当A ⊄ B且B ⊄ A时，若A.start < B.start，则保留A，反之则保留B。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
config	[TextDataDetectorConfig]	是	文本识别配置。

enablePreviewText12+

enablePreviewText(enable: boolean)

设置是否开启预上屏功能。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
enable	boolean	是	使能预上屏功能。默认值： true

说明

该接口在CAPI场景使用时下，默认关闭。可以在工程的module.json5中配置[metadata]字段控制是否启用预上屏，配置如下：

"metadata": [
 {
    "name": "can_preview_text",
    "value": "true",
 }
]

placeholder12+

placeholder(value: ResourceStr, style?: PlaceholderStyle)

设置无输入时的提示文本。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[ResourceStr]	是	无输入时的提示文本。
style	[PlaceholderStyle]	否	添加提示文本的字体样式。style缺省时默认跟随主题。

caretColor12+

caretColor(value: ResourceColor)

设置输入框光标、手柄颜色。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[ResourceColor]	是	输入框光标、手柄颜色。默认值：‘#007DFF’

selectedBackgroundColor12+

selectedBackgroundColor(value: ResourceColor)

设置文本选中底板颜色。如果未设置不透明度，默认为20%不透明度。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[ResourceColor]	是	文本选中底板颜色。默认为20%不透明度。

editMenuOptions12+

editMenuOptions(editMenu: EditMenuOptions)

设置自定义菜单扩展项，允许用户设置扩展项的文本内容、图标、回调方法。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
editMenu	[EditMenuOptions]	是	扩展菜单选项。

enterKeyType12+

enterKeyType(value: EnterKeyType)

设置软键盘输入法回车键类型。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名	类型	必填	说明
value	[EnterKeyType]	是	键盘输入法回车键类型。默认为EnterKeyType.NEW_LINE。

enableKey