<div class='type'>Function</div>


<a id='references'></a>


<h2 id="awaitverticaltouchsloporcancellation-pointerid-ontouchslopreached">awaitVerticalTouchSlopOrCancellation</h2>

<div class='sourceset sourceset-common'>Common</div>


```kotlin
suspend fun AwaitPointerEventScope.awaitVerticalTouchSlopOrCancellation(
    pointerId: PointerId,
    onTouchSlopReached: (change: PointerInputChange, overSlop: Float) -> Unit,
) =
    awaitPointerSlopOrCancellation(
        pointerId = pointerId,
        pointerType = PointerType.Touch,
        onPointerSlopReached = { change, overSlop -> onTouchSlopReached(change, overSlop.y) },
        orientation = Orientation.Vertical,
    )
```


Waits for vertical drag motion to pass `touch slop`, using
`pointerId` as the pointer to examine. If `pointerId` is raised, another pointer from those that
are down will be chosen to lead the gesture, and if none are down, `null` is returned. If
`pointerId` is not down when `awaitVerticalTouchSlopOrCancellation` is called, then `null` is
returned.

`onTouchSlopReached` is called after `ViewConfiguration.touchSlop` motion in the vertical
direction with the change that caused the motion beyond touch slop and the pixels beyond touch
slop. `onTouchSlopReached` should consume the position change if it accepts the motion. If it
does, then the method returns that `PointerInputChange`. If not, touch slop detection will
continue.


Example Usage:

#### Returns

| | |
| --- | --- |
|  | The `PointerInputChange` that was consumed in `onTouchSlopReached` or `null` if all pointers are raised before touch slop is detected or another gesture consumed the position change. |