Android Studio Sign in

TooltipDefaults


Tooltip defaults that contain default values for both PlainTooltip and RichTooltip

Summary

Public functions

DefaultTooltipCaretShape

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

Cmn
Shape
caretShape(caretSize: DpSize)

The caret shape used for tooltips.

Cmn
PopupPositionProvider
@Composable
rememberPlainTooltipPositionProvider(
    spacingBetweenTooltipAndAnchor: Dp
)

This function is deprecated. Deprecated in favor of rememberTooltipPositionProvider API.

Cmn
PopupPositionProvider
@Composable
rememberRichTooltipPositionProvider(spacingBetweenTooltipAndAnchor: Dp)

This function is deprecated. Deprecated in favor of rememberTooltipPositionProvider API.

Cmn
PopupPositionProvider
@Composable
rememberTooltipPositionProvider(spacingBetweenTooltipAndAnchor: Dp)

This function is deprecated. Deprecated in favor of rememberTooltipPositionProvider API that takes a preferred positioning.

Cmn
PopupPositionProvider
@Composable
rememberTooltipPositionProvider(
    positioning: TooltipAnchorPosition,
    spacingBetweenTooltipAndAnchor: Dp
)

PopupPositionProvider that should be used with either RichTooltip or PlainTooltip.

Cmn
RichTooltipColors

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

Cmn
RichTooltipColors
@Composable
richTooltipColors(
    containerColor: Color,
    contentColor: Color,
    titleContentColor: Color,
    actionContentColor: Color
)

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

Cmn

Public properties

DpSize

The default DpSize for tooltip carets.

Cmn
Color

The default Color for a PlainTooltip's container.

Cmn
Shape

The default Shape for a PlainTooltip's container.

Cmn
Color

The default Color for the content within the PlainTooltip.

Cmn
Dp

The default maximum width for plain tooltips.

Cmn
Shape

The default Shape for a RichTooltip's container.

Cmn
Dp

The default maximum width for rich tooltips.

Cmn

Public functions

caretShape

fun caretShape(): DefaultTooltipCaretShape

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

caretShape

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

The caret shape used for tooltips.

Parameters
caretSize: DpSize = TooltipDefaults.caretSize

DpSize used to draw the caret shape

rememberPlainTooltipPositionProvider

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

Parameters
spacingBetweenTooltipAndAnchor: Dp = SpacingBetweenTooltipAndAnchor

the spacing between the tooltip and the anchor content.

rememberRichTooltipPositionProvider

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

Parameters
spacingBetweenTooltipAndAnchor: Dp = SpacingBetweenTooltipAndAnchor

the spacing between the tooltip and the anchor content.

rememberTooltipPositionProvider

@Composable
fun rememberTooltipPositionProvider(
    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.

Parameters
spacingBetweenTooltipAndAnchor: Dp = SpacingBetweenTooltipAndAnchor

the spacing between the tooltip and the anchor content.

rememberTooltipPositionProvider

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

Parameters
positioning: TooltipAnchorPosition

TooltipAnchorPosition that determines where the tooltip is placed relative to the anchor.

spacingBetweenTooltipAndAnchor: Dp = SpacingBetweenTooltipAndAnchor

the spacing between the tooltip and the anchor content.

richTooltipColors

@Composable
fun richTooltipColors(): RichTooltipColors

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

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.

Public properties

caretSize

val caretSizeDpSize

The default DpSize for tooltip carets.

plainTooltipContainerColor

val plainTooltipContainerColorColor

The default Color for a PlainTooltip's container.

plainTooltipContainerShape

val plainTooltipContainerShapeShape

The default Shape for a PlainTooltip's container.

plainTooltipContentColor

val plainTooltipContentColorColor

The default Color for the content within the PlainTooltip.

plainTooltipMaxWidth

val plainTooltipMaxWidthDp

The default maximum width for plain tooltips.

richTooltipContainerShape

val richTooltipContainerShapeShape

The default Shape for a RichTooltip's container.

richTooltipMaxWidth

val richTooltipMaxWidthDp

The default maximum width for rich tooltips.

Morty Proxy This is a proxified and sanitized view of the page, visit original site.