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

OverlayLoadingDialog

fun OverlayLoadingDialog(show: Boolean, modifier: Modifier = Modifier, text: String? = null, textColor: Color = LoadingDialogDefaults.textColor(), spinnerColor: Color = LoadingDialogDefaults.spinnerColor(), backgroundColor: Color = DialogDefaults.backgroundColor(), enableWindowDim: Boolean = true, onDismissRequest: () -> Unit? = null, onDismissFinished: () -> Unit? = null, renderInRootScaffold: Boolean = true)

A small always-centered loading dialog with a rotating spinner and an optional message, matching the COUI rotating progress dialog (COUIRotatingDialogBuilder).

Parameters

show

Whether the OverlayLoadingDialog is shown.

modifier

The modifier to be applied to the OverlayLoadingDialog.

text

The optional message shown below the spinner.

textColor

The color of the message text.

spinnerColor

The color of the spinner.

backgroundColor

The background color of the loading card.

enableWindowDim

Whether to enable window dimming when the dialog is shown.

onDismissRequest

Will be called when the user tries to dismiss the dialog by clicking outside or pressing the back button. When null (default), the dialog cannot be dismissed by the user.

onDismissFinished

The callback when the OverlayLoadingDialog is completely dismissed.

renderInRootScaffold

Whether to render the dialog in the root (outermost) Scaffold.