<div class='type'>Compose Modifier</div>

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


<h2 id="overscroll-overscrolleffect">overscroll</h2>

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


```kotlin
fun Modifier.overscroll(overscrollEffect: OverscrollEffect?): Modifier
```


Renders overscroll from the provided `overscrollEffect`.

This modifier attaches the provided `overscrollEffect`'s `OverscrollEffect.node` to the
hierarchy, which renders the actual effect. Note that this modifier is only responsible for the
visual part of overscroll - on its own it will not handle input events. In addition to using this
modifier you also need to propagate events to the `overscrollEffect`, most commonly by using a
`androidx.compose.foundation.gestures.scrollable`.

Alternatively, you can use a higher level API such as `verticalScroll` or
`androidx.compose.foundation.lazy.LazyColumn` and provide a custom `OverscrollEffect` - these
components will both render and provide events to the `OverscrollEffect`, so you do not need to
manually render the effect with this modifier.

#### Parameters

| | |
| --- | --- |
| overscrollEffect | the `OverscrollEffect` to render |