Show native contextual help around an independently accessible anchor.
Native example
Use brief supplemental help. Essential instructions belong in visible content. Pass LumenTooltipState for explicit Compose show/dismiss controls; React Native uses visible/onVisibleChange and SwiftUI uses isPresented binding. Disabling dismisses help without removing the anchor.
LumenTooltip("Save this project") {
LumenIconButton(LumenIconName.Bookmark, "Save", onClick = ::saveProject, size = LumenControlSize.Lg)
}Reference
The primary shared and platform-specific options exposed by LumenTooltip.
| API | Values or type | Default | Description |
|---|---|---|---|
| text | String | Required | Provides non-empty translated contextual help. |
| modifier | Modifier | Modifier | Applies anchor-container layout. |
| state | LumenTooltipState | rememberLumenTooltipState() | Supports application-controlled visibility with Lumen state backed by Material. |
| enabled | Boolean | true | Enables help and dismisses it when disabled. |
| content | @Composable () -> Unit | Required | Provides an independently labeled native anchor. |
Native behavior
Use brief supplemental help. Essential instructions belong in visible content. Pass LumenTooltipState for explicit Compose show/dismiss controls; React Native uses visible/onVisibleChange and SwiftUI uses isPresented binding. Disabling dismisses help without removing the anchor.
Keeps the anchor independently named and delegates long-press, pointer, and popup dismissal to Material.
Shared component