imeNestedScroll

Modifier in Compose Foundation Layout

Controls the soft keyboard as a nested scrolling on Android [R][Build.VERSION_CODES.R] and later. This allows the user to drag the soft keyboard up and down.

After scrolling, the IME will animate either to the fully shown or fully hidden position, depending on the position and fling.

Last updated: 2024-09-07 14:23

Installation

dependencies {
   implementation("androidx.compose.foundation:foundation-layout:1.8.0-alpha01")
}

Overloads

@ExperimentalLayoutApi
fun Modifier.imeNestedScroll(): Modifier

Code Example

windowInsetsNestedScrollDemo

@OptIn(ExperimentalLayoutApi::class)
@Composable
fun windowInsetsNestedScrollDemo() {
    LazyColumn(
        modifier =
            Modifier.fillMaxSize() // fill the window
                .imePadding() // pad out the bottom for the IME
                .imeNestedScroll(), // scroll IME at the bottom
        reverseLayout = true // First item is at the bottom
    ) {
        // content
        items(50) { Text("Hello World") }
    }
}