dialog

package
v0.1.44 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 7, 2026 License: MIT Imports: 7 Imported by: 0

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

This section is empty.

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 Composer

type Composer = api.Composer

type DialogButtonsState

type DialogButtonsState struct {
	ConfirmButton *button.Button
	CancelButton  *button.Button
}

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 ui.Modifier) DialogOption

func WithText

func WithText(text string) DialogOption

func WithTitle

func WithTitle(title string) DialogOption

type DialogOptions

type DialogOptions struct {
	Modifier     ui.Modifier
	Title        string
	Text         string
	DismissLabel string
	Icon         wdk.IconWidget
	OnDismiss    func()
}

func DefaultDialogOptions

func DefaultDialogOptions() DialogOptions

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL