rnk 0.17.3

A React-like declarative terminal UI framework for Rust, inspired by Ink
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
61
62
63
64
65
66
67
68
69
70
71
72
73

//! TextArea component for multi-line text editing
//!
//! A multi-line text input component similar to Bubbles' textarea.
//!
//! # Features
//!
//! - Multi-line text editing
//! - Cursor navigation (character, word, line, document)
//! - Text selection
//! - Line numbers
//! - Customizable key bindings
//! - Placeholder text
//! - Character/line limits
//! - Soft tabs (spaces) or hard tabs
//!
//! # Example
//!
//! ```ignore
//! use rnk::components::textarea::{TextArea, TextAreaState, TextAreaKeyMap, handle_textarea_input};
//! use rnk::hooks::{use_signal, use_input};
//!
//! fn app() -> Element {
//!     let state = use_signal(|| {
//!         let mut s = TextAreaState::new();
//!         s.set_placeholder("Enter your text here...");
//!         s
//!     });
//!
//!     let keymap = TextAreaKeyMap::default();
//!
//!     use_input({
//!         let state = state.clone();
//!         let keymap = keymap.clone();
//!         move |input, key| {
//!             let mut s = state.get();
//!             handle_textarea_input(&mut s, input, key, &keymap);
//!             state.set(s);
//!         }
//!     });
//!
//!     TextArea::new(&state.get())
//!         .focused(true)
//!         .line_numbers(true)
//!         .into_element()
//! }
//! ```
//!
//! # Key Bindings
//!
//! Default key bindings:
//!
//! | Key | Action |
//! |-----|--------|
//! | `←` / `→` | Move cursor left/right |
//! | `↑` / `↓` | Move cursor up/down |
//! | `Ctrl+←` / `Alt+B` | Move to previous word |
//! | `Ctrl+→` / `Alt+F` | Move to next word |
//! | `Home` / `Ctrl+A` | Move to line start |
//! | `End` / `Ctrl+E` | Move to line end |
//! | `Backspace` | Delete before cursor |
//! | `Delete` | Delete after cursor |
//! | `Ctrl+Backspace` / `Ctrl+W` | Delete word before |
//! | `Ctrl+K` | Delete line |
//! | `Enter` | Insert newline |
//! | `Tab` | Insert tab/spaces |

mod component;
mod keymap;
mod state;

pub use component::{TextArea, TextAreaStyle, apply_textarea_action, handle_textarea_input};
pub use keymap::{KeyBinding, KeyType, Modifiers, TextAreaAction, TextAreaKeyMap};
pub use state::{Position, Selection, TextAreaState};