Compose Multiplatform Material3/androidx.compose.material3/TooltipDefaults

TooltipDefaults

object TooltipDefaults

Tooltip defaults that contain default values for both PlainTooltip and RichTooltip

Properties

Link copied to clipboard
val caretSize: DpSize

The default DpSize for tooltip carets.

Link copied to clipboard
@get:Composable
val plainTooltipContainerColor: Color

The default Color for a PlainTooltip's container.

Link copied to clipboard
@get:Composable
val plainTooltipContainerShape: Shape

The default Shape for a PlainTooltip's container.

Link copied to clipboard
@get:Composable
val plainTooltipContentColor: Color

The default Color for the content within the PlainTooltip.

Link copied to clipboard
val plainTooltipMaxWidth: Dp

The default maximum width for plain tooltips.

Link copied to clipboard
@get:Composable
val richTooltipContainerShape: Shape

The default Shape for a RichTooltip's container.

Link copied to clipboard
val richTooltipMaxWidth: Dp

The default maximum width for rich tooltips.

Functions

Link copied to clipboard
fun caretShape(): DefaultTooltipCaretShape

The default caret shape used for tooltips and is TooltipDefaults.caretSize dimensions.

fun caretShape(caretSize: DpSize = TooltipDefaults.caretSize): Shape

The caret shape used for tooltips.

Link copied to clipboard
@Composable
fun rememberPlainTooltipPositionProvider(spacingBetweenTooltipAndAnchor: Dp = SpacingBetweenTooltipAndAnchor): PopupPositionProvider

PopupPositionProvider that should be used with PlainTooltip. It correctly positions the tooltip in respect to the anchor content.

Link copied to clipboard
@Composable
fun rememberRichTooltipPositionProvider(spacingBetweenTooltipAndAnchor: Dp = SpacingBetweenTooltipAndAnchor): PopupPositionProvider

PopupPositionProvider that should be used with RichTooltip. It correctly positions the tooltip in respect to the anchor content.

Link copied to clipboard
@Composable
fun rememberTooltipPositionProvider(spacingBetweenTooltipAndAnchor: Dp = SpacingBetweenTooltipAndAnchor): PopupPositionProvider
@Composable
fun rememberTooltipPositionProvider(positioning: TooltipAnchorPosition, spacingBetweenTooltipAndAnchor: Dp = SpacingBetweenTooltipAndAnchor): PopupPositionProvider

PopupPositionProvider that should be used with either RichTooltip or PlainTooltip. It correctly positions the tooltip in respect to the anchor content.

Link copied to clipboard
@Composable
fun richTooltipColors(): RichTooltipColors
@Composable
fun richTooltipColors(containerColor: Color = Color.Unspecified, contentColor: Color = Color.Unspecified, titleContentColor: Color = Color.Unspecified, actionContentColor: Color = Color.Unspecified): RichTooltipColors

Method to create a RichTooltipColors for RichTooltip using RichTooltipTokens to obtain the default colors.