README
¶
AlertDialog
Use dialogs to make sure users act on information Two types: basic and full-screen Should be dedicated to completing a single task Can also display information relevant to the task Commonly used to confirm high-risk actions like deleting progress
@Composable
fun AlertDialog(
onDismissRequest: () -> Unit,
confirmButton: @Composable () -> Unit,
modifier: Modifier = Modifier,
dismissButton: (@Composable () -> Unit)? = null,
icon: (@Composable () -> Unit)? = null,
title: (@Composable () -> Unit)? = null,
text: (@Composable () -> Unit)? = null,
shape: Shape = AlertDialogDefaults.shape,
containerColor: Color = AlertDialogDefaults.containerColor,
iconContentColor: Color = AlertDialogDefaults.iconContentColor,
titleContentColor: Color = AlertDialogDefaults.titleContentColor,
textContentColor: Color = AlertDialogDefaults.textContentColor,
tonalElevation: Dp = AlertDialogDefaults.TonalElevation,
properties: DialogProperties = DialogProperties()
): Unit
Documentation
¶
Overview ¶
Package dialog contains Material 3 Dialog components.
Reference: [Dialogs](https://m3.material.io/components/dialogs/overview) Specs: [Dialogs Specs](https://m3.material.io/components/dialogs/specs)
Index ¶
Constants ¶
View Source
const Material3DialogNodeID = "Material3Dialog"
Variables ¶
View Source
var EmptyModifier = modifier.EmptyModifier
Functions ¶
This section is empty.
Types ¶
type Composable ¶
type Composable = api.Composable
func AlertDialog ¶
func AlertDialog( onDismissRequest func(), onConfirm func(), confirmLabel string, options ...DialogOption, ) Composable
AlertDialog creates a Material3 alert dialog.
type DialogButtonsState ¶
type DialogConstructorArgs ¶
type DialogConstructorArgs struct {
ButtonsState *DialogButtonsState
Title string
Text string
ConfirmLabel string
DismissLabel string
Icon wdk.IconWidget
OnConfirm func()
OnDismiss func()
OnDismissRequest func()
}
type DialogOption ¶
type DialogOption func(*DialogOptions)
func WithDismissButton ¶
func WithDismissButton(label string, onDismiss func()) DialogOption
func WithIcon ¶
func WithIcon(icon wdk.IconWidget) DialogOption
func WithModifier ¶
func WithModifier(m Modifier) DialogOption
func WithText ¶
func WithText(text string) DialogOption
func WithTitle ¶
func WithTitle(title string) DialogOption
type DialogOptions ¶
type DialogOptions struct {
Modifier Modifier
Title string
Text string
DismissLabel string
Icon wdk.IconWidget
OnDismiss func()
}
func DefaultDialogOptions ¶
func DefaultDialogOptions() DialogOptions
Source Files
Click to show internal directories.
Click to hide internal directories.