coui-ui/io.github.suqi8.coui.kmp.window/WindowListPopup

WindowListPopup

fun WindowListPopup(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, preciseClickState: PreciseClickState? = null, content: @Composable () -> Unit)

A popup with a list of items, rendered at window level without Scaffold.

Use LocalDismissState inside content to request dismissal from inner composables.

Parameters

show

Whether the WindowListPopup is shown.

popupModifier

The modifier to be applied to the WindowListPopup.

popupPositionProvider

The PopupPositionProvider of the WindowListPopup.

alignment

The alignment of the WindowListPopup.

enableWindowDim

Whether to enable window dimming when the WindowListPopup 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 WindowListPopup is dismissed.

onDismissFinished

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

maxHeight

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

minWidth

The minimum width of the WindowListPopup.

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 WindowListPopup. You should use the ListPopupColumn in general.