1# LongPressGesture
2
3用于触发长按手势事件,触发长按手势的最少手指数为1,最短长按时间为500毫秒。
4
5>  **说明:**
6>
7>  从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8
9
10## 接口
11
12LongPressGesture(value?: { fingers?: number, repeat?: boolean, duration?: number })
13
14当组件默认支持可拖拽时,如Text、TextInput、TextArea、HyperLink、Image和RichEditor等组件。长按手势与拖拽会出现冲突,事件优先级如下:
15
16长按触发时间 < 500ms,长按事件优先拖拽事件响应。
17
18长按触发时间 >= 500ms,拖拽事件优先长按事件响应。
19
20**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
21
22**参数:**
23
24| 参数名称 | 参数类型 | 必填 | 参数描述 |
25| -------- | -------- | -------- | -------- |
26| fingers | number | 否 | 触发长按的最少手指数,最小为1指,&nbsp;最大取值为10指。<br/>默认值:1 <br/> **说明:** <br/>手指按下后若发生超过15px的移动,则判定当前长按手势识别失败。|
27| repeat | boolean | 否 | 是否连续触发事件回调。<br/>默认值:false |
28| duration | number | 否 | 触发长按的最短时间,单位为毫秒(ms)。<br/>默认值:500 <br/>**说明:** <br/>设置小于等于0时,按照默认值500处理。|
29
30
31## 事件
32
33| 名称 | 功能描述 |
34| -------- | -------- |
35| onAction(event:(event:&nbsp;[GestureEvent](ts-gesture-settings.md#gestureevent对象说明))&nbsp;=&gt;&nbsp;void) | LongPress手势识别成功回调。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
36| onActionEnd(event:(event:&nbsp;[GestureEvent](ts-gesture-settings.md#gestureevent对象说明))&nbsp;=&gt;&nbsp;void) | LongPress手势识别成功,最后一根手指抬起后触发回调。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
37| onActionCancel(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | LongPress手势识别成功,接收到触摸取消事件触发回调。<br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
38
39## 属性
40
41| 名称 | 类型    |描述                                        |
42| ----  | ------  | ---------------------------------------- |
43| tag<sup>11+</sup>   | string  | 设置LongPress手势标志,用于自定义手势判定时区分绑定的手势。<br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。|
44| allowedTypes<sup>14+</sup> | Array\<[SourceTool](ts-gesture-settings.md#sourcetool枚举说明9)> | 设置LongPress手势支持的事件输入源。<br/>**原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。 |
45
46
47## 示例
48
49该示例通过TapGesture实现了长按手势的识别。
50
51```ts
52// xxx.ets
53@Entry
54@Component
55struct LongPressGestureExample {
56  @State count: number = 0
57
58  build() {
59    Column() {
60      Text('LongPress onAction:' + this.count).fontSize(28)
61        // 单指长按文本触发该手势事件
62        .gesture(
63        LongPressGesture({ repeat: true })
64          // 由于repeat设置为true,长按动作存在时会连续触发,触发间隔为duration(默认值500ms)
65          .onAction((event: GestureEvent) => {
66            if (event && event.repeat) {
67              this.count++
68            }
69          })
70            // 长按动作一结束触发
71          .onActionEnd((event: GestureEvent) => {
72            this.count = 0
73          })
74        )
75    }
76    .height(200)
77    .width(300)
78    .padding(20)
79    .border({ width: 3 })
80    .margin(30)
81  }
82}
83```
84
85![zh-cn_image_0000001174264380](figures/zh-cn_image_0000001174264380.gif)
86