Compose Modifier

onRotaryScrollEvent

Adding this modifier to the modifier parameter of a component will allow it to intercept RotaryScrollEvents if it (or one of its children) is focused.

RotaryEventSample

@Sampled
@Composable
fun RotaryEventSample() {
    val scrollState = rememberScrollState()
    val coroutineScope = rememberCoroutineScope()
    val focusRequester = remember { FocusRequester() }
    Column(
        modifier =
            Modifier.fillMaxWidth()
                .verticalScroll(scrollState)
                .onRotaryScrollEvent {
                    coroutineScope.launch {
                        scrollState.scrollTo(
                            (scrollState.value + it.verticalScrollPixels).roundToInt()
                        )
                    }
                    true
                }
                .focusRequester(focusRequester)
                .focusable()
    ) {
        repeat(100) {
            Text(text = "item $it", modifier = Modifier.align(CenterHorizontally), color = White)
        }
    }

    LaunchedEffect(Unit) { focusRequester.requestFocus() }
}

PreRotaryEventSample

@Sampled
@Composable
fun PreRotaryEventSample() {
    MaterialTheme(colorScheme = darkColorScheme()) {
        val rowScrollState = rememberScrollState()
        val columnScrollState = rememberScrollState()
        val coroutineScope = rememberCoroutineScope()
        val focusRequester = remember { FocusRequester() }
        var interceptScroll by remember { mutableStateOf(false) }
        Column(
            Modifier.onPreRotaryScrollEvent {
                    // You can intercept an event before it is sent to the child.
                    if (interceptScroll) {
                        coroutineScope.launch { rowScrollState.scrollBy(it.horizontalScrollPixels) }
                        // return true to consume this event.
                        true
                    } else {
                        // return false to ignore this event and continue propagation to the child.
                        false
                    }
                }
                .onRotaryScrollEvent {
                    // If the child does not use the scroll, we get notified here.
                    coroutineScope.launch { rowScrollState.scrollBy(it.horizontalScrollPixels) }
                    true
                }
        ) {
            Row(
                modifier = Modifier.align(CenterHorizontally),
                verticalAlignment = CenterVertically,
            ) {
                Text(
                    modifier = Modifier.width(70.dp),
                    text = if (interceptScroll) "Row" else "Column",
                    style = TextStyle(color = White),
                )
                Switch(checked = interceptScroll, onCheckedChange = { interceptScroll = it })
            }
            Row(modifier = Modifier.fillMaxWidth().horizontalScroll(rowScrollState)) {
                repeat(100) {
                    Text(
                        text = "row item $it ",
                        modifier = Modifier.align(CenterVertically),
                        color = White,
                    )
                }
            }
            Column(
                modifier =
                    Modifier.fillMaxWidth()
                        .verticalScroll(columnScrollState)
                        .onRotaryScrollEvent {
                            coroutineScope.launch {
                                columnScrollState.scrollBy(it.verticalScrollPixels)
                            }
                            true
                        }
                        .focusRequester(focusRequester)
                        .focusable()
            ) {
                repeat(100) {
                    Text(
                        text = "column item $it",
                        modifier = Modifier.align(CenterHorizontally),
                        color = White,
                    )
                }
            }
        }

        LaunchedEffect(Unit) { focusRequester.requestFocus() }
    }
}
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: