Skip to main content

Modal

Struct Modal 

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

A modal dialog that wraps content in a bordered box with an optional title.

The modal itself does not handle dismissal — that is the responsibility of the caller (typically TUI intercepting Esc).

§Example

use photon_ui::components::{
    Modal,
    Text,
};

let modal = Modal::new(Box::new(Text::new("Are you sure?", 0, 0))).title("Confirm");

Implementations§

Source§

impl Modal

Source

pub fn new(content: Box<dyn Component>) -> Self

Create a new modal wrapping the given content.

Source

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

Set the title rendered in the top border.

Source

pub fn border(self, border: Border) -> Self

Set the border style (default is rounded).

Source

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

Set the desired width of the modal content area.

Trait Implementations§

Source§

impl Component for Modal

Source§

fn render(&self, width: u16) -> Result<Rendered, RenderError>

Render this component into lines of text at the given width. Read more
Source§

fn render_rect(&self, rect: Rect) -> Result<Rendered, RenderError>

Render this component into a specific rectangular area. Read more
Source§

fn handle_input(&mut self, event: &Event) -> InputResult

Handle an input event (key press, resize, mouse, etc.). Read more
Source§

fn as_focusable(&self) -> Option<&dyn Focusable>

Cast this component to a Focusable reference, if supported.
Source§

fn as_focusable_mut(&mut self) -> Option<&mut dyn Focusable>

Cast this component to a mutable Focusable reference, if supported.
Source§

fn wants_key_release(&self) -> bool

Returns true if this component wants to receive KeyEventKind::Release events in addition to Press / Repeat. Read more
Source§

impl Focusable for Modal

Source§

fn focused(&self) -> bool

Returns true when this component currently has focus.
Source§

fn set_focused(&mut self, focused: bool)

Set or clear the focused state.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Modal

§

impl !Send for Modal

§

impl !Sync for Modal

§

impl !UnwindSafe for Modal

§

impl Freeze for Modal

§

impl Unpin for Modal

§

impl UnsafeUnpin for Modal

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, 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.