Markdown Renderer
The Markdown Renderer component allows rendering Markdown content safely with support for various customizations.
Usage
Default
<MarkdownRenderer content={`
# Markdown Test
- Item 1
- Item 2
- [Visit BorealUI](https://www.borealui.ca)
- `Inline code`
> Blockquote
`} />Props
| Type | Description | |
|---|---|---|
| aria-describedby | string | ID of an element that describes the markdown region. |
| aria-label | string | Accessible label for the markdown region. Use this when there is no visible heading associated with the content. |
| aria-labelledby | string | ID of an element that labels the markdown region. Prefer this when a visible heading already exists. |
| className | string | Optional additional class name for styling. |
| content | string | Raw markdown content to be rendered as HTML. |
| data-testid | string | Optional test ID for testing frameworks. |
| language | string | Language of the rendered markdown content. |
| role | React.AriaRole | Optional ARIA role for the wrapper element. Defaults to "region". |
| rounding | RoundingType | Optional rounding style for the rendered container. One of: "none" | "small" | "medium" | "large" | "full" |
| shadow | ShadowType | Optional shadow styling for the rendered container. One of: "none" | "light" | "medium" | "strong" | "intense" |
| tabIndex | number | Optional tab index for keyboard focus management. |