Struct Markdown

pub struct Markdown(/* private fields */);

W Render markdown styled text.

Properties

pub image_resolver(resolver: impl IntoVar<ImageResolver>);

Markdown image resolver.

This can be used to override image source resolution, by default the image URL or URI is passed as parsed to the image_fn.

Note that image downloads are blocked by default, you can enable this by using the image::img_limits property.

Sets the IMAGE_RESOLVER_VAR.

pub link_resolver(resolver: impl IntoVar<LinkResolver>);

Markdown link resolver.

This can be used to expand or replace links.

Sets the LINK_RESOLVER_VAR.

pub link_scroll_mode(mode: impl IntoVar<ScrollToMode>);

Scroll-to mode used by anchor links.

pub text_fn(wgt_fn: impl IntoVar<WidgetFn<TextFnArgs>>);

Widget function that converts TextFnArgs to widgets.

Sets the TEXT_FN_VAR.

pub link_fn(wgt_fn: impl IntoVar<WidgetFn<LinkFnArgs>>);

Widget function that converts LinkFnArgs to widgets.

Sets the LINK_FN_VAR.

pub code_inline_fn(wgt_fn: impl IntoVar<WidgetFn<CodeInlineFnArgs>>);

Widget function that converts CodeInlineFnArgs to widgets.

Sets the CODE_INLINE_FN_VAR.

pub code_block_fn(wgt_fn: impl IntoVar<WidgetFn<CodeBlockFnArgs>>);

Widget function that converts CodeBlockFnArgs to widgets.

Sets the CODE_BLOCK_FN_VAR.

pub paragraph_fn(wgt_fn: impl IntoVar<WidgetFn<ParagraphFnArgs>>);

Widget function that converts ParagraphFnArgs to widgets.

Sets the PARAGRAPH_FN_VAR.

pub heading_fn(wgt_fn: impl IntoVar<WidgetFn<HeadingFnArgs>>);

Widget function that converts HeadingFnArgs to widgets.

Sets the HEADING_FN_VAR.

pub list_fn(wgt_fn: impl IntoVar<WidgetFn<ListFnArgs>>);

Widget function that converts ListFnArgs to widgets.

Sets the LIST_FN_VAR.

pub def_list_fn(wgt_fn: impl IntoVar<WidgetFn<DefListArgs>>);

Widget function that converts DefListArgs to widgets.

Sets the DEF_LIST_FN_VAR.

pub def_list_item_title_fn( &self, wgt_fn: impl IntoVar<WidgetFn<DefListItemTitleArgs>>, );

Widget function that converts DefListItemTitleArgs to widgets.

Sets the DEF_LIST_ITEM_TITLE_FN_VAR.

pub def_list_item_definition_fn( &self, wgt_fn: impl IntoVar<WidgetFn<DefListItemDefinitionArgs>>, );

Widget function that converts DefListItemDefinitionArgs to widgets.

Sets the DEF_LIST_ITEM_DEFINITION_FN_VAR.

pub list_item_bullet_fn( &self, wgt_fn: impl IntoVar<WidgetFn<ListItemBulletFnArgs>>, );

Widget function that converts ListItemBulletFnArgs to widgets.

Sets the LIST_ITEM_BULLET_FN_VAR.

pub list_item_fn(wgt_fn: impl IntoVar<WidgetFn<ListItemFnArgs>>);

Widget function that converts ListItemFnArgs to widgets.

Sets the LIST_ITEM_FN_VAR.

pub image_fn(wgt_fn: impl IntoVar<WidgetFn<ImageFnArgs>>);

Widget function that converts ImageFnArgs to widgets.

Sets the IMAGE_FN_VAR.

pub rule_fn(wgt_fn: impl IntoVar<WidgetFn<RuleFnArgs>>);

Widget function that converts RuleFnArgs to widgets.

Sets the RULE_FN_VAR.

pub block_quote_fn(wgt_fn: impl IntoVar<WidgetFn<BlockQuoteFnArgs>>);

Widget function that converts BlockQuoteFnArgs to widgets.

Sets the BLOCK_QUOTE_FN_VAR.

pub footnote_ref_fn(wgt_fn: impl IntoVar<WidgetFn<FootnoteRefFnArgs>>);

Widget function that converts FootnoteRefFnArgs to widgets.

Sets the FOOTNOTE_REF_FN_VAR.

pub footnote_def_fn(wgt_fn: impl IntoVar<WidgetFn<FootnoteDefFnArgs>>);

Widget function that converts FootnoteDefFnArgs to widgets.

Sets the FOOTNOTE_DEF_FN_VAR.

pub table_fn(wgt_fn: impl IntoVar<WidgetFn<TableFnArgs>>);

Widget function that converts TableFnArgs to widgets.

Sets the TABLE_FN_VAR.

pub panel_fn(wgt_fn: impl IntoVar<WidgetFn<PanelFnArgs>>);

Widget function that converts PanelFnArgs to a widget.

This generates the panel that contains all markdown blocks, it is the child of the Markdown! widget.

Sets the PANEL_FN_VAR.

pub txt(txt: impl IntoVar<Txt>);

Markdown text.

Properties from FontMix

Implementations

impl Markdown

pub fn widget_new() -> Self

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

Loading...

Inherits from ParagraphMix

Loading...

Inherits from LangMix

Loading...

Inherits from WidgetBase

Loading...

pub fn font_family(&self, names: impl IntoVar<FontNames>)

P Font family name or list of names for texts in this widget or descendants.

All fonts in the list are resolved according to the font_style, font_weight and font_stretch config. During text shaping the first font on the list is preferred, but if the font does not cover a character or word, that character or word to the second font in the list and so on.

Sets the FONT_FAMILY_VAR.

pub fn font_size(&self, size: impl IntoVar<Length>)

P Sets the font size for the widget and descendants.

This property affects all texts inside the widget and the Length::Em unit.

Sets the FONT_SIZE_VAR context var and the LayoutMetrics::font_size.

pub fn font_weight(&self, weight: impl IntoVar<FontWeight>)

P Defines the thickness or boldness the preferred font should have.

This value influences font resolution, the variant within the font family that is closest to this config will be selected.

Sets the FONT_WEIGHT_VAR.

pub fn font_style(&self, style: impl IntoVar<FontStyle>)

P Defines the skew style of the font glyphs.

This value influences font resolution, the variant within the font family that is closest to this config will be selected.

Sets the FONT_STYLE_VAR.

pub fn font_stretch(&self, stretch: impl IntoVar<FontStretch>)

P Defines how condensed or expanded the preferred font should be.

This value influences font resolution, the variant within the font family that is closest to this config will be selected.

Sets the FONT_STRETCH_VAR.

pub fn font_synthesis(&self, enabled: impl IntoVar<FontSynthesis>)

P Configure if a synthetic font is generated for fonts that do not implement bold or oblique variants.

Not all fonts implement the requested font_weight and font_style, this config allows the renderer to try and generate the style and weight anyway, using transforms and the glyph outlines.

Sets the FONT_SYNTHESIS_VAR.

pub fn font_aa(&self, aa: impl IntoVar<FontAntiAliasing>)

P Configure the anti-aliasing used to render text glyphs inside the widget.

Uses the operating system configuration by default.

Sets the FONT_AA_VAR.

Trait Implementations

impl Deref for Markdown

type Target = FontMix<TextSpacingMix<ParagraphMix<LangMix<WidgetBase>>>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Markdown

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.