Struct Modal 

pub struct Modal<'a> { /* private fields */ }

A centered modal dialog.

The open flag drives visibility: when it’s false on entry to Modal::show, nothing is rendered; when the user clicks the backdrop, presses Esc, or clicks the “×” button, it’s flipped to false.

Modal::new("stats", &mut open)
    .heading("Run Summary")
    .show(&ctx, |ui| {
        ui.label("…");
    });

Implementations

impl<'a> Modal<'a>

pub fn new(id: impl Into<Id>, open: &'a mut bool) -> Self

Create a modal keyed by id_salt whose visibility is bound to open.

pub fn heading(self, heading: impl Into<WidgetText>) -> Self

Show a strong heading at the top of the modal, alongside the close button.

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

Show a muted subtitle line under the heading.

pub fn header_icon(self, icon: impl Into<WidgetText>) -> Self

Paint a glyph in a tinted circular halo to the left of the heading. Use any short text — "⚠", "✓", "!", an emoji, or a symbol from the bundled Elegance Symbols font. The halo’s tint comes from [Modal::header_accent] and defaults to [Accent::Sky].

pub fn backdrop_order(self, order: Order) -> Self

Override the Order used for the backdrop of the modal

pub fn content_order(self, order: Order) -> Self

Override the Order used for the content of the modal

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

Override the maximum width of the modal card in points. Default: 440.

pub fn closable(self, closable: bool) -> Self

Whether the user may dismiss the modal at all. When false, the close “×” button is hidden and Esc / backdrop clicks are ignored — regardless of Modal::close_on_backdrop / Modal::close_on_escape.

Use this to force the user to see an in-progress action through (or cancel it via an explicit footer button) — for example, blocking dismissal while a long-running task runs, instead of juggling the open flag with an external “is it running?” guard.

This only removes the user-driven dismissal affordances; the caller is still free to set the bound open flag to false programmatically to close the modal from code. Default: true.

pub fn close_on_backdrop(self, close: bool) -> Self

Whether clicking the dimmed backdrop dismisses the modal. Default: true.

pub fn close_on_escape(self, close: bool) -> Self

Whether pressing Esc dismisses the modal. Default: true.

pub fn alert(self, alert: bool) -> Self

Mark this modal as an alert dialog — a dialog that demands the user’s attention to proceed, such as a destructive confirmation or an unsaved-changes prompt. Screen readers announce alert dialogs more assertively than ordinary dialogs. Default: false.

Under the hood this exposes accesskit::Role::AlertDialog on the modal’s root node instead of the default Role::Dialog.

pub fn footer<F: FnOnce(&mut Ui) + 'a>(self, add_footer: F) -> Self

Add a footer row at the bottom of the modal. The closure runs in a right-to-left layout, so widgets added in source order land rightmost-first — matching the typical “Cancel | Confirm” reading. The footer renders below a horizontal divider and over a slightly recessed fill, separating it visually from the body.

pub fn footer_left<F: FnOnce(&mut Ui) + 'a>(self, add_left: F) -> Self

Add a left-aligned slot to the footer (only rendered when Modal::footer is also set). Useful for an “export before delete” checkbox or a keyboard-shortcut hint that should sit opposite the action buttons.

pub fn show<R>( self, ctx: &Context, add_contents: impl FnOnce(&mut Ui) -> R, ) -> Option<R>

Render the modal. Returns None if the modal was suppressed because the bound open flag was false; otherwise returns Some(R) with the content closure’s return value.

Trait Implementations

impl<'a> Debug for Modal<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.