ratatui-which-key 0.8.0

A which-key popup widget for ratatui applications
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

// Copyright (C) 2026 Jayson Lennon
// 
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public License
// along with this program; if not, see <https://opensource.org/license/lgpl-3-0>.

use crate::Key;

/// A key binding with an associated description.
#[derive(Debug, Clone)]
pub struct Binding<K: Key> {
    /// The key that triggers this binding.
    pub key: K,
    /// A human-readable description of what this binding does.
    pub description: String,
}

/// A group of related key bindings under a shared category.
#[derive(Debug, Clone)]
pub struct BindingGroup<K: Key> {
    /// The category name for this group of bindings.
    pub category: String,
    /// The bindings belonging to this category.
    pub bindings: Vec<Binding<K>>,
}

/// A key binding prepared for display, including category information.
#[derive(Debug, Clone)]
pub struct DisplayBinding<K, C> {
    /// The key that triggers this binding.
    pub key: K,
    /// A human-readable description of what this binding does.
    pub description: String,
    /// The category this binding belongs to.
    pub category: C,
}

/// The result of traversing a node in the key binding tree.
#[derive(Debug, Clone)]
pub enum NodeResult<K: Key, A> {
    /// A branch node with child bindings available for further navigation.
    Branch {
        /// The available child bindings from this branch.
        children: Vec<Binding<K>>,
    },
    /// A leaf node containing the action to execute.
    Leaf {
        /// The action associated with this key sequence.
        action: A,
    },
}