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_salt: impl Hash, 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 max_width(self, max_width: f32) -> Self

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

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 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.