LongPressGesture

用于触发长按手势事件，触发长按手势的最少手指数为1，默认最短长按时间为500毫秒。可配置duration参数控制最短长按时长。

说明：

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

部分设备会优先响应系统的双指长按手势，导致应用的双指长按手势不生效。

接口

LongPressGesture

LongPressGesture(value?: { fingers?: number, repeat?: boolean, duration?: number })

设置长按手势事件。

当组件默认支持可拖拽时，如Text、TextInput、TextArea、HyperLink、Image和RichEditor等组件。长按手势与拖拽会出现冲突，事件优先级如下：

当长按触发时间小于500毫秒时，系统优先响应长按事件而非拖拽事件。

当长按触发时间达到或超过500毫秒时，系统优先响应拖拽事件而非长按事件。

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

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

参数：

参数名	类型	必填	说明
value	{ fingers?: number, repeat?: boolean, duration?: number }	否	设置长按手势事件参数。 - fingers：触发长按的最少手指数，最小值为1， 最大值为10。 默认值：1 - repeat：是否连续触发事件回调。true表示连续触发事件回调，false表示不连续触发事件回调。 默认值：false - duration：触发长按的最短时间，单位为毫秒（ms）。 默认值：500

LongPressGesture¹⁵⁺

LongPressGesture(options?: LongPressGestureHandlerOptions)

设置长按手势事件。与LongPressGesture相比，options参数新增了对isFingerCountLimited参数，表示是否检查触摸屏幕的手指数量。

当组件默认支持可拖拽时，如Text、TextInput、TextArea、HyperLink、Image和RichEditor等组件。长按手势与拖拽会出现冲突，事件优先级如下：

当长按触发时间小于500毫秒时，系统优先响应长按事件而非拖拽事件。

当长按触发时间达到或超过500毫秒时，系统优先响应拖拽事件而非长按事件。

原子化服务API： 从API version 15开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
options	LongPressGestureHandlerOptions	否	长按手势处理器配置参数。

事件

onAction

+onAction(event: (event: GestureEvent) => void)

LongPress手势识别成功回调。

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

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

参数：

参数名	类型	必填	说明
event	(event: GestureEvent) => void	是	手势事件回调函数。

onActionEnd

onActionEnd(event: (event: GestureEvent) => void)

LongPress手势识别成功，最后一根手指抬起后触发回调。

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

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

参数：

参数名	类型	必填	说明
event	(event: GestureEvent) => void	是	手势事件回调函数。

onActionCancel

onActionCancel(event: () => void)

LongPress手势识别成功，接收到触摸取消事件触发回调。不返回手势事件信息。

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

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

参数：

参数名	类型	必填	说明
event	() => void	是	手势事件回调函数。

onActionCancel¹⁸⁺

onActionCancel(event: Callback<GestureEvent>)

LongPress手势识别成功，接收到触摸取消事件触发回调。返回手势事件信息。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

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

参数：

参数名	类型	必填	说明
event	Callback<GestureEvent>	是	手势事件回调函数。

属性

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

名称	类型	只读	可选	说明
tag11+	string	否	否	设置LongPress手势标志，用于自定义手势判定时区分绑定的手势。 原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。
allowedTypes14+	Array<SourceTool>	否	否	设置LongPress手势支持的事件输入源。 原子化服务API： 从API version 14开始，该接口支持在原子化服务中使用。

示例

该示例通过LongPressGesture实现了长按手势的识别。

// xxx.ets
@Entry
@Component
struct LongPressGestureExample {
  @State count: number = 0;

  build() {
    Column() {
      Text('LongPress onAction:' + this.count).fontSize(28)
        // 单指长按文本触发该手势事件
        .gesture(
        LongPressGesture({ repeat: true })
          // 由于repeat设置为true，长按动作存在时会连续触发，触发间隔为duration（默认值500ms）
          .onAction((event: GestureEvent) => {
            if (event && event.repeat) {
              this.count++
            }
          })
            // 长按动作一结束触发
          .onActionEnd((event: GestureEvent) => {
            this.count = 0
          })
        )
    }
    .height(200)
    .width(300)
    .padding(20)
    .border({ width: 3 })
    .margin(30)
  }
}