PlainTooltip

Composable Component

Plain tooltip that provides a descriptive message.

Common
@Composable
fun TooltipScope.PlainTooltip(
    modifier: Modifier = Modifier,
    caretShape: (Shape)? = null,
    maxWidth: Dp = TooltipDefaults.plainTooltipMaxWidth,
    shape: Shape = TooltipDefaults.plainTooltipContainerShape,
    contentColor: Color = TooltipDefaults.plainTooltipContentColor,
    containerColor: Color = TooltipDefaults.plainTooltipContainerColor,
    tonalElevation: Dp = 0.dp,
    shadowElevation: Dp = 0.dp,
    content: @Composable () -> Unit,
)

Parameters

modifier the Modifier to be applied to 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.
contentColor Color that will be applied to the tooltip's content.
containerColor Color that will be applied to the tooltip's container.
tonalElevation the tonal elevation of the tooltip.
shadowElevation the shadow elevation of the tooltip.
content the composable that will be used to populate the tooltip's content.