Skip to main content

WidgetModalEntry

Struct WidgetModalEntry 

Source
pub struct WidgetModalEntry<W> { /* private fields */ }
Expand description

A simple modal entry that wraps any Widget.

Implementations§

Source§

impl<W> WidgetModalEntry<W>

Source

pub fn new(widget: W) -> Self

Create a new modal entry with a widget.

Source

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

Set size constraints.

Source

pub fn backdrop(self, backdrop: BackdropConfig) -> Self

Set backdrop configuration.

Source

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

Set whether Escape closes the modal.

Source

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

Set whether backdrop click closes the modal.

Source

pub fn with_aria_modal(self, aria_modal: bool) -> Self

Set whether this modal is an ARIA modal.

ARIA modals trap focus and announce semantics to screen readers. Default is true for accessibility compliance.

Source

pub fn with_focusable_ids(self, ids: Vec<ModalFocusId>) -> Self

Set the focusable widget IDs for focus trap integration.

When provided, these IDs will be used to:

  1. Create a focus group constraining Tab navigation
  2. Auto-focus the first focusable widget when modal opens
  3. Restore focus to the previous element when modal closes

Trait Implementations§

Source§

impl<W: Widget + Send> StackModal for WidgetModalEntry<W>

Source§

fn render_content(&self, area: Rect, frame: &mut Frame<'_>)

Render the modal content at the given area.
Source§

fn handle_event( &mut self, event: &Event, _hit_id: HitId, ) -> Option<ModalResultData>

Handle an event, returning true if the modal should close.
Source§

fn size_constraints(&self) -> ModalSizeConstraints

Get the modal’s size constraints.
Source§

fn backdrop_config(&self) -> BackdropConfig

Get the backdrop configuration.
Source§

fn close_on_escape(&self) -> bool

Whether this modal can be closed by pressing Escape.
Source§

fn close_on_backdrop(&self) -> bool

Whether this modal can be closed by clicking the backdrop.
Source§

fn aria_modal(&self) -> bool

Whether this modal is an ARIA modal (accessibility semantic). Read more
Source§

fn focusable_ids(&self) -> Option<Vec<ModalFocusId>>

Get the IDs of focusable widgets within this modal. Read more

Auto Trait Implementations§

§

impl<W> Freeze for WidgetModalEntry<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for WidgetModalEntry<W>
where W: RefUnwindSafe,

§

impl<W> Send for WidgetModalEntry<W>
where W: Send,

§

impl<W> Sync for WidgetModalEntry<W>
where W: Sync,

§

impl<W> Unpin for WidgetModalEntry<W>
where W: Unpin,

§

impl<W> UnwindSafe for WidgetModalEntry<W>
where W: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more