Struct MaterialDialog 

pub struct MaterialDialog { /* private fields */ }

An M3 dialog. Without MaterialDialog::modal it renders its container in place (a specimen); with it, it is a modal overlay over the window.

Implementations

impl MaterialDialog

pub fn new(id: impl Into<ElementId>) -> Self

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

The hero icon above the headline; the headline then centers.

pub fn headline(self, headline: impl Into<SharedString>) -> Self

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

A body-medium line 16dp under the headline (md3.io).

pub fn label(self, label: impl Into<SharedString>) -> Self

The modal dialog’s accessible name when it differs from (or there is no) headline.

pub fn supporting_text(self, text: impl Into<SharedString>) -> Self

pub fn content(self, content: impl IntoElement) -> Self

Content under the text, full width (e.g. a list of items).

pub fn action(self, action: impl IntoElement) -> Self

An action button; actions sit at the trailing edge in call order.

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

An outline-variant divider between the content and the actions.

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

Outline-variant dividers above and below the body (supporting text and content), for a body that scrolls (md3.io’s Dividers).

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

The basic dialog’s width in dp, clamped to M3’s 280–560dp.

pub fn size(self, size: DialogSize) -> Self

The dialog’s size; DialogSize::Small uses Self::width.

pub fn animation(self, animation: DialogAnimation) -> Self

pub fn action_alignment(self, alignment: DialogActionAlignment) -> Self

pub fn close_button(self, label: impl Into<SharedString>) -> Self

A close button named label at the header’s trailing edge; it calls on_dismiss. A full-screen dialog shows it at its leading edge.

pub fn full_screen( self, close_label: impl Into<SharedString>, confirm: Option<AnyElement>, ) -> Self

Make this a full-screen dialog. close_label names its close button; confirm is the header’s action (e.g. a text button).

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

Present the dialog modally over the window while open.

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

Present the modal dialog over its positioned parent’s bounds instead of the whole window.

pub fn dismiss_on_scrim(self, dismiss: bool) -> Self

Whether pressing the scrim dismisses the dialog (default true).

pub fn dismiss_on_escape(self, dismiss: bool) -> Self

Whether Escape dismisses the dialog (default true).

pub fn on_dismiss(self, f: impl Fn(&mut Window, &mut App) + 'static) -> Self

Called when the person dismisses the dialog: Escape, the scrim, or a close button. The caller closes it.

Trait Implementations

impl IntoElement for MaterialDialog

type Element = ViewElement<MaterialDialog>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements [Element].

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed [AnyElement].

impl RenderOnce for MaterialDialog

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to [Render::render()] method which takes a mutable reference.