Property

LocalOverscrollConfiguration

Composition local to provide configuration for scrolling containers down the hierarchy.

Source set: Android
@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)`",
    replaceWith =
        ReplaceWith("LocalOverscrollFactory", "androidx.compose.foundation.LocalOverscrollFactory"),
)
public val LocalOverscrollConfiguration: ProvidableCompositionLocal<OverscrollConfiguration?> =
    compositionLocalOf<OverscrollConfiguration?> { OverscrollConfiguration() }

Composition local to provide configuration for scrolling containers down the hierarchy. null means there will be no overscroll at all.

Jetpack Compose beyond MaterialFree components, screens and templates for apps that don’t look like Google’s. Copy them into your app, or let your coding agent add them.Browse for free

Content updated: