BasicTooltipBox

Component in Compose Foundation

BasicTooltipBox that wraps a composable with a tooltip.

Tooltip that provides a descriptive message for an anchor. It can be used to call the users attention to the anchor.

Last updated: 2024-10-22 13:47

Installation

dependencies {
   implementation("androidx.compose.foundation:foundation:1.8.0-alpha04")
}

Overloads

@Composable
@ExperimentalFoundationApi
fun BasicTooltipBox(
    positionProvider: PopupPositionProvider,
    tooltip: @Composable () -> Unit,
    state: BasicTooltipState,
    modifier: Modifier = Modifier,
    focusable: Boolean = true,
    enableUserInput: Boolean = true,
    content: @Composable () -> Unit
)

Parameters

name	description
positionProvider	[PopupPositionProvider] that will be used to place the tooltip relative to the anchor content.
tooltip	the composable that will be used to populate the tooltip's content.
state	handles the state of the tooltip's visibility.
modifier	the [Modifier] to be applied to this BasicTooltipBox.
focusable	[Boolean] that determines if the tooltip is focusable. When true, the tooltip will consume touch events while it's shown and will have accessibility focus move to the first element of the component. When false, the tooltip won't consume touch events while it's shown but assistive-tech users will need to swipe or drag to get to the first element of the component.
enableUserInput	[Boolean] which determines if this BasicTooltipBox will handle long press and mouse hover to trigger the tooltip through the state provided.
content	the composable that the tooltip will anchor to.

@Composable
@ExperimentalFoundationApi
fun BasicTooltipBox(
    positionProvider: PopupPositionProvider,
    tooltip: @Composable () -> Unit,
    state: BasicTooltipState,
    modifier: Modifier,
    focusable: Boolean,
    enableUserInput: Boolean,
    content: @Composable () -> Unit
)

Parameters

name	description
positionProvider	[PopupPositionProvider] that will be used to place the tooltip relative to the anchor content.
tooltip	the composable that will be used to populate the tooltip's content.
state	handles the state of the tooltip's visibility.
modifier	the [Modifier] to be applied to this BasicTooltipBox.
focusable	[Boolean] that determines if the tooltip is focusable. When true, the tooltip will consume touch events while it's shown and will have accessibility focus move to the first element of the component. When false, the tooltip won't consume touch events while it's shown but assistive-tech users will need to swipe or drag to get to the first element of the component.
enableUserInput	[Boolean] which determines if this BasicTooltipBox will handle long press and mouse hover to trigger the tooltip through the state provided.
content	the composable that the tooltip will anchor to.