carbon/com.gabrieldrn.carbon.popover.carettip/PopoverCaretTipBox

PopoverCaretTipBox

@Composable
fun PopoverCaretTipBox(isVisible: Boolean, modifier: Modifier = Modifier, alignment: PopoverCaretTipAlignment = PopoverCaretTipAlignment.Center, placement: PopoverCaretTipPlacement = PopoverCaretTipPlacement.Top, popoverMinWidth: Dp = Dp.Unspecified, popoverMaxWidth: Dp = Dp.Unspecified, popoverPopupProperties: PopupProperties = popoverDefaultProperties, onDismissRequest: () -> Unit? = null, popoverContent: @Composable BoxScope.() -> Unit, content: @Composable () -> Unit)

Popover - Caret tip

Composable wrapping a content (generally a ui trigger) to display a Popover with a caret tip when isVisible is true.

A popover with a caret tip helps to show the relationship between the popover and where it was triggered from. A caret tip is typically used when the trigger button does not have a visually defined down state and for icon buttons.

⚠️ Placement limitations

Due to limitations from Compose, the Popover may be misplaced or misaligned if the current UI window is not big enough to fit it. This is especially the case for hand-held devices. Please keep this in mind when using this component.

From Popover documentation

Parameters

isVisible

Whether the popover is visible or not.

modifier

The modifier to be applied to the whole component.

alignment

The alignment of the popover relative to the UI trigger.

placement

The placement of the popover relative to the UI trigger.

popoverMinWidth

Minimum width of the displayed popover.

popoverMaxWidth

Maximum width of the displayed popover.

popoverPopupProperties

PopupProperties for further customization of the underlying popup's behavior.

onDismissRequest

Executes when the user clicks outside of the popup.

popoverContent

The content to be displayed inside the popup.

content

The composable that the popover will anchor to.