Compose Multiplatform Material3/androidx.compose.material3/RichTooltip

RichTooltip

@Composable
fun TooltipScope.RichTooltip(modifier: Modifier = Modifier, title: @Composable () -> Unit? = null, action: @Composable () -> Unit? = null, caretSize: DpSize = DpSize.Unspecified, shape: Shape = TooltipDefaults.richTooltipContainerShape, colors: RichTooltipColors = TooltipDefaults.richTooltipColors(), tonalElevation: Dp = ElevationTokens.Level0, shadowElevation: Dp = RichTooltipTokens.ContainerElevation, text: @Composable () -> Unit)

Rich text tooltip that allows the user to pass in a title, text, and action. Tooltips are used to provide a descriptive message.

Usually used with TooltipBox

Parameters

modifier

the Modifier to be applied to the tooltip.

title

An optional title for the tooltip.

action

An optional action for the tooltip.

caretSize

DpSize for the caret of the tooltip, if a default caret is desired with a specific dimension. Please see TooltipDefaults.caretSize to see the default dimensions. Pass in Dp.Unspecified for this parameter if no caret is desired.

shape

the Shape that should be applied to the tooltip container.

colors

RichTooltipColors that will be applied to the tooltip's container and content.

tonalElevation

the tonal elevation of the tooltip.

shadowElevation

the shadow elevation of the tooltip.

text

the composable that will be used to populate the rich tooltip's text.