鸿蒙OpenHarmony【拖拽控制】ArkTS组件通用属性

设置组件是否可以响应拖拽事件。

说明

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

ArkUI框架对以下组件实现了默认的拖拽能力，支持对数据的拖出或拖入响应，开发者只需要将这些组件的draggable属性设置为true，即可使用默认拖拽能力。其中，Text、TextInput、TextArea、Hyperlink、Image、RichEditor和Web组件的draggable属性默认为true。

• 默认支持拖出能力的组件（可从组件上拖出数据）：[Search]、[TextInput]、[TextArea]、[RichEditor]、[Text]、[Image]、[Hyperlink]
• 默认支持拖入能力的组件（目标组件可响应拖入数据）：[Search]、[TextInput]、[TextArea]、[Video]、[RichEditor]

开发者也可以通过实现通用拖拽事件来自定义拖拽响应。

其他组件需要开发者将draggable属性设置为true，并在onDragStart等接口中实现数据传输相关内容，才能正确处理拖拽。

说明

Text组件需配合[copyOption]一起使用，设置copyOptions为CopyOptions.InApp或者CopyOptions.LocalDevice。

allowDrop

allowDrop(value: Array | null)

设置该组件上允许落入的数据类型。

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

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

参数：

参数名	类型	必填	说明
value	Array<[UniformDataType]>	null12+	是

draggable

draggable(value: boolean)

设置该组件是否允许进行拖拽。

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

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

参数：

参数名	类型	必填	说明
value	boolean	是	设置该组件是否允许进行拖拽。默认值：false

dragPreview11+

dragPreview(value: CustomBuilder | DragItemInfo | string)

设置组件拖拽过程中的预览图。

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

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

参数：

参数名	类型	必填	说明
value	[CustomBuilder]	[DragItemInfo]	string12+

dragPreviewOptions11+

dragPreviewOptions(value: DragPreviewOptions, options?: DragInteractionOptions)

设置拖拽过程中背板图处理模式及数量角标的显示。不支持onItemDragStart拖拽方式。

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

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

参数：

参数名	类型	必填	说明
value	[DragPreviewOptions]11+	是	设置拖拽过程中背板图处理模式及数量角标的