Create a button to enable snap scrolling

You can display a button to let a user snap scroll to a specific point in a list, saving time and increasing user engagement.

Version compatibility

This implementation requires that your project minSDK be set to API level 21 or higher.

Dependencies

Create a button to enable snap scrolling

Use the following code to create a button for smooth snap scrolling in a vertical lazy list with 10 items:

@Composable
fun MessageList(modifier: Modifier = Modifier) {
    val listState = rememberLazyListState()
    val coroutineScope = rememberCoroutineScope()

    LazyColumn(state = listState, modifier = Modifier.height(120.dp)) {
        items(10) { index ->
            Text(
                modifier = Modifier.height(40.dp),
                text = "Item $index"
            )
        }
    }

    Button(onClick = {
        coroutineScope.launch {
            listState.animateScrollToItem(index = 0)
        }
    }) {
        Text(text = "Go top")
    }
}
LazyListSnippets.kt

Key points about the code

• Uses the listState object to remember the scroll state of LazyColumn to the selected position.
• Launches a coroutine to call listState.animateScrollToItem, which scrolls to the indexed item while animating the scrolling action.

Results

Collections that contain this guide

This guide is part of these curated Quick Guide collections that cover broader Android development goals:

Have questions or feedback

Go to our frequently asked questions page and learn about quick guides or reach out and let us know your thoughts.

Go to FAQ Leave feedback