dotstate 0.3.4

A modern, secure, and user-friendly dotfile manager built with Rust
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

use crate::ui::Screen;
use anyhow::Result;
use crossterm::event::Event;
use ratatui::prelude::*;

/// Action that a component can return after handling an event
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ComponentAction {
    /// No action needed
    None,
    /// Navigate to a different screen
    Navigate(Screen),
    /// Quit the application
    Quit,
    /// Component state was updated, needs re-render
    Update,
    /// Custom action with a string identifier
    Custom(String),
}

/// Trait for all UI components
///
/// Components are self-contained UI elements that:
/// - Manage their own state
/// - Handle their own events
/// - Render themselves
/// - Return actions for the app to handle
pub trait Component {
    /// Render the component to the given area
    fn render(&mut self, frame: &mut Frame, area: Rect) -> Result<()>;

    /// Handle an event (keyboard, mouse, etc.)
    /// Returns an action that the app should take
    fn handle_event(&mut self, event: Event) -> Result<ComponentAction>;
}