rememberPlatformOverscrollFactory

Common/AllAndroid/JVM

Functions summary

OverscrollFactory

@Composable rememberPlatformOverscrollFactory(     glowColor: Color,     glowDrawPadding: PaddingValues ) Creates and remembers an instance of the platform OverscrollFactory, with the provided glowColor and glowDrawPadding values - these values will be used on platform versions where glow overscroll is used.

android

Functions

rememberPlatformOverscrollFactory

android

Artifact: androidx.compose.foundation:foundation

View Source

@Composable
fun rememberPlatformOverscrollFactory(
    glowColor: Color = DefaultGlowColor,
    glowDrawPadding: PaddingValues = DefaultGlowPaddingValues
): OverscrollFactory

Creates and remembers an instance of the platform OverscrollFactory, with the provided glowColor and glowDrawPadding values - these values will be used on platform versions where glow overscroll is used.

The OverscrollFactory returned from this function should be provided near the top of your application to LocalOverscrollFactory, in order to apply this across all components in your application.

Parameters
glowColor: Color = DefaultGlowColor	color for the glow effect if the platform effect is a glow effect, otherwise ignored.
glowDrawPadding: PaddingValues = DefaultGlowPaddingValues	the amount of padding to apply from the overscroll bounds to the effect before drawing it if the platform effect is a glow effect, otherwise ignored.