core/com.michaelflisar.composedialogs.core

Package-level declarations

Types

a dialog state holding the current showing state and some additional state DialogInteractionSource of the dialog

class DialogButton(val text: String = "", val contentColor: Color = Color.Unspecified, val containerColor: Color = Color.Unspecified, val shape: Shape? = null)

a dialog buttons

DialogButtons

class DialogButtons

see DialogDefaults.buttons and DialogDefaults.buttonsDisabled

DialogButtonType

enum DialogButtonType : Enum<DialogButtonType>

an enum for the different dialog button types

DialogDefaults

object DialogDefaults

DialogEvent

sealed class DialogEvent

the sealed event for all dialog events (button click and dismissal)

DialogEventType

enum DialogEventType : Enum<DialogEventType>

an enum for the different dialog event types

DialogInteractionSource

class DialogInteractionSource

an interaction source for button states and option state

DialogOptions

class DialogOptions

DialogSpacing

class DialogSpacing

DialogState

class DialogState<T> : BaseDialogState

a dialog state holding the current state and the some additional state DialogInteractionSource of the dialog

DialogStateNoData

class DialogStateNoData : BaseDialogState

convenience type alias for no data dialogs (internal state is Unit, but the overload does not require a data parameter)

DialogStyleDesktopOtions

data class DialogStyleDesktopOtions(val dialogTitle: String, val position: WindowPosition, val width: Dp, val height: Dp)

DialogUtil

object DialogUtil

StyleOptions

class StyleOptions(val iconMode: StyleOptions.IconMode = IconMode.CenterTop)

Properties

DispatcherIO

actual val DispatcherIO: CoroutineDispatcher

expect val DispatcherIO: CoroutineDispatcher

actual val DispatcherIO: CoroutineDispatcher

Functions

defaultDialogStyle

@Composable

actual fun DialogDefaults.defaultDialogStyle(): ComposeDialogStyle

@Composable

expect fun DialogDefaults.defaultDialogStyle(): ComposeDialogStyle

@Composable

actual fun DialogDefaults.defaultDialogStyle(): ComposeDialogStyle

@Composable

actual fun DialogDefaults.defaultDialogStyle(): ComposeDialogStyle

@Composable

actual fun DialogDefaults.defaultDialogStyle(): ComposeDialogStyle

Dialog

@Composable

fun Dialog(state: BaseDialogState, title: @Composable () -> Unit? = null, icon: @Composable () -> Unit? = null, style: ComposeDialogStyle = DialogDefaults.defaultDialogStyle(), buttons: DialogButtons = DialogDefaults.buttons(), options: DialogOptions = DialogDefaults.options(), onEvent: (event: DialogEvent) -> Unit = {}, content: @Composable () -> Unit)

Shows a dialog containing some arbitrary content

DialogContentScrollableColumn

@Composable

actual fun DialogContentScrollableColumn(modifier: Modifier, content: ColumnScope.() -> Unit)

@Composable

expect fun DialogContentScrollableColumn(modifier: Modifier = Modifier, content: @Composable ColumnScope.() -> Unit)

@Composable

actual fun DialogContentScrollableColumn(modifier: Modifier, content: ColumnScope.() -> Unit)

@Composable

actual fun DialogContentScrollableColumn(modifier: Modifier, content: ColumnScope.() -> Unit)

@Composable

actual fun DialogContentScrollableColumn(modifier: Modifier, content: ColumnScope.() -> Unit)

DialogContentScrollableLazyColumn

@Composable

actual fun DialogContentScrollableLazyColumn(modifier: Modifier, state: LazyListState, contentPadding: PaddingValues, reverseLayout: Boolean, verticalArrangement: Arrangement.Vertical, horizontalAlignment: Alignment.Horizontal, flingBehavior: FlingBehavior, userScrollEnabled: Boolean, content: LazyListScope.() -> Unit)

@Composable

expect fun DialogContentScrollableLazyColumn(modifier: Modifier = Modifier, state: LazyListState = rememberLazyListState(), contentPadding: PaddingValues = PaddingValues(0.dp), reverseLayout: Boolean = false, verticalArrangement: Arrangement.Vertical = if (!reverseLayout) Arrangement.Top else Arrangement.Bottom, horizontalAlignment: Alignment.Horizontal = Alignment.Start, flingBehavior: FlingBehavior = ScrollableDefaults.flingBehavior(), userScrollEnabled: Boolean = true, content: LazyListScope.() -> Unit)

@Composable

dialogStateOf

fun <T : Any> dialogStateOf(data: T?, buttonPositiveEnabled: Boolean = true, buttonNegativeEnabled: Boolean = true, dismissAllowed: Boolean = true, swipeAllowed: Boolean = true, onStateChanged: (T?) -> Unit? = null): DialogState<T>

fun dialogStateOf(visible: Boolean = false, buttonPositiveEnabled: Boolean = true, buttonNegativeEnabled: Boolean = true, dismissAllowed: Boolean = true, swipeAllowed: Boolean = true, onStateChanged: (visible: Boolean) -> Unit? = null): DialogStateNoData

creates a DialogState object for usage outside of Compose (e.g. ViewModel)

isLandscape

@Composable

actual fun isLandscape(): Boolean

@Composable

expect fun isLandscape(): Boolean

@Composable

actual fun isLandscape(): Boolean

@Composable

actual fun isLandscape(): Boolean

@Composable

actual fun isLandscape(): Boolean

rememberDialogState

@Composable

fun rememberDialogState(visible: Boolean = false, buttonPositiveEnabled: Boolean = true, buttonNegativeEnabled: Boolean = true, dismissAllowed: Boolean = true, swipeAllowed: Boolean = true): DialogStateNoData

@Composable

fun <T : Any> rememberDialogState(data: T?, saver: Saver<MutableState<T?>, out Any> = autoSaver(), buttonPositiveEnabled: Boolean = true, buttonNegativeEnabled: Boolean = true, dismissAllowed: Boolean = true, swipeAllowed: Boolean = true): DialogState<T>

returns a DialogState object holding all necessary states for the dialog

stringOk

@Composable

actual fun stringOk(): String

@Composable

expect fun stringOk(): String

@Composable

actual fun stringOk(): String

@Composable

actual fun stringOk(): String

@Composable

actual fun stringOk(): String

styleWindowsDialog

@Composable

fun DialogDefaults.styleWindowsDialog(dialogTitle: String, position: WindowPosition = WindowPosition(Alignment.Center), width: Dp = 800.dp, height: Dp = 600.dp, iconColor: Color = DialogStyleDefaults.iconColor, titleColor: Color = DialogStyleDefaults.titleColor, contentColor: Color = DialogStyleDefaults.contentColor): ComposeDialogStyle