Skip to main content

Modal

Struct Modal 

Source
pub struct Modal<C> { /* private fields */ }
Expand description

Modal container widget.

Invariants:

  • content_rect() is always clamped within the given area.
  • Size constraints are applied before positioning and never exceed area.

Failure modes:

  • If the available area is empty or constraints clamp to zero size, the content is not rendered.
  • close_on_backdrop requires hit_id to be set; otherwise backdrop clicks cannot be distinguished from content clicks.

Implementations§

Source§

impl<C> Modal<C>

Source

pub fn new(content: C) -> Self

Create a new modal with content.

Source

pub fn config(self, config: ModalConfig) -> Self

Set modal configuration.

Source

pub fn position(self, position: ModalPosition) -> Self

Set modal position.

Source

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

Set backdrop configuration.

Source

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

Set size constraints.

Source

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

Set close-on-backdrop behavior.

Source

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

Set close-on-escape behavior.

Source

pub fn hit_id(self, id: HitId) -> Self

Set the hit id used for backdrop/content hit regions.

Source

pub fn content_rect(&self, area: Rect) -> Rect

Compute the content rectangle for the given area.

Trait Implementations§

Source§

impl<C: Clone> Clone for Modal<C>

Source§

fn clone(&self) -> Modal<C>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<C: Debug> Debug for Modal<C>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<C: Widget> Widget for Modal<C>

Source§

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

Render the widget into the frame at the given area. Read more
Source§

fn is_essential(&self) -> bool

Whether this widget is essential and should always render. Read more

Auto Trait Implementations§

§

impl<C> Freeze for Modal<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for Modal<C>
where C: RefUnwindSafe,

§

impl<C> Send for Modal<C>
where C: Send,

§

impl<C> Sync for Modal<C>
where C: Sync,

§

impl<C> Unpin for Modal<C>
where C: Unpin,

§

impl<C> UnwindSafe for Modal<C>
where C: 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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