ratatui-toolkit 0.2.6

DEPRECATED: this crate was renamed to `ratkit`. Please migrate to `ratkit`.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! Dialog component
//!
//! Provides modal dialog widgets with customizable buttons and styles.

pub mod constructors;
pub mod methods;
pub mod traits;
pub mod widget;

pub use widget::DialogWidget;

use ratatui::layout::Rect;
use ratatui::style::{Color, Style};

/// Dialog type
///
/// Represents different types of dialogs with associated visual styles.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DialogType {
    /// Informational dialog (cyan border)
    Info,
    /// Success dialog (green border)
    Success,
    /// Warning dialog (yellow border)
    Warning,
    /// Error dialog (red border)
    Error,
    /// Confirmation dialog (blue border)
    Confirm,
}

/// 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.
#[allow(dead_code)]
pub struct Dialog<'a> {
    /// Dialog title
    title: &'a str,
    /// Dialog message
    message: &'a str,
    /// Dialog type
    dialog_type: DialogType,
    /// Buttons to show
    buttons: Vec<&'a str>,
    /// Selected button index
    selected_button: usize,
    /// Width percentage (0.0 to 1.0)
    width_percent: f32,
    /// Height percentage (0.0 to 1.0)
    height_percent: f32,
    /// Footer text below the message
    footer: Option<&'a str>,
    /// Footer style
    footer_style: Style,
    /// Whether to show title inside content instead of border
    title_inside: bool,
    /// Whether to render a screen overlay behind the dialog
    overlay: bool,
    /// Style for the overlay background
    overlay_style: Style,
    /// Override color for dialog border
    border_color: Option<Color>,
    /// Style for the dialog
    style: Style,
    /// Style for selected button
    button_selected_style: Style,
    /// Style for unselected button
    button_style: Style,
    /// Areas for buttons (for click detection)
    button_areas: Vec<Rect>,
    /// Theme color for info dialogs (overrides default when set)
    theme_info_color: Option<Color>,
    /// Theme color for success dialogs (overrides default when set)
    theme_success_color: Option<Color>,
    /// Theme color for warning dialogs (overrides default when set)
    theme_warning_color: Option<Color>,
    /// Theme color for error dialogs (overrides default when set)
    theme_error_color: Option<Color>,
    /// Theme color for confirm dialogs (overrides default when set)
    theme_confirm_color: Option<Color>,
}