如何从 Jetpack Compose TextField 关闭虚拟键盘？

Question

我正在使用 Jetpack Compose TextField，我想在用户按下操作按钮（imeActionPerformed参数）时关闭虚拟键盘。

val text = +state { "" }
TextField(
    value = text.value,
    keyboardType = KeyboardType.Text,
    imeAction = ImeAction.Done,
    onImeActionPerformed = { 
        // TODO Close the virtual keyboard here <<<
    }
    onValueChange = { s -> text.value = s }
)

Answer 1

有了1.0.x你可以使用LocalSoftwareKeyboardController类来控制电流软键盘，然后使用hide方法：

var text by remember { mutableStateOf(TextFieldValue("Text")) }
val keyboardController = LocalSoftwareKeyboardController.current

TextField(
        value = text,
        onValueChange = {
            text = it
        },
        label = { Text("Label") },
        keyboardOptions = KeyboardOptions(imeAction = ImeAction.Done),
        keyboardActions = KeyboardActions(
                onDone = {keyboardController?.hide()})
)

Answer 2

从 compose 开始1.0.0-alpha12（并且在 compose 中仍然有效1.0.1）onImeActionPerformed已弃用，建议的方法是keyboardActions与以下组合一起使用keyboardOptions：

    val focusManager = LocalFocusManager.current

    OutlinedTextField(
        value = ...,
        onValueChange = ...,
        label = ...,
        keyboardActions = KeyboardActions(onDone = { focusManager.clearFocus() }),
        keyboardOptions = KeyboardOptions.Default.copy(imeAction = ImeAction.Done, keyboardType = KeyboardType.Password),
    )

focusManager.clearFocus() 将负责关闭软键盘。

Answer 3

单击按钮时隐藏键盘

要添加Gabriele Mariotti 的解决方案，如果您想有条件地隐藏键盘，例如单击按钮后，请使用以下命令：

keyboardController?.hide()

例如，单击“添加”按钮后隐藏键盘：

var newWord by remember { mutableStateOf("") }
val keyboardController = LocalSoftwareKeyboardController.current

// Setup the text field with keyboard as provided by Gabriele Mariotti

...

Button(
        modifier = Modifier
                .height(56.dp),
        onClick = {
                if (!newWord.trim().isNullOrEmpty()) {
                        wordViewModel.onAddWord(newWord.trim())
                        newWord = ""
                        keyboardController?.hide()
                }
        ...

Answer 4

在1.0.0您可以使用SoftwareKeyboardController或FocusManager来做到这一点。

这个答案侧重于它们的差异。

设置：

var text by remember { mutableStateOf("")}

TextField(
    value = text,
    onValueChange = { text = it },
    keyboardOptions = KeyboardOptions(imeAction = ImeAction.Done),
    keyboardActions = KeyboardActions(onDone = { /* TODO */ }),
)

软件键盘控制器：

根据@Gabriele Mariottis答案。

val keyboardController = LocalSoftwareKeyboardController.current

// TODO =
keyboardController?.hide()

这仅关闭键盘，但不清除的重点从任何集中文本字段（注意光标和粗底线）。

焦点管理器：

根据@azizbekians答案。

val focusManager = LocalFocusManager.current

// TODO =
focusManager.clearFocus()

这将关闭键盘并清除 TextField 的焦点。