coui-ui/io.github.suqi8.coui.kmp.overlay/OverlayListPopup

OverlayListPopup

fun OverlayListPopup(show: Boolean, popupModifier: Modifier = Modifier, popupPositionProvider: PopupPositionProvider = ListPopupDefaults.DropdownPositionProvider, alignment: PopupPositionProvider.Align = PopupPositionProvider.Align.Start, enableWindowDim: Boolean = false, onDismissRequest: () -> Unit? = null, onDismissFinished: () -> Unit? = null, maxHeight: Dp? = null, minWidth: Dp = ListPopupDefaults.MinWidth, renderInRootScaffold: Boolean = true, preciseClickState: PreciseClickState? = null, content: @Composable () -> Unit)

A popup with a list of items.

Parameters

show

Whether the OverlayListPopup is shown.

popupModifier

The modifier to be applied to the OverlayListPopup.

popupPositionProvider

The PopupPositionProvider of the OverlayListPopup.

alignment

The alignment of the OverlayListPopup.

enableWindowDim

Whether to enable window dimming when the OverlayListPopup is shown. Defaults to false: COUIPopupListWindow calls setBackgroundDrawable(null) and never dims, so a COUI dropdown leaves the content behind it untouched.

onDismissRequest

The callback when the OverlayListPopup is dismissed.

onDismissFinished

The callback when the OverlayListPopup is completely dismissed (after exit animation).

maxHeight

The maximum height of the OverlayListPopup. If null, the height will be calculated automatically.

minWidth

The minimum width of the OverlayListPopup.

renderInRootScaffold

Whether to render the popup in the root (outermost) Scaffold. When true (default), the popup covers the full screen. When false, it renders within the current Scaffold's bounds with position compensation.

preciseClickState

Opens the popup at the last point recorded by io.github.suqi8.coui.kmp.basic.preciseClickAnchor on the anchor instead of centring it on the anchor, matching COUI PreciseClickHelper. Null (default) keeps anchor-centred placement.

content

The Composable content of the OverlayListPopup. You should use the ListPopupColumn in general.