• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# RichEditor (System API)
2
3**RichEditor** is a component that supports interactive text editing and mixture of text and imagery.
4
5>  **NOTE**
6>
7>  This component is supported since API version 10. Updates will be marked with a superscript to indicate their earliest API version.
8>
9>  This topic describes only system APIs provided by the module. For details about its public APIs, see [RichEditor](ts-basic-components-richeditor.md).
10>
11## RichEditorBuilderSpanOptions<sup>11+</sup>
12
13Defines the options for adding a builder span.
14
15**Atomic service API**: This API can be used in atomic services since API version 12.
16
17**System API**: This is a system API.
18
19**System capability**: SystemCapability.ArkUI.ArkUI.Full
20
21| Name    | Type    | Mandatory  | Description                                   |
22| ------ | ------ | ---- | ------------------------------------- |
23| dragBackgroundColor<sup>18+</sup> | [ColorMetrics](../js-apis-arkui-graphics.md#colormetrics12) | No   | Background color of the builder when it is dragged independently. If no valid value is specified, the default color is used. |
24| isDragShadowNeeded<sup>18+</sup> | boolean | No   | Whether to apply a shadow when the builder is dragged independently. If no valid value is specified, a shadow is applied.|
25
26## RichEditorGesture<sup>11+</sup>
27
28Defines the callback for user interactions.
29
30**System API**: This is a system API.
31
32**System capability**: SystemCapability.ArkUI.ArkUI.Full
33
34| Name         | Type        | Mandatory  | Description           |
35| ----------- | ---------- | ---- | ------------- |
36| onDoubleClick<sup>14+</sup> | Callback\<[GestureEvent](ts-gesture-settings.md#gestureevent)\>  | No   | Callback for double-click events.<br>**Atomic service API**: This API can be used in atomic services since API version 14. |
37
38