Struct Modal 

pub struct Modal { /* private fields */ }

A modal dialog widget

Implementations

impl Modal

pub fn new() -> Self

Create a new modal dialog

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

Set modal title

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

Set modal content

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

Add a line to content

pub fn buttons(self, buttons: Vec<ModalButton>) -> Self

Set buttons

pub fn ok(self) -> Self

Add OK button

pub fn cancel(self) -> Self

Add Cancel button

pub fn ok_cancel(self) -> Self

Add OK and Cancel buttons

pub fn yes_no(self) -> Self

Add Yes and No buttons

pub fn yes_no_cancel(self) -> Self

Add Yes, No, and Cancel buttons

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

Set modal width

pub fn height(self, height: u16) -> Self

Set modal height (None = auto)

pub fn body(self, widget: impl View + 'static) -> Self

Set a child widget as body content

When a body widget is set, it takes precedence over text content. The widget will be rendered inside the modal’s content area.

Example

use revue::prelude::*;

let modal = Modal::new()
    .title("User Form")
    .body(
        vstack()
            .gap(1)
            .child(Input::new().placeholder("Name"))
            .child(Input::new().placeholder("Email"))
    )
    .ok_cancel();

pub fn title_fg(self, color: Color) -> Self

Set title color

pub fn border_fg(self, color: Color) -> Self

Set border color

pub fn show(&mut self)

Show the modal

pub fn show_with_focus_trap( &mut self, fm: &mut FocusManager, container_id: u64, button_ids: &[u64], )

Show the modal and activate focus trapping

Traps keyboard focus within the modal’s buttons so Tab/Shift+Tab only cycles between modal buttons and doesn’t escape to background widgets.

Arguments

• fm - The focus manager to trap focus in
• container_id - Unique ID for this modal’s focus trap container
• button_ids - Widget IDs for each button (must match button count)

pub fn hide(&mut self)

Hide the modal

pub fn hide_with_focus_restore(&mut self, fm: &mut FocusManager)

Hide the modal and release focus trapping

Releases the focus trap and restores focus to the previously focused widget.

pub fn has_focus_trap(&self) -> bool

Check if this modal has an active focus trap

pub fn toggle(&mut self)

Toggle visibility

pub fn is_visible(&self) -> bool

Check if modal is visible

pub fn selected_button(&self) -> usize

Get selected button index

pub fn next_button(&mut self)

Select next button

pub fn prev_button(&mut self)

Select previous button

pub fn handle_key(&mut self, key: &Key) -> Option<usize>

Handle key input, returns Some(button_index) if button confirmed

pub fn handle_key_with_focus( &mut self, key: &Key, fm: &mut FocusManager, ) -> Option<usize>

Handle key input with focus manager integration

Like handle_key, but also releases the focus trap on Escape or when a button is confirmed.

pub fn alert(title: impl Into<String>, message: impl Into<String>) -> Self

Create alert dialog

pub fn confirm(title: impl Into<String>, message: impl Into<String>) -> Self

Create confirmation dialog

pub fn error(message: impl Into<String>) -> Self

Create error dialog

pub fn warning(message: impl Into<String>) -> Self

Create warning dialog

impl Modal

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

Set element ID for CSS selector (#id)

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

Add a CSS class

pub fn classes<I, S>(self, classes: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add multiple CSS classes

Trait Implementations

impl Default for Modal

fn default() -> Self

Returns the “default value” for a type.

impl StyledView for Modal

fn set_id(&mut self, id: impl Into<String>)

Set element ID

fn add_class(&mut self, class: impl Into<String>)

Add a CSS class

fn remove_class(&mut self, class: &str)

Remove a CSS class

fn toggle_class(&mut self, class: &str)

Toggle a CSS class

fn has_class(&self, class: &str) -> bool

Check if has class

impl View for Modal

fn render(&self, ctx: &mut RenderContext<'_>)

Render the view to the given context

fn id(&self) -> Option<&str>

Get element ID (for CSS #id selectors)

fn classes(&self) -> &[String]

Get CSS classes (for CSS .class selectors)

fn meta(&self) -> WidgetMeta

Get widget metadata for DOM

fn widget_type(&self) -> &'static str

Get widget type name (for CSS type selectors)

fn children(&self) -> &[Box<dyn View>]

Get child views (for container widgets)

fn needs_render(&self) -> bool

Check if this widget needs re-rendering