Package-level declarations

Types

Link copied to clipboard
data class TooltipParameters(val text: String, val singleLine: Boolean = false, val placement: PopoverCaretTipPlacement = PopoverCaretTipPlacement.Top, val alignment: PopoverCaretTipAlignment = PopoverCaretTipAlignment.Center)

Parameters for the tooltip component.

Functions

Link copied to clipboard
fun TooltipBox(parameters: TooltipParameters, uiTriggerMutableInteractionSource: MutableInteractionSource = remember { MutableInteractionSource() }, modifier: Modifier = Modifier, content: @Composable () -> Unit)

Convenience composable for TooltipBox that takes a TooltipParameters object as a parameter.

fun TooltipBox(tooltipText: String, modifier: Modifier = Modifier, singleLine: Boolean = false, placement: PopoverCaretTipPlacement = PopoverCaretTipPlacement.Top, alignment: PopoverCaretTipAlignment = PopoverCaretTipAlignment.Center, uiTriggerMutableInteractionSource: MutableInteractionSource = remember { MutableInteractionSource() }, content: @Composable () -> Unit)

Composable wrapping a UI trigger (e.g. a button) and displaying a tooltip when the user hovers over or focuses on the UI trigger.