How can I detect keyboard opening and closing in jetpack compose?

by

Update

With the new WindowInsets API, it gets easier

First, to return the correct values, you need to set:

WindowCompat.setDecorFitsSystemWindows(window, false)

Then to use Keyboard as a state:

@Composable
fun keyboardAsState(): State<Boolean> {
    val isImeVisible = WindowInsets.ime.getBottom(LocalDensity.current) > 0
    return rememberUpdatedState(isImeVisible)
}

use example:

val isKeyboardOpen by keyboardAsState() // true or false

ps: I’ve tried to use WindowInsets.isImeVisible, but it returns true in the first call.

Without an experimental API

if you want with the statement, I found this solution:

enum class Keyboard {
    Opened, Closed
}

@Composable
fun keyboardAsState(): State<Keyboard> {
    val keyboardState = remember { mutableStateOf(Keyboard.Closed) }
    val view = LocalView.current
    DisposableEffect(view) {
        val onGlobalListener = ViewTreeObserver.OnGlobalLayoutListener {
            val rect = Rect()
            view.getWindowVisibleDisplayFrame(rect)
            val screenHeight = view.rootView.height
            val keypadHeight = screenHeight - rect.bottom
            keyboardState.value = if (keypadHeight > screenHeight * 0.15) {
                Keyboard.Opened
            } else {
                Keyboard.Closed
            }
        }
        view.viewTreeObserver.addOnGlobalLayoutListener(onGlobalListener)

        onDispose {
            view.viewTreeObserver.removeOnGlobalLayoutListener(onGlobalListener)
        }
    }

    return keyboardState
}

and to detect/check the value you’ll only need this:

val isKeyboardOpen by keyboardAsState() // Keyboard.Opened or Keyboard.Closed

More Related Contents:

  1. Jetpack Compose LazyColumn – How to update values of each Item seperately?
  2. How to set the Scaffold Drawer Width in JetpackCompose?
  3. How to share a viewmodel between two or more Jetpack composables inside a Compose NavGraph?
  4. Jetpack Compose – Order of Modifiers
  5. Why the view keeps flashing when using jetpack navigation with Compose?
  6. How are Android activities handled with Jetpack Compose and Compose Navigation?
  7. How to handle one-shot operations in Jetpack Compose?
  8. How can I detect a click with the view behind a Jetpack Compose Button?
  9. Pass Parcelable argument with compose navigation
  10. Jetpack Compose Text hyperlink some section of the text
  11. Jetpack Compose collapsing toolbar
  12. Jetpack Compose how does SubcomposeLayout work?
  13. Why does mutableStateOf without remember work sometimes?
  14. How to clear TextField focus when closing the keyboard and prevent two back presses needed to exit app in Jetpack Compose?
  15. Scoping States in Jetpack Compose
  16. What is the equivalent of [NestedScrollView + RecyclerView] or [Nested RecyclerView (Recycler inside another recycler) in Jetpack compose
  17. How to get preview in composable functions that depend on a view model?
  18. Different types of width in jetpack compose
  19. Jetpack compose – how do I refresh a screen when app returns to foreground
  20. AppCompatActivity instead of ComponentActivity in Jetpack compose
  21. Jetpack Compose lazy column all items recomposes when a single item update
  22. Error when adding buildFeatures in build.gradle file
  23. How to achieve a staggered grid layout using Jetpack compose?
  24. How to show animate an item view in LazyColumn on Jetpack Compose Android
  25. Jetpack Compose Navigation loads screen infinitely
  26. How to clip or cut a Composable?
  27. Exposed drop-down menu for jetpack compose
  28. When should I use Android Jetpack Compose Surface composable?
  29. Show custom alert dialog in Jetpack Compose
  30. What does Jetpack Compose remember actually do, how does it work under the hood?

Leave a Comment