carbon/com.gabrieldrn.carbon.tooltip

Package-level declarations

Types

Link copied to clipboard
enum TooltipAlignment : Enum<TooltipAlignment>

The alignment of the tooltip relative to the UI trigger.

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

Parameters for the tooltip component.

Link copied to clipboard
enum TooltipPlacement : Enum<TooltipPlacement>

The placement of the tooltip relative to the UI trigger.

Functions

Link copied to clipboard
@Composable
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.

@Composable
fun TooltipBox(tooltipText: String, modifier: Modifier = Modifier, singleLine: Boolean = false, placement: TooltipPlacement = TooltipPlacement.Top, alignment: TooltipAlignment = TooltipAlignment.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.