Start native apps faster with the Composables CLI ->
Compose Component

OneHandedGestureScrollIndicator

A scroll indicator that transitions to indicate that a scroll gesture is available to the user.

OneHandedGestureScrollIndicator

Source set: Android
@Composable
public fun OneHandedGestureScrollIndicator(
    gestureConfiguration: OneHandedGestureConfiguration,
    indicatorState: OneHandedGestureIndicatorState,
    scrollState: TransformingLazyColumnState,
    modifier: Modifier = Modifier,
    scrollIndicatorColors: ScrollIndicatorColors = ScrollIndicatorDefaults.colors(),
    gestureIndicatorTint: Color = OneHandedGestureDefaults.scrollIndicatorTint,
    gestureIndicatorBackgroundColor: Color =
        OneHandedGestureDefaults.scrollIndicatorBackgroundColor,
    reverseDirection: Boolean = false,
    positionAnimationSpec: AnimationSpec<Float> = ScrollIndicatorDefaults.PositionAnimationSpec,
)

Parameters
gestureConfiguration The configuration of the gesture associated with this indicator.
indicatorState The state object used to synchronize the indicator visibility.
scrollState The state object of the androidx.wear.compose.foundation.lazy.TransformingLazyColumn this indicator is coupled with.
modifier The Modifier to be applied to the scroll indicator.
scrollIndicatorColors ScrollIndicatorColors that will be used to resolve the indicator and track colors for this androidx.wear.compose.material3.ScrollIndicator.
gestureIndicatorTint The color which will be used for a tint of the gesture animation icon.
gestureIndicatorBackgroundColor The color which will be used for a background behind the gesture animation.
reverseDirection Reverses direction of ScrollIndicator if true.
positionAnimationSpec AnimationSpec for position animation. The Position animation is used for animating changes to the scroll size and position. To disable this animation androidx.compose.animation.core.snap AnimationSpec should be passed instead.

OneHandedGestureScrollIndicator

Source set: Android
@Composable
public fun OneHandedGestureScrollIndicator(
    gestureConfiguration: OneHandedGestureConfiguration,
    indicatorState: OneHandedGestureIndicatorState,
    scrollState: ScalingLazyListState,
    modifier: Modifier = Modifier,
    scrollIndicatorColors: ScrollIndicatorColors = ScrollIndicatorDefaults.colors(),
    gestureIndicatorTint: Color = OneHandedGestureDefaults.scrollIndicatorTint,
    gestureIndicatorBackgroundColor: Color =
        OneHandedGestureDefaults.scrollIndicatorBackgroundColor,
    reverseDirection: Boolean = false,
    positionAnimationSpec: AnimationSpec<Float> = ScrollIndicatorDefaults.PositionAnimationSpec,
)

Parameters
gestureConfiguration The configuration of the gesture associated with this indicator.
indicatorState The state object used to synchronize the indicator visibility.
scrollState The state object of the androidx.wear.compose.foundation.lazy.ScalingLazyColumn this indicator is coupled with.
modifier The Modifier to be applied to the scroll indicator.
scrollIndicatorColors ScrollIndicatorColors that will be used to resolve the indicator and track colors for this androidx.wear.compose.material3.ScrollIndicator.
gestureIndicatorTint The color which will be used for a tint of the gesture animation icon.
gestureIndicatorBackgroundColor The color which will be used for a background behind the gesture animation.
reverseDirection Reverses direction of ScrollIndicator if true.
positionAnimationSpec AnimationSpec for position animation. The Position animation is used for animating changes to the scroll size and position. To disable this animation androidx.compose.animation.core.snap AnimationSpec should be passed instead.

Last updated: