pub struct WidgetModalEntry<W> { /* private fields */ }Expand description
A simple modal entry that wraps any Widget.
Implementations§
Source§impl<W> WidgetModalEntry<W>
impl<W> WidgetModalEntry<W>
Sourcepub fn size(self, size: ModalSizeConstraints) -> Self
pub fn size(self, size: ModalSizeConstraints) -> Self
Set size constraints.
Sourcepub fn backdrop(self, backdrop: BackdropConfig) -> Self
pub fn backdrop(self, backdrop: BackdropConfig) -> Self
Set backdrop configuration.
Sourcepub fn close_on_escape(self, close: bool) -> Self
pub fn close_on_escape(self, close: bool) -> Self
Set whether Escape closes the modal.
Sourcepub fn close_on_backdrop(self, close: bool) -> Self
pub fn close_on_backdrop(self, close: bool) -> Self
Set whether backdrop click closes the modal.
Sourcepub fn with_aria_modal(self, aria_modal: bool) -> Self
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.
Sourcepub fn with_focusable_ids(self, ids: Vec<ModalFocusId>) -> Self
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:
- Create a focus group constraining Tab navigation
- Auto-focus the first focusable widget when modal opens
- Restore focus to the previous element when modal closes
Trait Implementations§
Source§impl<W: Widget + Send> StackModal for WidgetModalEntry<W>
impl<W: Widget + Send> StackModal for WidgetModalEntry<W>
Source§fn render_content(&self, area: Rect, frame: &mut Frame<'_>)
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>
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
fn size_constraints(&self) -> ModalSizeConstraints
Get the modal’s size constraints.
Source§fn backdrop_config(&self) -> BackdropConfig
fn backdrop_config(&self) -> BackdropConfig
Get the backdrop configuration.
Source§fn close_on_escape(&self) -> bool
fn close_on_escape(&self) -> bool
Whether this modal can be closed by pressing Escape.
Source§fn close_on_backdrop(&self) -> bool
fn close_on_backdrop(&self) -> bool
Whether this modal can be closed by clicking the backdrop.
Source§fn aria_modal(&self) -> bool
fn aria_modal(&self) -> bool
Whether this modal is an ARIA modal (accessibility semantic). Read more
Source§fn focusable_ids(&self) -> Option<Vec<ModalFocusId>>
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> UnsafeUnpin for WidgetModalEntry<W>where
W: UnsafeUnpin,
impl<W> UnwindSafe for WidgetModalEntry<W>where
W: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more