rnk 0.19.3

A React-like declarative terminal UI framework for Rust, inspired by Ink and Bubbletea
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
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

//! UI Components

mod action;
mod display;
mod feedback;
mod input;
mod interaction;
pub mod keymap;
mod layout;

// Existing nested modules
pub mod textarea;
mod theme;
pub mod viewport;

pub(crate) use display::{capsule_variant, status};
pub(crate) use input::selection_list;
pub(crate) use layout::capsule;

// display
pub use action::{ActionButton, ActionRole, ActionShape, ActionState, ActionStyle};
pub use display::text;
pub use display::{
    Accordion, AccordionItem, Avatar, AvatarSize, Badge, BadgeVariant, Bar, BarChart,
    BarChartOrientation, Breadcrumb, Calendar, CapsuleVariant, Card, Chip, Divider,
    DividerOrientation, DividerStyle, EmptyState, Gauge, Gradient, Highlight, HighlightVariant,
    Hyperlink, HyperlinkBuilder, KeyHint, Line, LineChart, Link, List, ListItem, ListState,
    Markdown, Message, MessageRole, Newline, Progress, ProgressSymbols, Quote, QuoteStyle, Rating,
    RatingStyle, RatingSymbols, Series, Skeleton, SkeletonVariant, Span, Sparkline, Stat, Static,
    StopwatchState, Tag, Text, ThinkingBlock, TimerState, ToolCall, Trend, breadcrumb_from_path,
    format_duration_hhmmss, format_duration_mmss, format_duration_precise,
    set_hyperlinks_supported, supports_hyperlinks,
};
// feedback
pub use feedback::{
    Alert, AlertLevel, Cursor, CursorShape, CursorState, CursorStyle, DevTools, DevToolsTab,
    Dialog, DialogState, Help, HelpMode, HelpStyle, KeyBinding, Modal, ModalAlign, Notification,
    NotificationBorder, NotificationItem, NotificationLevel, NotificationPosition,
    NotificationState, NotificationStyle, Popover, PopoverArrow, PopoverBorder, PopoverPosition,
    PopoverStyle, Spinner, SpinnerBuilder, StatusBar, Step, StepStatus, Stepper,
    StepperOrientation, StepperStyle, Toast, Tooltip, TooltipPosition, editor_help,
    navigation_help, vim_navigation_help,
};
// input
pub use input::{
    ButtonStyle, CodeEditor, ColorPalette, ColorPicker, ColorPickerState, ColorPickerStyle,
    Command, CommandPalette, CommandPaletteState, CommandPaletteStyle, Confirm, ConfirmState,
    ConfirmStyle, ContextMenu, ContextMenuState, ContextMenuStyle, FileEntry, FileFilter,
    FilePicker, FilePickerState, FilePickerStyle, FileType, Language, MenuItem, MultiSelect,
    MultiSelectItem, MultiSelectState, MultiSelectStyle, Paginator, PaginatorState, PaginatorStyle,
    PaginatorType, SelectInput, SelectInputState, SelectInputStyle, SelectItem, TextInputHandle,
    TextInputOptions, TextInputState, handle_color_picker_input, handle_command_palette_input,
    handle_confirm_input, handle_confirm_input_with_mode, handle_file_picker_input,
    handle_multi_select_input, handle_paginator_input, handle_select_input, handle_text_input,
    use_text_input,
};
pub use interaction::{InteractionMode, InteractionOutcome};
pub use textarea::{
    Position as TextAreaPosition, Selection as TextAreaSelection, TextArea, TextAreaAction,
    TextAreaKeyMap, TextAreaState, TextAreaStyle, apply_textarea_action, handle_textarea_input,
    handle_textarea_input_with_mode,
};
pub use viewport::{
    Viewport, ViewportAction, ViewportKeyMap, ViewportState, ViewportStyle, apply_viewport_action,
    handle_viewport_input, handle_viewport_input_with_mode,
};
// layout
pub use layout::navigation;
pub use layout::{
    Box, Cell, Constraint, NavigationConfig, NavigationResult, Row, ScrollableBox, Scrollbar,
    ScrollbarOrientation, ScrollbarSymbols, SelectionState, Spacer, Tab, Table, TableState, Tabs,
    Transform, Tree, TreeNode, TreeState, TreeStyle, calculate_visible_range, fixed_bottom_layout,
    handle_list_navigation, handle_tree_input, virtual_scroll_view,
};
pub use theme::{
    BackgroundColors, BorderColors, BorderTokens, ButtonColors, ComponentColors, ComponentState,
    ComponentVariant, Density, DensityTokens, DesignTokens, FocusTokens, InputColors, ListColors,
    ProgressColors, SemanticColor, SpacingTokens, StateTokens, SymbolTokens, TextColors, Theme,
    ThemeBuilder, VariantStyle, get_theme, set_theme, with_theme,
};

// Implement From<T> for Element for all components with into_element()
// Excluded: Bar, Gradient, Hyperlink, Line, Spinner (no into_element)
// Excluded: Static, MultiSelect, SelectInput, Tree (generic params)
// Excluded: Cursor, Notification, Toast, Confirm, FilePicker (lifetime params)
crate::impl_into_element!(
    // Display
    Accordion,
    Avatar,
    Badge,
    BarChart,
    Breadcrumb,
    Calendar,
    Card,
    Chip,
    Divider,
    EmptyState,
    Gauge,
    Highlight,
    KeyHint,
    LineChart,
    Link,
    List,
    Markdown,
    Message,
    Newline,
    Progress,
    Quote,
    Rating,
    Skeleton,
    Sparkline,
    Stat,
    Tag,
    Text,
    ThinkingBlock,
    ToolCall,
    // Feedback
    Alert,
    DevTools,
    Dialog,
    Help,
    Modal,
    Popover,
    StatusBar,
    Stepper,
    Tooltip,
    // Input
    CodeEditor,
    ColorPicker,
    CommandPalette,
    ContextMenu,
    Paginator,
    // Layout
    Box,
    ScrollableBox,
    Scrollbar,
    Spacer,
    Table,
    Tabs,
    Transform,
);