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>
impl<'a> Dialog<'a>
pub fn dialog_type(self, dialog_type: DialogType) -> Self
Source§impl<'a> Dialog<'a>
impl<'a> Dialog<'a>
Sourcepub fn get_border_color(&self) -> Color
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>
impl<'a> Dialog<'a>
Sourcepub fn with_theme(self, theme: &AppTheme) -> Self
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_textontheme.primarybackground
§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> 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
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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