Struct Dialog 

pub struct Dialog<'a, Message> { /* private fields */ }

Available on crate feature dialog only.

A dialog builder. Convert it into an Element to render.

Implementations

impl<'a, Message> Dialog<'a, Message>

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

pub fn title(self, title: impl IntoFragment<'a>) -> Self

pub fn description(self, description: impl IntoFragment<'a>) -> Self

A line of muted text under the title.

pub fn body(self, body: impl Into<Element<'a, Message>>) -> Self

Content between the header and the footer, such as a form.

pub fn action(self, action: impl Into<Element<'a, Message>>) -> Self

Adds a button or other element to the footer, which lines them up on the right. Add the main action last.

pub fn on_dismiss(self, message: Message) -> Self

The message emitted when Escape, a click on the scrim or the close button dismisses the dialog. Without it, only the footer actions can close the dialog and the close button renders disabled.

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

Whether Escape dismisses the dialog. Defaults to true.

pub fn on_confirm(self, message: Message) -> Self

The message Action::Confirm (Enter) emits, usually the same as the main footer action. Without it Enter does nothing. A field inside the dialog that submits on Enter keeps the key.

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

Whether a click on the scrim dismisses the dialog. Defaults to true; turn it off for confirmations that need an explicit answer.

pub fn close_button(self, show: bool) -> Self

Whether to show a close button in the top right corner. Defaults to true.

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

Sets the maximum width from a Size.

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

Sets the maximum width in logical pixels.

pub fn id(self, id: impl Into<Id>) -> Self

Sets the surface’s widget id, which scopes focus. Give nested dialogs different ids.

pub fn keymap(self, keymap: Keymap<Action>) -> Self

Replaces the default shortcuts.

pub fn pass_through(self, chords: impl IntoIterator<Item = Chord>) -> Self

Chords the open dialog lets through to the app, such as the shortcut that toggles it. Every other key press stops at the dialog.

pub fn is_open(&self) -> bool

Trait Implementations

impl<Message> Debug for Dialog<'_, Message>

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

Formats the value using the given formatter.

impl<'a, Message: Clone + 'a> From<AlertDialog<'a, Message>> for Dialog<'a, Message>

fn from(alert: AlertDialog<'a, Message>) -> Self

Converts to this type from the input type.

impl<'a, Message: Clone + 'a> From<Dialog<'a, Message>> for Element<'a, Message>

fn from(dialog: Dialog<'a, Message>) -> Self

Converts to this type from the input type.