State of Compose 2023 results are in! Click here to learn more

← Back to Foundation

BasicTooltipBox

Component
in
Foundation
. Since 1.6.0-alpha07

Overview

Code Examples

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.

@param positionProvider PopupPositionProvider that will be used to place the tooltip relative to the anchor content. @param tooltip the composable that will be used to populate the tooltip's content. @param state handles the state of the tooltip's visibility. @param modifier the Modifier to be applied to this BasicTooltipBox. @param 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. @param enableUserInput Boolean which determines if this BasicTooltipBox will handle long press and mouse hover to trigger the tooltip through the state provided. @param content the composable that the tooltip will anchor to.

Overloads

BasicTooltipBox

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

Parameters

NameDescription
positionProviderPopupPositionProvider that will be used to place the tooltip relative to the anchor content.
tooltipthe composable that will be used to populate the tooltip's content.
statehandles the state of the tooltip's visibility.
modifierthe Modifier to be applied to this BasicTooltipBox.
focusableBoolean 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.
enableUserInputBoolean which determines if this BasicTooltipBox will handle long press and mouse hover to trigger the tooltip through the state provided.
contentthe composable that the tooltip will anchor to