rnk 0.15.32

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
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
//! Prelude module - commonly used imports
//!
//! This module re-exports the most commonly used types and functions
//! for convenience. Import with:
//!
//! ```ignore
//! use rnk::prelude::*;
//! ```

pub use crate::core::{
    AlignItems, BorderStyle, Color, Display, Element, ElementId, FlexDirection, JustifyContent,
    Overflow, Position, Style, TextWrap,
};

pub use crate::components::{
    // Accordion
    Accordion,
    AccordionItem,
    // Alert
    Alert,
    AlertLevel,
    // Avatar
    Avatar,
    AvatarSize,
    // Badge
    Badge,
    BadgeVariant,
    // Bar chart
    Bar,
    BarChart,
    BarChartOrientation,
    // Box
    Box,
    // Breadcrumb
    Breadcrumb,
    // Calendar
    Calendar,
    // Card
    Card,
    // Table
    Cell,
    // Chip
    Chip,
    // Code editor
    CodeEditor,
    // Color picker
    ColorPalette,
    ColorPicker,
    ColorPickerState,
    ColorPickerStyle,
    // Command palette
    Command,
    CommandPalette,
    CommandPaletteState,
    CommandPaletteStyle,
    // Confirm
    ButtonStyle,
    Confirm,
    ConfirmState,
    ConfirmStyle,
    Constraint,
    // Context menu
    ContextMenu,
    ContextMenuState,
    ContextMenuStyle,
    // Cursor
    Cursor,
    CursorShape,
    CursorState,
    CursorStyle,
    // DevTools
    DevTools,
    DevToolsTab,
    // Modal
    Dialog,
    DialogState,
    // Divider
    Divider,
    DividerOrientation,
    DividerStyle,
    // Empty state
    EmptyState,
    // File picker
    FileEntry,
    FileFilter,
    FilePicker,
    FilePickerState,
    FilePickerStyle,
    FileType,
    // Progress
    Gauge,
    // Gradient
    Gradient,
    // Help
    Help,
    HelpMode,
    HelpStyle,
    // Highlight
    Highlight,
    HighlightVariant,
    // Hyperlink
    Hyperlink,
    HyperlinkBuilder,
    // Key hint
    KeyHint,
    KeyBinding,
    // Theme
    BackgroundColors,
    BorderColors,
    ButtonColors,
    ComponentColors,
    InputColors,
    ListColors,
    ProgressColors,
    SemanticColor,
    TextColors,
    // Language
    Language,
    // Text
    Line,
    // Line chart
    LineChart,
    // Link
    Link,
    // List
    List,
    ListItem,
    ListState,
    // Markdown
    Markdown,
    // Context menu item
    MenuItem,
    // Message
    Message,
    MessageRole,
    Modal,
    ModalAlign,
    // Multi-select
    MultiSelect,
    MultiSelectItem,
    MultiSelectStyle,
    // Navigation
    NavigationConfig,
    NavigationResult,
    // Newline
    Newline,
    // Notification
    Notification,
    NotificationBorder,
    NotificationItem,
    NotificationLevel,
    NotificationPosition,
    NotificationState,
    NotificationStyle,
    // Paginator
    Paginator,
    PaginatorState,
    PaginatorStyle,
    PaginatorType,
    // Popover
    Popover,
    PopoverArrow,
    PopoverBorder,
    PopoverPosition,
    PopoverStyle,
    Progress,
    ProgressSymbols,
    // Quote
    Quote,
    QuoteStyle,
    // Rating
    Rating,
    RatingStyle,
    RatingSymbols,
    Row,
    // Scrollable
    ScrollableBox,
    // Scrollbar
    Scrollbar,
    ScrollbarOrientation,
    ScrollbarSymbols,
    // Select input
    SelectInput,
    SelectInputStyle,
    SelectItem,
    SelectionState,
    // Skeleton
    Skeleton,
    SkeletonVariant,
    // Spacer
    Spacer,
    Span,
    // Sparkline
    Sparkline,
    // Spinner
    Spinner,
    SpinnerBuilder,
    // Stat
    Stat,
    // Static
    Static,
    // Status bar
    StatusBar,
    // Stepper
    Step,
    StepStatus,
    Stepper,
    StepperOrientation,
    StepperStyle,
    // Timer
    StopwatchState,
    // Tabs
    Tab,
    Table,
    TableState,
    Tabs,
    // Tag
    Tag,
    Text,
    // Text input
    TextInputHandle,
    TextInputOptions,
    TextInputState,
    Theme,
    ThemeBuilder,
    ThinkingBlock,
    TimerState,
    Toast,
    // Tooltip
    Tooltip,
    TooltipPosition,
    ToolCall,
    // Transform
    Transform,
    // Trend
    Trend,
    // Tree
    Tree,
    TreeNode,
    TreeState,
    TreeStyle,
    // Series
    Series,
    // Functions
    alert_error,
    alert_info,
    alert_success,
    alert_warning,
    avatar,
    avatar_initials,
    badge_error,
    badge_primary,
    badge_success,
    badge_warning,
    breadcrumb_from_path,
    calculate_visible_range,
    card,
    card_full,
    chip,
    chip_selected,
    color_picker,
    color_picker_with_palette,
    command_palette,
    context_menu,
    cursor,
    editor_help,
    empty_state,
    empty_state_with_icon,
    file_picker,
    fixed_bottom_layout,
    format_duration_hhmmss,
    format_duration_mmss,
    format_duration_precise,
    get_theme,
    gradient,
    handle_confirm_input,
    handle_list_navigation,
    handle_paginator_input,
    handle_tree_input,
    highlight,
    highlight_error,
    highlight_primary,
    highlight_success,
    highlight_warning,
    hr,
    hr_dashed,
    hr_label,
    hyperlink,
    key_hint,
    key_hints,
    link,
    link_styled,
    link_with_icon,
    navigation_help,
    notification,
    popover,
    popover_with_content,
    quote,
    quote_with_author,
    rainbow,
    rating,
    rating_of,
    select_input,
    set_hyperlinks_supported,
    set_theme,
    skeleton_paragraph,
    skeleton_text,
    stat,
    stat_down,
    stat_up,
    static_output,
    status_bar,
    status_bar_full,
    stepper,
    supports_hyperlinks,
    tag,
    tag_colored,
    toast,
    tooltip,
    tooltip_left,
    tooltip_right,
    use_text_input,
    vim_navigation_help,
    virtual_scroll_view,
    with_theme,
};

// Rendering APIs
pub use crate::renderer::{
    AppBuilder,
    AppOptions,
    IntoPrintable,
    ModeSwitch,
    Printable,
    // Types
    RenderHandle,
    enter_alt_screen,
    exit_alt_screen,
    is_alt_screen,
    println,
    println_trimmed,
    // Main entry points
    render,
    render_fullscreen,
    render_handle,
    render_inline,
    // Element rendering APIs
    render_to_string,
    render_to_string_auto,
    render_to_string_no_trim,
    // Cross-thread APIs
    request_render,
};

// Hooks
pub use crate::hooks::{
    // Animation
    AnimationHandle,
    // App context
    AppContext,
    // Async
    AsyncHandle,
    AsyncState,
    // Paste
    BracketedPasteGuard,
    // Breakpoint
    Breakpoint,
    // Clipboard
    ClipboardHandle,
    // Counter
    CounterHandle,
    // Debounce
    DebounceHandle,
    // Command
    Deps,
    // Measure
    Dimensions,
    // Reducer
    Dispatch,
    // Focus
    FocusManagerHandle,
    FocusState,
    // Form
    FormField,
    FormHandle,
    // History
    HistoryHandle,
    // Hook context
    HookContext,
    // Idle
    IdleConfig,
    IdleState,
    // Input
    Key,
    // List
    ListHandle,
    // Local storage
    LocalStorageHandle,
    // Map
    MapHandle,
    MeasureContext,
    MeasureRef,
    // Media query
    MediaQuery,
    // Memo
    MemoizedCallback,
    // Keyboard shortcut
    Modifiers,
    // Mouse
    Mouse,
    MouseAction,
    MouseButton,
    // Network
    NetworkStatus,
    PasteEvent,
    PasteHandler,
    // Scroll
    ScrollHandle,
    ScrollState,
    // Set
    SetHandle,
    Shortcut,
    ShortcutKey,
    // Signal
    Signal,
    // Stdio
    StderrHandle,
    StdinHandle,
    StdoutHandle,
    // Toggle
    ToggleHandle,
    // Transition
    TransitionHandle,
    UseFocusOptions,
    // Window title
    WindowTitleGuard,
    // Functions
    check_host_reachable,
    check_online,
    clear_mouse_handlers,
    clear_paste_handlers,
    // Accessibility
    clear_screen_reader_cache,
    clear_window_title,
    current_context,
    disable_bracketed_paste,
    dispatch_mouse_event,
    dispatch_paste,
    enable_bracketed_paste,
    get_app_context,
    get_measure_context,
    get_terminal_size,
    idle_duration,
    is_bracketed_paste_enabled,
    is_clipboard_available,
    is_idle,
    is_mouse_enabled,
    measure_element,
    read_clipboard,
    record_activity,
    register_paste_handler,
    set_app_context,
    set_measure_context,
    set_mouse_enabled,
    set_screen_reader_enabled,
    set_window_title,
    use_animation,
    use_animation_auto,
    use_app,
    use_async_state,
    use_async_state_with,
    use_breakpoint,
    use_breakpoint_down,
    use_breakpoint_only,
    use_breakpoint_up,
    use_callback,
    use_changed,
    use_clipboard,
    use_cmd,
    use_cmd_once,
    use_counter,
    use_counter_zero,
    use_debounce,
    use_debounce_handle,
    // Effect
    use_effect,
    use_effect_once,
    use_focus,
    use_focus_manager,
    use_form,
    use_form_empty,
    // Frame rate
    use_frame_rate,
    use_history,
    use_history_with_size,
    use_host_reachable,
    use_idle,
    use_idle_seconds,
    use_idle_state,
    use_input,
    use_interval,
    use_interval_when,
    use_is_first_render,
    use_is_landscape,
    use_is_portrait,
    use_is_screen_reader_enabled,
    use_is_tall_enough,
    use_is_wide_enough,
    use_keyboard_shortcut,
    use_keyboard_shortcuts,
    use_list,
    use_list_empty,
    use_local_storage,
    use_local_storage_with_dir,
    use_map,
    use_map_empty,
    use_map_from,
    use_measure,
    use_media_query,
    use_memo,
    use_mouse,
    use_network_status,
    use_online,
    use_paste,
    use_previous,
    use_reducer,
    use_reducer_lazy,
    use_scroll,
    use_set,
    use_set_empty,
    use_signal,
    use_stderr,
    use_stdin,
    use_stdout,
    use_throttle,
    use_timeout,
    use_toggle,
    use_toggle_off,
    use_toggle_on,
    use_transition,
    use_transition_with_easing,
    use_window_height,
    use_window_size,
    use_window_title,
    use_window_title_fn,
    use_window_width,
    with_hooks,
    write_clipboard,
};