Struct Dialog

pub struct Dialog<Msg: Clone> {
    pub title: Option<String>,
    pub subtitle: Option<String>,
    pub body: Option<Box<Element<Msg>>>,
    pub actions: Vec<Element<Msg>>,
    pub modal: bool,
    pub dismiss_msg: Option<Msg>,
    pub cancel_msg: Option<Msg>,
    pub max_width: f32,
}

A centered confirmation dialog with optional title, subtitle, body and action buttons.

Fields

title: Option<String>

subtitle: Option<String>

body: Option<Box<Element<Msg>>>

User-supplied body element rendered between the subtitle and the action row. Use this for sliders, lists, spinners or any other custom content.

actions: Vec<Element<Msg>>

modal: bool

dismiss_msg: Option<Msg>

Optional message dispatched when the user taps the scrim (strictly outside the card). Always None when Self::modal is true. Construction panics if both are set together.

cancel_msg: Option<Msg>

Optional message dispatched when the user presses Escape while the dialog is on screen. Wire this to the same message your “Cancel” action button uses.

max_width: f32

Implementations

impl<Msg: Clone> Dialog<Msg>

pub fn new() -> Self

Construct a default modal dialog with no title, subtitle, body, or actions. Build it up with the chained setters.

pub fn title(self, t: impl Into<String>) -> Self

Set the dialog title. Wraps across multiple lines if it does not fit on a single one.

pub fn subtitle(self, s: impl Into<String>) -> Self

Set the dialog subtitle. Wraps across multiple lines if it does not fit on a single one.

pub fn body(self, e: impl Into<Element<Msg>>) -> Self

Replace the dialog body with a custom element — slider, progress indicator, list, anything. Rendered between the subtitle and the action row.

pub fn action(self, e: impl Into<Element<Msg>>) -> Self

Append an action element to the right-aligned action row. Typically a Button; any Element is accepted.

pub fn modal(self, on: bool) -> Self

Toggle modality. Default: true (every pointer event outside the card is silently absorbed).

pub fn dismiss_on_scrim(self, msg: Msg) -> Self

Bind a message dispatched when the user taps the scrim (outside the card). Only valid for non-modal dialogs; construction panics if combined with modal( true ).

pub fn cancel(self, msg: Msg) -> Self

Bind a message dispatched when the user presses Escape. Wire the same message your “Cancel” / “Dismiss” action button uses so keyboard and pointer behaviour match.

pub fn max_width(self, w: f32) -> Self

Override the card’s maximum width in logical pixels. Default is 480.0.

Trait Implementations

impl<Msg: Clone> Default for Dialog<Msg>

fn default() -> Self

Returns the “default value” for a type.

impl<Msg: Clone + 'static> From<Dialog<Msg>> for Element<Msg>

fn from(d: Dialog<Msg>) -> Element<Msg>

Converts to this type from the input type.