compose-keyhandler
1.0.1indexedEnables key event handling by mapping keys to actions and executing them while pressed, suitable for interactive applications. Offers fine control over key event variables.
45
Stars
—
Used by
dependents
—
Health
/ 100
1. About the Project: Compose KeyHandler 🚀
Compose KeyHandler is a modern, lifecycle-aware library for handling keyboard input in Jetpack Compose/Compose Multiplatform. It provides a clean, Type-Safe Builder (DSL) to define single-key presses, complex key combinations, and continuous actions without manually tracking key states or managing coroutine loops.
Core Features:
- DSL-Driven Configuration: Map keys and combos using expressive blocks like
onPress { ... }andonHold { ... }. - Lifecycle-Aware Holds: Use the
KeyHandlerHostcomposable to safely manage continuousON_HOLDactions, preventing resource leaks and ensuring KMP stability. - Four Distinct Triggers: Clearly separate logic for different input needs:
onPress: Action runs once when the key/combo is pressed.onRelease: Action runs once when the key/combo is released.onRepeat: Action runs for every system-generated repeat event (good for text input).onHold: Action runs at a fixed, configurable frequency (e.g., 60 FPS) while the key/combo is down (perfect for game movement).
- Automatic Focus Management: The
KeyHandlerHostautomatically requests focus for the content it wraps to ensure key events are received.
2. Getting Started: Installation
build.gradle.kts
kotlin {
//...
sourceSets {
//...
commonMain.dependencies {
//...
//Format: groupId:artifactId:version
//groupId = io.github.loop312
//artifactId = compose-keyhandler
//version = 1.0.1 (choose latest version instead)
implementation("io.github.loop312:compose-keyhandler:1.0.1")
}
}
}
implementation("io.github.loop312:compose-keyhandler:1.0.1")