Struct Markdown 

pub struct Markdown { /* private fields */ }

A rendered Markdown document.

Implementations

impl Markdown

pub fn new(ident: impl Into<Ident>, source: impl Into<SharedString>) -> Self

pub fn max_lines(self, lines: usize) -> Self

Shows at most lines of the document’s own structure, and says how many were left out.

A line is a heading, a paragraph, one line of a code fence, one list entry, or one table row — not a line of wrapped text, whose count only layout knows.

pub fn on_event( self, handler: impl Fn(&MarkdownEvent, &mut Window, &mut App) + 'static, ) -> Self

pub fn image( self, source: impl Fn(&ImageRequest, &mut Window, &mut App) -> Option<AnyElement> + 'static, ) -> Self

Supplies the element to draw for an image the host already holds.

Answering None leaves the placeholder, which names the source, so a host that cannot supply one has said so rather than left a gap.

pub fn highlight( self, highlighter: impl Fn(&CodeBlock) -> Vec<CodeSpan> + 'static, ) -> Self

Colours code blocks from spans the host computed.

Without this every fence renders plain. Guessing a language from its text, or a grammar from its name, would put colour on a claim nobody made.

Trait Implementations

impl Debug for Markdown

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

Formats the value using the given formatter.

impl IntoElement for Markdown

type Element = ViewElement<Markdown>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Markdown

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.