widgetui 0.7.1

A bevy like widget system for ratatui and crossterm
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

use crossterm::event::{Event, KeyCode, KeyEvent, KeyEventKind};

use crate::State;

/// A state that wraps over the events from crossterm
#[derive(Default, Clone, State)]
pub struct Events {
    pub event: Option<Event>,
    pub(crate) exit: bool,
}

impl Events {
    /// Returns whether a key was pressed this frame.
    pub fn key(&self, code: KeyCode) -> bool {
        if let Some(Event::Key(key_event)) = self.event {
            if key_event.code == code && key_event.kind == KeyEventKind::Press {
                return true;
            }
        }

        false
    }

    /// Returns whether a Key Event was completed this frame.
    pub fn key_event(&self, check_event: KeyEvent) -> bool {
        if let Some(Event::Key(key_event)) = self.event {
            if key_event == check_event && key_event.kind == KeyEventKind::Press {
                return true;
            }
        }

        false
    }

    /// Returns whether a key was pressed this frame.
    /// This will consume the key, not passing it on to future widgets.
    pub fn consume_key(&mut self, code: KeyCode) -> bool {
        if let Some(Event::Key(key_event)) = self.event {
            if key_event.code == code && key_event.kind == KeyEventKind::Press {
                self.event = None;
                return true;
            }
        }

        false
    }

    /// Let the app know you want to quit.
    pub fn register_exit(&mut self) {
        self.exit = true;
    }
}