Flexible and customizable context menu library enhances text fields in Compose for Desktop applications, offering multiple UI styles, flexible architecture, and extensive customization options.
A flexible, customizable context menu library for Compose for Desktop applications.
KontextMenu is a Kotlin library that provides a simple way to create and customize context menus in text fields for Compose for Desktop applications. It offers a clean API with sensible defaults while allowing for extensive customization.
Add the dependency to your build.gradle.kts file:
dependencies {
implementation("io.github.joshmcrose:kontextmenu:0.1.2")
}
Here's a simple example of how to use KontextMenu with Material3 styling:
@Composable
fun MyTextEditor() {
var text by remember { mutableStateOf("Select this text to see the context menu") }
KontextMenu(
cut = { /* Handle cut operation */ },
copy = { /* Handle copy operation */ },
paste = { /* Handle paste operation */ }
) {
TextField(
value = text,
onValueChange = { text = it }
)
}
}
The core component that creates the context menu area. It handles the detection of right-clicks and displays the context menu.
KontextMenuArea(
menuContent = { items, onDismissRequest ->
// Your custom menu UI here
},
builder = {
// Add your menu items here
customItem.add()
anotherItem.add()
listOfItems.addAll()
}
)
An interface that defines how the context menu is displayed. KontextMenu comes with two implementations:
Popup container.KontextMenu provides ready-to-use context menu implementations:
KontextMenu(
cut = { /* Handle cut */ },
copy = { /* Handle copy */ },
paste = { /* Handle paste */ }
) {
// Your text field here
}
KontextMenu(
cut = { /* Handle cut */ },
copy = { /* Handle copy */ },
paste = { /* Handle paste */ }
) {
// Your text field here
}
DialogKontextMenu(
cut = { /* Handle cut */ },
copy = { /* Handle copy */ },
paste = { /* Handle paste */ }
) {
// Your text field here
}
Create your own context menu representation by implementing the KontextMenuRepresentation interface:
class MyCustomKontextMenuRepresentation : KontextMenuRepresentation {
@Composable
override fun <T> Representation(
state: ContextMenuState,
menuContent: @ (: <>, : (() -> )?) -> ,
items: <>
) {
}
}
Then use it with the KontextMenu composable:
KontextMenu(
content = { /* Your content */ },
textContextMenuRepresentation = MyCustomKontextMenuRepresentation(),
textContextMenuArea = kontextMenuArea(
menuContent = { items, onDismissRequest ->
// Your custom menu UI
},
builder = { /* Add your items */ }
)
)
KontextMenu Docs powered by Dokka
This library is released under the MIT License. See the LICENSE file for details.
Surfaced from shared tags and platforms — no rankings paid for.