ts-basic-gestures-longpressgesture.md 2.5 KB
Newer Older
Z
zengyawen 已提交
1
# LongPressGesture
Z
zengyawen 已提交
2 3


Z
zengyawen 已提交
4 5 6 7 8
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE:**
> This gesture is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.


## Required Permissions
Z
zengyawen 已提交
9 10

None
Z
zengyawen 已提交
11

Z
zengyawen 已提交
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40

## APIs

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

- Parameters
    | Name | Type | Mandatory | Default Value | Description | 
  | -------- | -------- | -------- | -------- | -------- |
  | fingers | number | No | 1 | Minimum number of fingers to trigger a long press gesture. The value ranges from 1 to 10. | 
  | repeat | boolean | No | false | Whether to continuously trigger the event callback. | 
  | duration | number | No | 500 | Minimum hold-down time, in ms. | 


## Events

  | Name | Description | 
| -------- | -------- |
| onAction((event?: LongPressGestureEvent) => void) | Callback invoked when a long press gesture is recognized. | 
| onActionEnd((event?: LongPressGestureEvent) => void) | Callback invoked when the finger used for a long press gesture is lift. | 
| onActionCancel(event: () => void) | Callback invoked when a tap cancellation event is received after a long press gesture is recognized. | 

- LongPressGestureEvent<sup>8+</sup> attributes
    | Name | Type | Description | 
  | -------- | -------- | -------- |
  | repeat | boolean | Whether&nbsp;the&nbsp;event&nbsp;is&nbsp;repeated. | 


## Example

Z
zengyawen 已提交
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

```
@Entry
@Component
struct LongPressGestureExample {
  @State count: number = 0

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.SpaceBetween }) {
      Text('LongPress onAction:' + this.count)
    }
    .height(200).width(300).padding(60).border({ width:1 }).margin(30)
    .gesture(
      LongPressGesture({ repeat: true })
        // Repeatedly triggered when the long press gesture exists.
Z
zengyawen 已提交
56
        .onAction((event: LongPressGestureEvent) => {
Z
zengyawen 已提交
57 58 59 60 61 62 63 64 65 66 67
          if (event.repeat) { this.count++ }
        })
        // Triggered when the long press gesture ends.
        .onActionEnd(() => {
          this.count = 0
        })
    )
  }
}
```

Z
zengyawen 已提交
68
![en-us_image_0000001257058425](figures/en-us_image_0000001257058425.gif)