TapGesture
TapGesture is used to trigger a tap gesture with one, two, or more taps.
NOTE
This gesture is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.
APIs
TapGesture(value?: { count?: number, fingers?: number })
Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| count | number | No | Number of consecutive taps. If the value is less than 1 or is not set, the default value is used. Default value: 1 NOTE 1. If multi-tap is configured, the timeout interval between a lift and the next tap is 300 ms. 2. If the distance between the last tapped position and the current tapped position exceeds 60 vp, gesture recognition fails. |
| fingers | number | No | Number of fingers required to trigger a tap. The value ranges from 1 to 10. If the value is less than 1 or is not set, the default value is used. Default value: 1 NOTE 1. If the value is greater than 1, the tap gesture will fail to be recognized when the number of fingers pressing the screen within 300 ms of the first finger's being pressed is less than the required number, or when the number of fingers lift from the screen within 300 ms of the first finger's being lift is less than the required number. 2. When the number of fingers touching the screen exceeds the set value, the gesture can be recognized. |
Events
| Name | Description |
|---|---|
| onAction(event: (event: GestureEvent) => void) | Callback invoked when a tap gesture is recognized. |
Attributes
| Name | Type | Description |
|---|---|---|
| tag11+ | string | Tag for the tap gesture. It is used to distinguish the gesture during custom gesture judgment. |
Example
// xxx.ets
@Entry
@Component
struct TapGestureExample {
@State value: string = ''
build() {
Column() {
// The gesture event is triggered by double-tapping.
Text('Click twice').fontSize(28)
.gesture(
TapGesture({ count: 2 })
.onAction((event?: GestureEvent) => {
if (event) {
this.value = JSON.stringify(event.fingerList[0])
}
})
)
Text(this.value)
}
.height(200)
.width(300)
.padding(20)
.border({ width: 3 })
.margin(30)
}
}
