# OverscrollConfiguration

# OverscrollConfiguration

Artifact:[androidx.compose.foundation:foundation](https://developer.android.com/jetpack/androidx/releases/compose-foundation)  
[View Source](https://cs.android.com/search?q=file:androidx/compose/foundation/OverscrollConfiguration.android.kt+class:androidx.compose.foundation.OverscrollConfiguration)  
Added in[1.2.0](https://developer.android.com/jetpack/androidx/releases/compose-foundation#1.2.0)  
Deprecated in[1.8.0](https://developer.android.com/jetpack/androidx/releases/compose-foundation#1.8.0)
Common/AllAndroid/JVM
  - android  

  ```
  @ExperimentalFoundationApi
  class OverscrollConfiguration
  ```

*** ** * ** ***

| **This class is deprecated.**   
| Providing \`OverscrollConfiguration\` through \`LocalOverscrollConfiguration\` to disable / configure overscroll has been replaced with \`LocalOverscrollFactory\` and \`rememberPlatformOverscrollFactory\`. To disable overscroll, instead of \`LocalOverscrollConfiguration provides null\`, use \`LocalOverscrollFactory provides null\`. To change the glow color / padding, instead of \`LocalOverscrollConfiguration provides OverscrollConfiguration(myColor, myPadding)\`, use \`LocalOverscrollFactory provides rememberPlatformOverscrollFactory(myColor, myPadding)\`

Metadata for overscroll effects for android platform.

## Summary

|                                                                                                                                                                                                                                                                                                                                                         ### Public constructors                                                                                                                                                                                                                                                                                                                                                          |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| ~~[OverscrollConfiguration](https://developer.android.com/reference/kotlin/androidx/compose/foundation/OverscrollConfiguration#OverscrollConfiguration(androidx.compose.ui.graphics.Color,androidx.compose.foundation.layout.PaddingValues))~~`(glowColor: `[Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color)`, drawPadding: `[PaddingValues](https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues)`)` **This function is deprecated.**Providing \`OverscrollConfiguration\` through \`LocalOverscrollConfiguration\` to disable / configure overscroll has been replaced with \`LocalOverscrollFactory\` and \`rememberPlatformOverscrollFactory\`. | android |

|                                        ### Public functions                                         |
|-----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| `open operator `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/androidx/compose/foundation/OverscrollConfiguration#equals(kotlin.Any))`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` | android |
| `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | [hashCode](https://developer.android.com/reference/kotlin/androidx/compose/foundation/OverscrollConfiguration#hashCode())`()`                                                                                            | android |
| `open `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)            | [toString](https://developer.android.com/reference/kotlin/androidx/compose/foundation/OverscrollConfiguration#toString())`()`                                                                                            | android |

|                                              ### Public properties                                               |
|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| [PaddingValues](https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues) | [drawPadding](https://developer.android.com/reference/kotlin/androidx/compose/foundation/OverscrollConfiguration#drawPadding()) the amount of padding to apply from scrollable container bounds to the effect before drawing it, if the platform effect is a glow effect, otherwise ignored. | android |
| [Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color)                       | [glowColor](https://developer.android.com/reference/kotlin/androidx/compose/foundation/OverscrollConfiguration#glowColor()) color for the glow effect, if the platform effect is a glow effect, otherwise ignored.                                                                           | android |

## Public constructors

### OverscrollConfiguration

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

```
[OverscrollConfiguration](https://developer.android.com/reference/kotlin/androidx/compose/foundation/OverscrollConfiguration#OverscrollConfiguration(androidx.compose.ui.graphics.Color,androidx.compose.foundation.layout.PaddingValues))(
    glowColor: Color = Color(0xff666666),
    drawPadding: PaddingValues = PaddingValues()
)
```
| **This function is deprecated.**   
Providing \`OverscrollConfiguration\` through \`LocalOverscrollConfiguration\` to disable / configure overscroll has been replaced with \`LocalOverscrollFactory\` and \`rememberPlatformOverscrollFactory\`. To disable overscroll, instead of \`LocalOverscrollConfiguration provides null\`, use \`LocalOverscrollFactory provides null\`. To change the glow color / padding, instead of \`LocalOverscrollConfiguration provides OverscrollConfiguration(myColor, myPadding)\`, use \`LocalOverscrollFactory provides rememberPlatformOverscrollFactory(myColor, myPadding)\`  

|                                                                     Parameters                                                                      |
|-----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `glowColor: `[Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color)` = Color(0xff666666)`                       | color for the glow effect, if the platform effect is a glow effect, otherwise ignored.                                                                       |
| `drawPadding: `[PaddingValues](https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/PaddingValues)` = PaddingValues()` | the amount of padding to apply from scrollable container bounds to the effect before drawing it, if the platform effect is a glow effect, otherwise ignored. |

## Public functions

### equals

android  

```
open operator fun equals(other: Any?): Boolean
```  

### hashCode

android  

```
open fun hashCode(): Int
```  

### toString

android  

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

## Public properties

### drawPadding

android  
Added in[1.2.0](https://developer.android.com/jetpack/androidx/releases/compose-foundation#1.2.0)  
Deprecated in[1.8.0](https://developer.android.com/jetpack/androidx/releases/compose-foundation#1.8.0)  

```
val drawPadding: PaddingValues
```

the amount of padding to apply from scrollable container bounds to the effect before drawing it, if the platform effect is a glow effect, otherwise ignored.  

### glowColor

android  
Added in[1.2.0](https://developer.android.com/jetpack/androidx/releases/compose-foundation#1.2.0)  
Deprecated in[1.8.0](https://developer.android.com/jetpack/androidx/releases/compose-foundation#1.8.0)  

```
val glowColor: Color
```

color for the glow effect, if the platform effect is a glow effect, otherwise ignored.