Dialog

Struct Dialog 

Source
pub struct Dialog<'a> { /* private fields */ }
Expand description

A dialog/modal widget that overlays content

Dialogs are centered modals that display a message and buttons. They support different visual styles (info, success, warning, error, confirm) and can handle mouse clicks on buttons.

Implementations§

Source§

impl<'a> Dialog<'a>

Source

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

Source§

impl<'a> Dialog<'a>

Source

pub fn button_selected_style(self, style: Style) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn button_style(self, style: Style) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn buttons(self, buttons: Vec<&'a str>) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn confirm(title: &'a str, message: &'a str) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn dialog_type(self, dialog_type: DialogType) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn error(title: &'a str, message: &'a str) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn footer(self, footer: &'a str) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn footer_style(self, style: Style) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn height_percent(self, height_percent: f32) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn info(title: &'a str, message: &'a str) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn new(title: &'a str, message: &'a str) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn overlay(self, overlay: bool) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn overlay_style(self, style: Style) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn style(self, style: Style) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn success(title: &'a str, message: &'a str) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn title_inside(self, title_inside: bool) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn warning(title: &'a str, message: &'a str) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn width_percent(self, width_percent: f32) -> Self

Source§

impl<'a> Dialog<'a>

Source

pub fn get_border_color(&self) -> Color

Returns the border color for the dialog based on its type.

If theme colors have been applied via with_theme, those colors are used. Otherwise, falls back to default colors for each dialog type.

§Returns

The color to use for the dialog border.

Source§

impl<'a> Dialog<'a>

Source§

impl<'a> Dialog<'a>

Source§

impl<'a> Dialog<'a>

Source

pub fn handle_click(&self, column: u16, row: u16) -> Option<usize>

Source§

impl<'a> Dialog<'a>

Source

pub fn select_next_button(&mut self)

Source§

impl<'a> Dialog<'a>

Source§

impl<'a> Dialog<'a>

Source

pub fn with_theme(self, theme: &AppTheme) -> Self

Applies theme colors to the dialog.

This method configures the dialog’s border colors for each dialog type, as well as button styles, based on the provided theme.

§Theme Mapping
  • Info dialogs use theme.info
  • Success dialogs use theme.success
  • Warning dialogs use theme.warning
  • Error dialogs use theme.error
  • Confirm dialogs use theme.primary
  • Dialog background uses theme.background_panel
  • Dialog text uses theme.text
  • Selected button uses theme.selected_text on theme.primary background
§Arguments
  • theme - The application theme to apply
§Returns

Self with theme colors applied for method chaining.

§Example
use ratatui_toolkit::{Dialog, DialogType, AppTheme};

let theme = AppTheme::default();
let dialog = Dialog::new("Info", "This is a message")
    .dialog_type(DialogType::Info)
    .with_theme(&theme);

Auto Trait Implementations§

§

impl<'a> Freeze for Dialog<'a>

§

impl<'a> RefUnwindSafe for Dialog<'a>

§

impl<'a> Send for Dialog<'a>

§

impl<'a> Sync for Dialog<'a>

§

impl<'a> Unpin for Dialog<'a>

§

impl<'a> UnwindSafe for Dialog<'a>

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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