RichTooltip

Composable Component

Common

Deprecated Maintained for binary compatibility

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

Common

@Composable
@ExperimentalMaterial3Api
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,
)

Parameters


modifier	the `Modifier` to be applied to the tooltip.
title	An optional title for the tooltip.
action	An optional action for the tooltip.
caretShape	`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	the maximum width for the plain tooltip
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.

Create your own Component Library

Material Components are meant to be used as is and they do not allow customizations. To build your own Jetpack Compose component library use Compose Unstyled