# NestedScrollSource

Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/input/nestedscroll/NestedScrollModifier.kt+class:androidx.compose.ui.input.nestedscroll.NestedScrollSource) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Common/All
- Cmn

  ```
  value class NestedScrollSource
  ```

*** ** * ** ***

Possible sources of scroll events in the `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollConnection`

## Summary

| ### Public companion properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource#Drag()` **This property is deprecated.** This has been replaced by UserInput. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource#Fling()` **This property is deprecated.** This has been replaced by SideEffect. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource#Relocate()` **This property is deprecated.** Do not use. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource#SideEffect()` Represents any other source of scroll events that are not a direct user input. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource#UserInput()` Represents any source of scroll events originated from a user interaction: mouse, touch, key events. | Cmn |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource#Wheel()` **This property is deprecated.** This has been replaced by UserInput. | Cmn |

| ### Public functions |
|---|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollSource#toString()()` | Cmn |

## Public companion properties

### Drag

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Deprecated in [1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.7.0)

```
val Drag: NestedScrollSource
```

> [!CAUTION]
> **This property is deprecated.**   
> This has been replaced by UserInput, use this instead:
>
> ```kotlin
> NestedScrollSource.UserInput
> ```

Dragging via mouse/touch/etc events.

### Fling

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Deprecated in [1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.7.0)

```
val Fling: NestedScrollSource
```

> [!CAUTION]
> **This property is deprecated.**   
> This has been replaced by SideEffect, use this instead:
>
> ```kotlin
> NestedScrollSource.SideEffect
> ```

Flinging after the drag has ended with velocity.

### Relocate

Cmn Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0) Deprecated in [1.0.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.0.0)

```
val Relocate: NestedScrollSource
```

> [!CAUTION]
> **This property is deprecated.**   
> Do not use. Will be removed in the future.

Relocating when a component asks parents to scroll to bring it into view.

### SideEffect

Cmn Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.7.0)

```
val SideEffect: NestedScrollSource
```

Represents any other source of scroll events that are not a direct user input. (e.g animations, fling)

### UserInput

Cmn Added in [1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.7.0)

```
val UserInput: NestedScrollSource
```

Represents any source of scroll events originated from a user interaction: mouse, touch, key events.

### Wheel

Cmn Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.6.0) Deprecated in [1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.7.0)

```
val Wheel: NestedScrollSource
```

> [!CAUTION]
> **This property is deprecated.**   
> This has been replaced by UserInput, use this instead:
>
> ```kotlin
> NestedScrollSource.UserInput
> ```

Scrolling via mouse wheel.

## Public functions

### toString

Cmn

```
open fun toString(): String
```