Vaadin WC API reference

Description

<vaadin-markdown> is a web component for rendering Markdown content. It takes Markdown source as input and renders the corresponding HTML.

Styling

The component does not have specific shadow DOM parts for styling the rendered Markdown content itself, as the content is rendered directly into the component's light DOM via a slot. You can style the rendered HTML elements using standard CSS selectors targeting the vaadin-markdown element.

See Styling Components documentation.

Properties

content

Type: string | null | undefined

The Markdown content.

lineBreaks

Type: boolean

When set to true, single line breaks ("soft breaks") within a paragraph are converted into <br> elements, the same way chat and message-style Markdown behaves.

By default, following the original Markdown specification, single line breaks are ignored (collapsed into a space) and a blank line is required to start a new paragraph.