RichTooltip

Functions summary

Unit

@Composable
TooltipScope.RichTooltip(
    modifier: Modifier,
    title: (@Composable () -> Unit)?,
    action: (@Composable () -> Unit)?,
    caretShape: Shape?,
    maxWidth: Dp,
    shape: Shape,
    colors: RichTooltipColors,
    tonalElevation: Dp,
    shadowElevation: Dp,
    text: @Composable () -> Unit
)

Rich text tooltip that allows the user to pass in a title, text, and action.

Cmn

Functions

TooltipScope.RichTooltip

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.5.0-alpha16

@Composable
fun TooltipScope.RichTooltip(
    modifier: Modifier = Modifier,
    title: (@Composable () -> Unit)? = null,
    action: (@Composable () -> Unit)? = null,
    caretShape: Shape? = null,
    maxWidth: Dp = TooltipDefaults.richTooltipMaxWidth,
    shape: Shape = TooltipDefaults.richTooltipContainerShape,
    colors: RichTooltipColors = TooltipDefaults.richTooltipColors(),
    tonalElevation: Dp = ElevationTokens.Level0,
    shadowElevation: Dp = RichTooltipTokens.ContainerElevation,
    text: @Composable () -> Unit
): 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: Modifier = Modifier`	the `Modifier` to be applied to the tooltip.
`title: (@Composable () -> Unit)? = null`	An optional title for the tooltip.
`action: (@Composable () -> Unit)? = null`	An optional action for the tooltip.
`caretShape: Shape? = null`	`shape` for the caret of the tooltip. If a default caret is desired with a specific dimension please use `TooltipDefaults.caretShape`. To see the default dimensions please see `TooltipDefaults.caretSize`. If no caret is desired, please pass in null.
`maxWidth: Dp = TooltipDefaults.richTooltipMaxWidth`	the maximum width for the plain tooltip
`shape: Shape = TooltipDefaults.richTooltipContainerShape`	the `Shape` that should be applied to the tooltip container.
`colors: RichTooltipColors = TooltipDefaults.richTooltipColors()`	`RichTooltipColors` that will be applied to the tooltip's container and content.
`tonalElevation: Dp = ElevationTokens.Level0`	the tonal elevation of the tooltip.
`shadowElevation: Dp = RichTooltipTokens.ContainerElevation`	the shadow elevation of the tooltip.
`text: @Composable () -> Unit`	the composable that will be used to populate the rich tooltip's text.