Struct MarkdownViewer 

pub struct MarkdownViewer { /* private fields */ }

Markdown viewer component.

Renders markdown content with support for:

• Headings (h1-h6)
• Paragraphs
• Bold, italic, and strikethrough text
• Code (inline and blocks)
• Lists (ordered and unordered)
• Tables
• Images
• Links
• Blockquotes
• Horizontal rules
• Custom inline elements (see MarkdownViewer::inline_element)

With the code-editor feature enabled, code blocks are rendered with the CodeEditor component for syntax highlighting. Otherwise they fall back to plain monospace text.

Example

fn app() -> impl IntoElement {
    MarkdownViewer::new("# Hello World\n\nThis is **bold** and *italic* text.")
}

Implementations

impl MarkdownViewer

pub fn new(content: impl Into<Cow<'static, str>>) -> Self

pub fn inline_element<ReturnedElement: IntoElement + 'static>( self, handler: impl Into<Callback<String, Option<ReturnedElement>>>, ) -> Self

Set a handler for custom inline elements.

Each raw inline HTML tag in a paragraph (for example <rust-logo/>) is passed to the handler, which returns the element to inline, or None to keep the tag as plain text.

fn app() -> impl IntoElement {
    MarkdownViewer::new("Made with Rust <rust-logo/> btw")
        .inline_element(|html: String| html.starts_with("<rust-logo").then(|| "🦀"))
}

pub fn code_editor_font_family( self, font_family: impl Into<Cow<'static, str>>, ) -> Self

Sets the font family used for code blocks. Defaults to "Jetbrains Mono".

pub fn code_editor_language( self, resolver: impl Into<Callback<String, Option<EditorLanguage>>>, ) -> Self

Sets a resolver mapping a code block’s language to an EditorLanguage for highlighting.

Trait Implementations

impl Component for MarkdownViewer

fn render(&self) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl ContainerExt for MarkdownViewer

fn position(self, position: impl Into<Position>) -> Self

Set how the element is placed relative to its parent or the window. See [Position].

fn padding(self, padding: impl Into<Gaps>) -> Self

Set the inner spacing between the element’s edges and its content. See [Gaps].

fn margin(self, margin: impl Into<Gaps>) -> Self

Set the outer spacing between the element’s edges and its surroundings. See [Gaps].

fn min_width(self, minimum_width: impl Into<Size>) -> Self

Set the minimum width the element can shrink to. See [Size].

fn min_height(self, minimum_height: impl Into<Size>) -> Self

Set the minimum height the element can shrink to. See [Size].

fn max_width(self, maximum_width: impl Into<Size>) -> Self

Set the maximum width the element can grow to. See [Size].

fn max_height(self, maximum_height: impl Into<Size>) -> Self

Set the maximum height the element can grow to. See [Size].

fn visible_width(self, visible_width: impl Into<VisibleSize>) -> Self

Set how much of the measured width is actually used in layout. See [VisibleSize].

fn visible_height(self, visible_height: impl Into<VisibleSize>) -> Self

Set how much of the measured height is actually used in layout. See [VisibleSize].

impl KeyExt for MarkdownViewer

fn write_key(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.

fn key(self, key: impl Hash) -> Self

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists.

impl LayoutExt for MarkdownViewer

fn get_layout(&mut self) -> &mut LayoutData

Returns a mutable reference to the element’s layout data.

fn layout(self, layout: LayoutData) -> Self

Replace all of the element’s layout data at once. See [LayoutData].

impl MarkdownViewerThemePartialExt for MarkdownViewer

fn color(self, color: impl Into<Color>) -> Self

fn color_link(self, color_link: impl Into<Color>) -> Self

fn background_code(self, background_code: impl Into<Color>) -> Self

fn color_code(self, color_code: impl Into<Color>) -> Self

fn background_blockquote(self, background_blockquote: impl Into<Color>) -> Self

fn border_blockquote(self, border_blockquote: impl Into<Color>) -> Self

fn background_divider(self, background_divider: impl Into<Color>) -> Self

fn heading_h1(self, heading_h1: impl Into<f32>) -> Self

fn heading_h2(self, heading_h2: impl Into<f32>) -> Self

fn heading_h3(self, heading_h3: impl Into<f32>) -> Self

fn heading_h4(self, heading_h4: impl Into<f32>) -> Self

fn heading_h5(self, heading_h5: impl Into<f32>) -> Self

fn heading_h6(self, heading_h6: impl Into<f32>) -> Self

fn paragraph_size(self, paragraph_size: impl Into<f32>) -> Self

fn code_font_size(self, code_font_size: impl Into<f32>) -> Self

fn table_font_size(self, table_font_size: impl Into<f32>) -> Self

impl PartialEq for MarkdownViewer

fn eq(&self, other: &MarkdownViewer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MarkdownViewer