ratatui-markdown 0.2.0

Markdown rendering, collapsible JSON/TOML trees, and rich scroll widgets for ratatui
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

mod hooks;
mod inline;
#[cfg(feature = "image")]
pub mod image;
mod parser;
mod render;
#[cfg(test)]
mod render_tests;
#[cfg(test)]
mod tests;
mod text;
mod types;

pub use hooks::RenderHooks;
pub use inline::parse_inline_formatting;
pub use types::MarkdownBlock;

#[cfg(feature = "image")]
pub use image::{CropRect, ImagePlacement, ImageResolver, MarkdownRenderOutput, NoopImageResolver};

use std::boxed::Box;

pub struct MarkdownRenderer {
    pub(crate) max_width: usize,
    pub(crate) hooks: Option<Box<dyn RenderHooks>>,
    pub(crate) tree_indent_width: usize,
    pub(crate) tree_text_gap: usize,
}

impl MarkdownRenderer {
    pub fn new(max_width: usize) -> Self {
        Self {
            max_width,
            hooks: None,
            tree_indent_width: 3,
            tree_text_gap: 0,
        }
    }

    pub fn with_render_hooks(mut self, hooks: Box<dyn RenderHooks>) -> Self {
        self.hooks = Some(hooks);
        self
    }

    pub fn with_tree_indent_width(mut self, width: usize) -> Self {
        self.tree_indent_width = width.max(1);
        self
    }

    pub fn with_tree_text_gap(mut self, gap: usize) -> Self {
        self.tree_text_gap = gap;
        self
    }
}