Struct Options 

#[non_exhaustive]
pub struct Options<S: StyleSheet = DefaultStyleSheet> { /* private fields */ }

Rendering options for crate::from_str_with_options.

S is the style sheet consulted while Markdown events are rendered. Options::default uses DefaultStyleSheet. Use Options::new to supply another StyleSheet. StyleSheet::heading_marker and StyleSheet::code_block_fence customize or hide the corresponding presentation symbols.

Example

use tui_markdown::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()
    }
}

let options = Options::new(MyStyleSheet);

Implementations

impl<S: StyleSheet> Options<S>

pub fn new(styles: S) -> Self

Creates rendering options that use styles.

Image fallback and syntax-highlighting settings retain their defaults.

pub fn image_fallback(self, image_fallback: ImageFallback) -> Self

Selects the text used to represent Markdown images.

See ImageFallback for the exact output of each mode.

pub fn code_theme(self, code_theme: impl Into<CodeTheme>) -> Self

Selects the syntax-highlighting theme for fenced code blocks.

By default, no explicit theme is stored and the renderer borrows its shared Base16OceanDark theme. Pass a BuiltinCodeTheme directly, or pass an owned CodeTheme. Construct custom themes from TextMate source with CodeTheme::from_textmate, or load a TextMate file with CodeTheme::from_file. The selected theme applies when a fenced code block names a recognized language.

Example

use tui_markdown::{BuiltinCodeTheme, Options};

let options = Options::default().code_theme(BuiltinCodeTheme::SolarizedDark);

pub fn selected_code_theme(&self) -> Option<&CodeTheme>

Returns the explicitly configured syntax-highlighting theme.

Returns None when the renderer will use the shared Base16OceanDark default.

Trait Implementations

impl<S: Clone + StyleSheet> Clone for Options<S>

fn clone(&self) -> Options<S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug + StyleSheet> Debug for Options<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Options<DefaultStyleSheet>

fn default() -> Self

Returns the “default value” for a type.