---
title: "RichTooltip"
description: "Rich text tooltip that allows the user to pass in a title, text, and action. Tooltips are used to
provide a descriptive message."
type: "component"
---

<div class='type'>Composable Component</div>



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

<a id='references'></a>

<div class='sourceset sourceset-common'>Common</div>


```kotlin
@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,
)
```


#### 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. |