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

//! Method to apply an AppTheme to the HotkeyFooter.

use crate::services::theme::AppTheme;
use crate::widgets::hotkey_footer::HotkeyFooter;

impl HotkeyFooter {
    /// Applies theme colors to the hotkey footer.
    ///
    /// This method configures the footer's key color, description color,
    /// and background color based on the provided theme.
    ///
    /// # Theme Mapping
    ///
    /// - Key color uses `theme.primary`
    /// - Description color uses `theme.text_muted`
    /// - Background color uses `theme.background`
    ///
    /// # Arguments
    ///
    /// * `theme` - The application theme to apply
    ///
    /// # Returns
    ///
    /// Self with theme colors applied for method chaining.
    ///
    /// # Example
    ///
    /// ```rust,no_run
    /// use ratatui_toolkit::{HotkeyFooter, HotkeyItem, AppTheme};
    ///
    /// let theme = AppTheme::default();
    /// let footer = HotkeyFooter::new(vec![
    ///     HotkeyItem::new("q", "quit"),
    ///     HotkeyItem::new("?", "help"),
    /// ])
    /// .with_theme(&theme);
    /// ```
    pub fn with_theme(mut self, theme: &AppTheme) -> Self {
        self.key_color = theme.primary;
        self.description_color = theme.text_muted;
        self.background_color = theme.background;
        self
    }
}