{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

TooltipDefaults

@ExperimentalMaterial3Api
public static class TooltipDefaults


Tooltip defaults that contain default values for both PlainTooltip and RichTooltip

Summary

Public fields

static @NonNull TooltipDefaults

Public methods

final @NonNull CaretProperties

The default CaretProperties for tooltips.

final @NonNull Color

The default Color for a PlainTooltip's container.

final @NonNull Shape

The default Shape for a PlainTooltip's container.

final @NonNull Color

The default Color for the content within the PlainTooltip.

final @NonNull Shape

The default Shape for a RichTooltip's container.

final @NonNull PopupPositionProvider
@Composable
rememberPlainTooltipPositionProvider(
    @NonNull Dp spacingBetweenTooltipAndAnchor
)

PopupPositionProvider that should be used with PlainTooltip.

final @NonNull PopupPositionProvider
@Composable
rememberRichTooltipPositionProvider(
    @NonNull Dp spacingBetweenTooltipAndAnchor
)

PopupPositionProvider that should be used with RichTooltip.

final @NonNull RichTooltipColors

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

final @NonNull RichTooltipColors
@Composable
richTooltipColors(
    @NonNull Color containerColor,
    @NonNull Color contentColor,
    @NonNull Color titleContentColor,
    @NonNull Color actionContentColor
)

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

Public fields

INSTANCE

public static @NonNull TooltipDefaults INSTANCE

Public methods

getCaretProperties

public final @NonNull CaretProperties getCaretProperties()

The default CaretProperties for tooltips.

getPlainTooltipContainerColor

@Composable
public final @NonNull Color getPlainTooltipContainerColor()

The default Color for a PlainTooltip's container.

getPlainTooltipContainerShape

@Composable
public final @NonNull Shape getPlainTooltipContainerShape()

The default Shape for a PlainTooltip's container.

getPlainTooltipContentColor

@Composable
public final @NonNull Color getPlainTooltipContentColor()

The default Color for the content within the PlainTooltip.

getRichTooltipContainerShape

@Composable
public final @NonNull Shape getRichTooltipContainerShape()

The default Shape for a RichTooltip's container.

rememberPlainTooltipPositionProvider

@Composable
public final @NonNull PopupPositionProvider rememberPlainTooltipPositionProvider(
    @NonNull Dp spacingBetweenTooltipAndAnchor
)

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

Parameters
@NonNull Dp spacingBetweenTooltipAndAnchor

the spacing between the tooltip and the anchor content.

rememberRichTooltipPositionProvider

@Composable
public final @NonNull PopupPositionProvider rememberRichTooltipPositionProvider(
    @NonNull Dp spacingBetweenTooltipAndAnchor
)

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

Parameters
@NonNull Dp spacingBetweenTooltipAndAnchor

the spacing between the tooltip and the anchor content.

richTooltipColors

@Composable
public final @NonNull RichTooltipColors richTooltipColors()

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

richTooltipColors

@Composable
public final @NonNull RichTooltipColors richTooltipColors(
    @NonNull Color containerColor,
    @NonNull Color contentColor,
    @NonNull Color titleContentColor,
    @NonNull Color actionContentColor
)

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