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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
use std::{cell::RefCell, fmt::Display};
use promkit_widgets::{
listbox::{self, Listbox},
text::{self, Text},
text_editor::{self, Mode},
};
use crate::{
crossterm::style::{Attribute, Attributes, Color, ContentStyle},
snapshot::Snapshot,
switch::ActiveKeySwitcher,
Prompt,
};
pub mod keymap;
pub mod render;
/// Represents a query selection component that combines a text editor
/// for input and a list box
/// for displaying filtered options based on the input.
pub struct QuerySelector {
keymap: ActiveKeySwitcher<keymap::Keymap>,
/// State for the title displayed above the query selection.
title_state: text::State,
/// State for the text editor component.
text_editor_state: text_editor::State,
/// State for the list box component.
listbox_state: listbox::State,
/// A filter function to apply to the list box items
/// based on the text editor input.
filter: render::Filter,
}
impl QuerySelector {
/// Constructs a new `QuerySelector` instance
/// with a list of items and a filter function.
///
/// # Arguments
///
/// * `items` - An iterator over items that implement the `Display` trait,
/// to be used as options in the list box.
/// * `filter` - A function that takes the current input
/// from the text editor and the list of items,
/// returning a filtered list of items to display.
pub fn new<T, I>(items: I, filter: render::Filter) -> Self
where
T: Display,
I: IntoIterator<Item = T>,
{
Self {
title_state: text::State {
style: ContentStyle {
attributes: Attributes::from(Attribute::Bold),
..Default::default()
},
..Default::default()
},
text_editor_state: text_editor::State {
texteditor: Default::default(),
history: None,
prefix: String::from("❯❯ "),
mask: None,
prefix_style: ContentStyle {
foreground_color: Some(Color::DarkGreen),
..Default::default()
},
active_char_style: ContentStyle {
background_color: Some(Color::DarkCyan),
..Default::default()
},
inactive_char_style: ContentStyle::default(),
edit_mode: Default::default(),
word_break_chars: Default::default(),
lines: Default::default(),
},
listbox_state: listbox::State {
listbox: Listbox::from_displayable(items),
cursor: String::from("❯ "),
active_item_style: Some(ContentStyle {
foreground_color: Some(Color::DarkCyan),
..Default::default()
}),
inactive_item_style: Some(ContentStyle::default()),
lines: Default::default(),
},
keymap: ActiveKeySwitcher::new("default", self::keymap::default),
filter,
}
}
/// Sets the title text displayed above the query selection.
pub fn title<T: AsRef<str>>(mut self, text: T) -> Self {
self.title_state.text = Text::from(text);
self
}
/// Sets the style for the title text.
pub fn title_style(mut self, style: ContentStyle) -> Self {
self.title_state.style = style;
self
}
/// Sets the prefix string displayed before the input text in the text editor component.
pub fn prefix<T: AsRef<str>>(mut self, prefix: T) -> Self {
self.text_editor_state.prefix = prefix.as_ref().to_string();
self
}
/// Sets the style for the prefix string in the text editor component.
pub fn prefix_style(mut self, style: ContentStyle) -> Self {
self.text_editor_state.prefix_style = style;
self
}
/// Sets the style for the active character (the character at the cursor position) in the text editor component.
pub fn active_char_style(mut self, style: ContentStyle) -> Self {
self.text_editor_state.active_char_style = style;
self
}
/// Sets the style for inactive characters (characters not at the cursor position) in the text editor component.
pub fn inactive_char_style(mut self, style: ContentStyle) -> Self {
self.text_editor_state.inactive_char_style = style;
self
}
/// Sets the editing mode for the text editor component.
pub fn edit_mode(mut self, mode: Mode) -> Self {
self.text_editor_state.edit_mode = mode;
self
}
/// Sets the number of lines available for the text editor component.
pub fn text_editor_lines(mut self, lines: usize) -> Self {
self.text_editor_state.lines = Some(lines);
self
}
/// Sets the cursor symbol used in the list box component.
pub fn cursor<T: AsRef<str>>(mut self, cursor: T) -> Self {
self.listbox_state.cursor = cursor.as_ref().to_string();
self
}
/// Sets the style for active (currently selected) items in the list box component.
pub fn active_item_style(mut self, style: ContentStyle) -> Self {
self.listbox_state.active_item_style = Some(style);
self
}
/// Sets the style for inactive (not currently selected) items in the list box component.
pub fn inactive_item_style(mut self, style: ContentStyle) -> Self {
self.listbox_state.inactive_item_style = Some(style);
self
}
/// Sets the number of lines available for the list box component.
pub fn listbox_lines(mut self, lines: usize) -> Self {
self.listbox_state.lines = Some(lines);
self
}
pub fn register_keymap<K: AsRef<str>>(mut self, key: K, handler: keymap::Keymap) -> Self {
self.keymap = self.keymap.register(key, handler);
self
}
/// Displays the query select prompt and waits for user input.
/// Returns a `Result` containing the `Prompt` result,
/// which is the selected option.
pub fn prompt(self) -> anyhow::Result<Prompt<render::Renderer>> {
Ok(Prompt {
renderer: render::Renderer {
keymap: RefCell::new(self.keymap),
title_state: self.title_state,
text_editor_snapshot: Snapshot::<text_editor::State>::new(self.text_editor_state),
listbox_snapshot: Snapshot::<listbox::State>::new(self.listbox_state),
filter: self.filter,
},
})
}
}