markdown-tui-explorer 0.7.0

A terminal-based markdown file browser and viewer with search, syntax highlighting, and live reload
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

use crate::markdown::MermaidBlockId;
use crate::mermaid::MermaidEntry;
use crate::ui::search_bar::SearchResult;
use crossterm::event::{KeyEvent, MouseEvent};
use std::path::PathBuf;

/// All actions that can be dispatched through the application event loop.
///
/// `RawKey` events are produced by the input task and translated into more
/// specific variants by the focused-widget key handlers. Many variants are
/// constructed only through `handle_key` dispatch paths, so dead-code analysis
/// produces false positives for this enum.
#[allow(dead_code)]
pub enum Action {
    /// Exit the application.
    Quit,

    /// Raw terminal key event — mapped to a concrete action based on focus.
    RawKey(KeyEvent),

    /// Move focus to the file tree panel.
    FocusLeft,
    /// Move focus to the viewer panel.
    FocusRight,

    /// Move the tree cursor up one entry.
    TreeUp,
    /// Move the tree cursor down one entry.
    TreeDown,
    /// Toggle expansion of the selected directory.
    TreeToggle,
    /// Open the selected file or toggle the selected directory.
    TreeSelect,
    /// Jump to the first entry in the tree.
    TreeFirst,
    /// Jump to the last entry in the tree.
    TreeLast,

    /// Scroll the viewer up by `n` lines.
    ScrollUp(u16),
    /// Scroll the viewer down by `n` lines.
    ScrollDown(u16),
    /// Scroll the viewer up by half a page.
    ScrollHalfPageUp,
    /// Scroll the viewer down by half a page.
    ScrollHalfPageDown,
    /// Jump to the top of the document.
    ScrollToTop,
    /// Jump to the bottom of the document.
    ScrollToBottom,

    /// Open the search bar and reset its state.
    EnterSearch,
    /// Close the search bar and return focus to the tree.
    ExitSearch,
    /// Append a character to the search query.
    SearchInput(char),
    /// Remove the last character from the search query.
    SearchBackspace,
    /// Select the next search result.
    SearchNext,
    /// Select the previous search result.
    SearchPrev,
    /// Confirm the current search result and open the file.
    SearchConfirm,
    /// Toggle between file-name and content search modes.
    SearchToggleMode,

    /// Notify the app that one or more watched files changed on disk.
    FilesChanged(Vec<PathBuf>),

    /// Terminal was resized to the given (width, height).
    Resize(u16, u16),

    /// Raw mouse event forwarded from crossterm.
    Mouse(MouseEvent),

    /// A background mermaid render completed; entry is ready to be stored.
    ///
    /// Boxed to avoid inflating every `Action` variant by the size of `MermaidEntry`.
    MermaidReady(MermaidBlockId, Box<MermaidEntry>),

    /// Background content search completed; replace the search result list.
    ///
    /// The `generation` field matches the counter that was current when the task
    /// was spawned. Stale results (superseded by a newer query) are dropped by
    /// the handler before touching `SearchState`.
    SearchResults {
        generation: u64,
        results: Vec<SearchResult>,
    },

    /// A file was loaded asynchronously and is ready to be opened in a tab.
    FileLoaded {
        /// Absolute path that was read.
        path: PathBuf,
        /// Raw text content.
        content: String,
        /// `true` → open in a new tab; `false` → replace the active tab.
        new_tab: bool,
    },

    /// A watched file was reloaded asynchronously; update all matching tabs.
    FileReloaded {
        /// Absolute path that was re-read.
        path: PathBuf,
        /// Fresh text content.
        content: String,
    },
}