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 If multi-tap is configured, the timeout interval between a lift and the next tap is 300 ms. |
| 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. When multi-finger is configured, if the number of fingers used for tap does not reach the specified number within 300 ms after the first finger is tapped, the gesture fails to be recognized. 2. Gesture recognition fails if the number of fingers used for tap exceeds the configured number. |
Events
| Name | Description |
|---|---|
| onAction(event: (event?: GestureEvent) => void) | Callback invoked when a tap gesture is recognized. |
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) => {
this.value = JSON.stringify(event.fingerList[0])
})
)
Text(this.value)
}
.height(200)
.width(300)
.padding(20)
.border({ width: 3 })
.margin(30)
}
}
