furo-ui5-markdown

furo-ui5-markdown #

@furo/ui5 v1.18.0
import '@furo/ui5/src/furo-ui5-markdown.js';
exports FuroUi5Markdown js
exports <furo-ui5-markdown> custom-element-definition
superclass LitElement

Summary: renders markdown data

Description #

furo-markdown Renders given md data with parseMarkdown or loads a md file with mdsrc="source.md"

Attributes and Properties #

mdsrc #

mdsrc String

source of the md

markdown #

markdown String

markdown string

markdownRendered #

default: undefined



unsafe #

unsafe Boolean

allow unsafe md. (writing html, components,…)

Methods #

fetchMd #

fetchMd(src `` ) ⟹ Promise&lt;string | never&gt;

`` → fn-fetch-md

fetch markdown from a url or path

  • src

parseMarkdown #

parseMarkdown(markdown `` ) ⟹ void

`` → fn-parse-markdown

Parse markdown string to html content

  • markdown

bindData #

bindData(stringField `` ) ⟹ void

`` → fn-bind-data

  • stringField