LongPressGesture-手势处理-组件通用信息-ArkTS组件-ArkUI（方舟UI框架）-应用框架

用于触发长按手势事件，触发长按手势的最少手指数为1，最短长按时间为500毫秒。

说明

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

接口

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

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

长按触发时间 < 500ms，长按事件优先拖拽事件响应。

长按触发时间 >= 500ms，拖拽事件优先长按事件响应。

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

参数：

展开

参数名称	参数类型	必填	参数描述
fingers	number	否	触发长按的最少手指数，最小为1指，最大取值为10指。默认值：1 说明：手指按下后若发生超过15px的移动，则判定当前长按手势识别失败。
repeat	boolean	否	是否连续触发事件回调。默认值：false
duration	number	否	触发长按的最短时间，单位为毫秒（ms）。默认值：500 说明：设置小于等于0时，按照默认值500处理。

参数名称

参数类型

必填

参数描述

fingers

number

否

触发长按的最少手指数，最小为1指，最大取值为10指。

默认值：1

说明：

手指按下后若发生超过15px的移动，则判定当前长按手势识别失败。

repeat

boolean

否

是否连续触发事件回调。

默认值：false

duration

number

否

触发长按的最短时间，单位为毫秒（ms）。

默认值：500

说明：

设置小于等于0时，按照默认值500处理。

事件

展开

名称	功能描述
onAction(event:(event: GestureEvent) => void)	LongPress手势识别成功回调。元服务API：从API version 11开始，该接口支持在元服务中使用。
onActionEnd(event:(event: GestureEvent) => void)	LongPress手势识别成功，最后一根手指抬起后触发回调。元服务API：从API version 11开始，该接口支持在元服务中使用。
onActionCancel(event: () => void)	LongPress手势识别成功，接收到触摸取消事件触发回调。元服务API：从API version 11开始，该接口支持在元服务中使用。

名称

功能描述

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

LongPress手势识别成功回调。

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

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

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

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

onActionCancel(event: () => void)

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

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

属性

展开

名称	类型	描述
tag¹¹⁺	string	设置LongPress手势标志，用于自定义手势判定时区分绑定的手势。元服务API：从API version 11开始，该接口支持在元服务中使用。
allowedTypes¹⁴⁺	Array<SourceTool>	设置LongPress手势支持的事件输入源。元服务API：从API version 14开始，该接口支持在元服务中使用。

名称

类型

描述

tag¹¹⁺

string

设置LongPress手势标志，用于自定义手势判定时区分绑定的手势。

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

allowedTypes¹⁴⁺

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)
  }
}