{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

KeyEventType.Companion

public static class KeyEventType.Companion


Summary

Public methods

static final @NonNull KeyEventType

Type of KeyEvent sent when the user presses down their finger on a key on the keyboard.

static final @NonNull KeyEventType

Type of KeyEvent sent when the user lifts their finger off a key on the keyboard.

static final @NonNull KeyEventType

Unknown key event.

Public methods

getKeyDown

public static final @NonNull KeyEventType getKeyDown()

Type of KeyEvent sent when the user presses down their finger on a key on the keyboard.

import androidx.compose.foundation.focusable
import androidx.compose.foundation.layout.Box
import androidx.compose.ui.Modifier
import androidx.compose.ui.input.key.Key
import androidx.compose.ui.input.key.KeyEventType.Companion.KeyDown
import androidx.compose.ui.input.key.KeyEventType.Companion.KeyUp
import androidx.compose.ui.input.key.KeyEventType.Companion.Unknown
import androidx.compose.ui.input.key.key
import androidx.compose.ui.input.key.onKeyEvent
import androidx.compose.ui.input.key.type

Box(
    Modifier
        .onKeyEvent {
            when (it.type) {
                KeyUp -> println(" KeyUp Pressed")
                KeyDown -> println(" KeyUp Pressed")
                Unknown -> println("Unknown key type")
                else -> println("New KeyTpe (For Future Use)")
            }
            false
        }
        .focusable()
)

getKeyUp

public static final @NonNull KeyEventType getKeyUp()

Type of KeyEvent sent when the user lifts their finger off a key on the keyboard.

import androidx.compose.foundation.focusable
import androidx.compose.foundation.layout.Box
import androidx.compose.ui.Modifier
import androidx.compose.ui.input.key.Key
import androidx.compose.ui.input.key.KeyEventType.Companion.KeyDown
import androidx.compose.ui.input.key.KeyEventType.Companion.KeyUp
import androidx.compose.ui.input.key.KeyEventType.Companion.Unknown
import androidx.compose.ui.input.key.key
import androidx.compose.ui.input.key.onKeyEvent
import androidx.compose.ui.input.key.type

Box(
    Modifier
        .onKeyEvent {
            when (it.type) {
                KeyUp -> println(" KeyUp Pressed")
                KeyDown -> println(" KeyUp Pressed")
                Unknown -> println("Unknown key type")
                else -> println("New KeyTpe (For Future Use)")
            }
            false
        }
        .focusable()
)

getUnknown

public static final @NonNull KeyEventType getUnknown()

Unknown key event.

import androidx.compose.foundation.focusable
import androidx.compose.foundation.layout.Box
import androidx.compose.ui.Modifier
import androidx.compose.ui.input.key.Key
import androidx.compose.ui.input.key.KeyEventType.Companion.KeyDown
import androidx.compose.ui.input.key.KeyEventType.Companion.KeyUp
import androidx.compose.ui.input.key.KeyEventType.Companion.Unknown
import androidx.compose.ui.input.key.key
import androidx.compose.ui.input.key.onKeyEvent
import androidx.compose.ui.input.key.type

Box(
    Modifier
        .onKeyEvent {
            when (it.type) {
                KeyUp -> println(" KeyUp Pressed")
                KeyDown -> println(" KeyUp Pressed")
                Unknown -> println("Unknown key type")
                else -> println("New KeyTpe (For Future Use)")
            }
            false
        }
        .focusable()
)