tui-markdown 0.3.7

A simple library for converting markdown to a Rataui Text value
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

//! Rendering configuration for tui-markdown.
//!
//! For now the only knob is the theme [`StyleSheet`]. This struct is `#[non_exhaustive]`, which
//! allows us to add more options in the future without breaking existing code.

use crate::{DefaultStyleSheet, StyleSheet};

/// Collection of optional parameters that influence markdown rendering.
///
/// The generic `S` allows users to provide their own theme type that implements the
/// [`StyleSheet`] trait. The default implementation is [`DefaultStyleSheet`], which provides a
/// set of sensible defaults for styling markdown elements.
///
/// # Example
///
/// ```
/// use tui_markdown::{DefaultStyleSheet, Options};
/// let options = Options::default();
///
/// // or with a custom style sheet
///
/// use ratatui_core::style::{Style, Stylize};
/// use tui_markdown::StyleSheet;
///
/// #[derive(Debug, Clone)]
/// struct MyStyleSheet;
///
/// impl StyleSheet for MyStyleSheet {
///     fn heading(&self, level: u8) -> Style {
///         Style::new().bold()
///     }
///
///     fn code(&self) -> Style {
///         Style::new().white().on_dark_gray()
///     }
///
///     fn link(&self) -> Style {
///         Style::new().blue().underlined()
///     }
///
///     fn blockquote(&self) -> Style {
///         Style::new().yellow()
///     }
///
///     fn heading_meta(&self) -> Style {
///         Style::new().dim()
///     }
///
///     fn metadata_block(&self) -> Style {
///         Style::new().light_yellow()
///     }
/// }
///
/// let options = Options::new(MyStyleSheet);
/// ```
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct Options<S: StyleSheet = DefaultStyleSheet> {
    /// The [`StyleSheet`] implementation that will be consulted every time the renderer needs a
    /// color choice.
    pub(crate) styles: S,
}

impl<S: StyleSheet> Options<S> {
    /// Creates a new `Options` instance with the provided style sheet.
    pub fn new(styles: S) -> Self {
        Self { styles }
    }
}

impl Default for Options<DefaultStyleSheet> {
    fn default() -> Self {
        Self::new(DefaultStyleSheet)
    }
}

#[cfg(test)]
mod tests {
    use ratatui_core::style::Style;

    use super::*;

    #[test]
    fn default() {
        let options: Options = Default::default();
        assert_eq!(
            options.styles.heading(1),
            Style::new().on_cyan().bold().underlined()
        );
    }

    #[test]
    fn custom_style_sheet() {
        #[derive(Debug, Clone)]
        struct CustomStyleSheet;

        impl StyleSheet for CustomStyleSheet {
            fn heading(&self, level: u8) -> Style {
                match level {
                    1 => Style::new().red().bold(),
                    _ => Style::new().green(),
                }
            }

            fn code(&self) -> Style {
                Style::new().white().on_black()
            }

            fn link(&self) -> Style {
                Style::new().blue().underlined()
            }

            fn blockquote(&self) -> Style {
                Style::new().yellow()
            }

            fn heading_meta(&self) -> Style {
                Style::new().dim()
            }

            fn metadata_block(&self) -> Style {
                Style::new().light_yellow()
            }
        }

        let options = Options {
            styles: CustomStyleSheet,
        };

        assert_eq!(options.styles.heading(1), Style::new().red().bold());
        assert_eq!(options.styles.heading(2), Style::new().green());
        assert_eq!(options.styles.code(), Style::new().white().on_black());
        assert_eq!(options.styles.link(), Style::new().blue().underlined());
        assert_eq!(options.styles.blockquote(), Style::new().yellow());
        assert_eq!(options.styles.heading_meta(), Style::new().dim());
        assert_eq!(options.styles.metadata_block(), Style::new().light_yellow());
    }
}