{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

ScrollableKt

public final class ScrollableKt


Summary

Public methods

static final @NonNull Modifier
scrollable(
    @NonNull Modifier receiver,
    @NonNull ScrollableState state,
    @NonNull Orientation orientation,
    boolean enabled,
    boolean reverseDirection,
    FlingBehavior flingBehavior,
    MutableInteractionSource interactionSource
)

Configure touch scrolling and flinging for the UI element in a single Orientation.

static final @NonNull Modifier
@ExperimentalFoundationApi
scrollable(
    @NonNull Modifier receiver,
    @NonNull ScrollableState state,
    @NonNull Orientation orientation,
    OverscrollEffect overscrollEffect,
    boolean enabled,
    boolean reverseDirection,
    FlingBehavior flingBehavior,
    MutableInteractionSource interactionSource
)

Configure touch scrolling and flinging for the UI element in a single Orientation.

Public methods

scrollable

public static final @NonNull Modifier scrollable(
    @NonNull Modifier receiver,
    @NonNull ScrollableState state,
    @NonNull Orientation orientation,
    boolean enabled,
    boolean reverseDirection,
    FlingBehavior flingBehavior,
    MutableInteractionSource interactionSource
)

Configure touch scrolling and flinging for the UI element in a single Orientation.

Users should update their state themselves using default ScrollableState and its consumeScrollDelta callback or by implementing ScrollableState interface manually and reflect their own state in UI when using this component.

If you don't need to have fling or nested scroll support, but want to make component simply draggable, consider using draggable.

import androidx.compose.foundation.background
import androidx.compose.foundation.gestures.Orientation
import androidx.compose.foundation.gestures.rememberScrollableState
import androidx.compose.foundation.gestures.scrollable
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.size
import androidx.compose.material.Text
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.sp

// actual composable state that we will show on UI and update in `Scrollable`
val offset = remember { mutableStateOf(0f) }
Box(
    Modifier
        .size(150.dp)
        .scrollable(
            orientation = Orientation.Vertical,
            // state for Scrollable, describes how consume scroll amount
            state = rememberScrollableState { delta ->
                // use the scroll data and indicate how much this element consumed.
                // unconsumed deltas will be propagated to nested scrollables (if present)
                offset.value = offset.value + delta // update the state
                delta // indicate that we consumed all the pixels available
            }
        )
        .background(Color.LightGray),
    contentAlignment = Alignment.Center
) {
    // Modifier.scrollable is not opinionated about its children's layouts. It will however
    // promote nested scrolling capabilities if those children also use the modifier.
    // The modifier will not change any layouts so one must handle any desired changes through
    // the delta values in the scrollable state
    Text(offset.value.roundToInt().toString(), style = TextStyle(fontSize = 32.sp))
}
Parameters
@NonNull ScrollableState state

ScrollableState state of the scrollable. Defines how scroll events will be interpreted by the user land logic and contains useful information about on-going events.

@NonNull Orientation orientation

orientation of the scrolling

boolean enabled

whether or not scrolling in enabled

boolean reverseDirection

reverse the direction of the scroll, so top to bottom scroll will behave like bottom to top and left to right will behave like right to left.

FlingBehavior flingBehavior

logic describing fling behavior when drag has finished with velocity. If null, default from ScrollableDefaults.flingBehavior will be used.

MutableInteractionSource interactionSource

MutableInteractionSource that will be used to emit drag events when this scrollable is being dragged.

scrollable

@ExperimentalFoundationApi
public static final @NonNull Modifier scrollable(
    @NonNull Modifier receiver,
    @NonNull ScrollableState state,
    @NonNull Orientation orientation,
    OverscrollEffect overscrollEffect,
    boolean enabled,
    boolean reverseDirection,
    FlingBehavior flingBehavior,
    MutableInteractionSource interactionSource
)

Configure touch scrolling and flinging for the UI element in a single Orientation.

Users should update their state themselves using default ScrollableState and its consumeScrollDelta callback or by implementing ScrollableState interface manually and reflect their own state in UI when using this component.

If you don't need to have fling or nested scroll support, but want to make component simply draggable, consider using draggable.

This overload provides the access to OverscrollEffect that defines the behaviour of the over scrolling logic. Consider using ScrollableDefaults.overscrollEffect for the platform look-and-feel.

import androidx.compose.foundation.background
import androidx.compose.foundation.gestures.Orientation
import androidx.compose.foundation.gestures.rememberScrollableState
import androidx.compose.foundation.gestures.scrollable
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.size
import androidx.compose.material.Text
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.sp

// actual composable state that we will show on UI and update in `Scrollable`
val offset = remember { mutableStateOf(0f) }
Box(
    Modifier
        .size(150.dp)
        .scrollable(
            orientation = Orientation.Vertical,
            // state for Scrollable, describes how consume scroll amount
            state = rememberScrollableState { delta ->
                // use the scroll data and indicate how much this element consumed.
                // unconsumed deltas will be propagated to nested scrollables (if present)
                offset.value = offset.value + delta // update the state
                delta // indicate that we consumed all the pixels available
            }
        )
        .background(Color.LightGray),
    contentAlignment = Alignment.Center
) {
    // Modifier.scrollable is not opinionated about its children's layouts. It will however
    // promote nested scrolling capabilities if those children also use the modifier.
    // The modifier will not change any layouts so one must handle any desired changes through
    // the delta values in the scrollable state
    Text(offset.value.roundToInt().toString(), style = TextStyle(fontSize = 32.sp))
}
Parameters
@NonNull ScrollableState state

ScrollableState state of the scrollable. Defines how scroll events will be interpreted by the user land logic and contains useful information about on-going events.

@NonNull Orientation orientation

orientation of the scrolling

OverscrollEffect overscrollEffect

effect to which the deltas will be fed when the scrollable have some scrolling delta left. Pass null for no overscroll. If you pass an effect you should also apply androidx.compose.foundation.overscroll modifier.

boolean enabled

whether or not scrolling in enabled

boolean reverseDirection

reverse the direction of the scroll, so top to bottom scroll will behave like bottom to top and left to right will behave like right to left.

FlingBehavior flingBehavior

logic describing fling behavior when drag has finished with velocity. If null, default from ScrollableDefaults.flingBehavior will be used.

MutableInteractionSource interactionSource

MutableInteractionSource that will be used to emit drag events when this scrollable is being dragged.