Hints
Hints

Rich tooltip

A rich tooltip card with a title, body text and an inline action button.

Keyboard shortcut

Press ⌘K to open the command palette from anywhere.

Installation

caveui components are copy-paste Jetpack Compose built entirely on Material 3 — there's no caveui dependency to add. Make sure Material 3 is on your classpath (it ships with the Compose BOM), then copy the Usage snippet below into your project.

kotlin
// build.gradle.kts (module)
dependencies {
    implementation(platform("androidx.compose:compose-bom:2025.06.00"))
    implementation("androidx.compose.material3:material3")
}

Usage

kotlin
@OptIn(ExperimentalMaterial3Api::class)
@Composable
fun RichHint(content: @Composable () -> Unit) {
    val state = rememberTooltipState(isPersistent = true)
    TooltipBox(
        positionProvider = TooltipDefaults.rememberRichTooltipPositionProvider(),
        tooltip = {
            RichTooltip(
                title = { Text("Keyboard shortcut") },
                action = { TextButton(onClick = { /* dismiss */ }) { Text("Got it") } },
            ) {
                Text("Press ⌘K to open the command palette from anywhere.")
            }
        },
        state = state,
    ) {
        content()
    }
}