MarkdownViewer
MdViewerMD
BitMarkdownViewer is a SEO friendly Blazor wrapper around the famous markedjs library.
Notes
Usage
Basic
Advanced
Events
Parsing at [2026-07-19T21:49:15.5957899+02:00]
Parsed at [2026-07-19T21:49:15.5979324+02:00]
Rendered at []
API
BitMarkdownViewer parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| JsMiddlewareIdentifier | string? | null | The fully qualified JavaScript function identifier to invoke as JavaScript middleware after parsing. The string should reference a global JS function (e.g. <c>"myApp.sanitizeHtml"</c>) that accepts an HTML string and returns the processed HTML string. JavaScript middleware is skipped during server-side prerendering. |
| Markdown | string? | null | The Markdown string value to render as an html element. |
| Middleware | Func<string, Task<string>>? | null | The C# function to run after parsing markdown and before rendering HTML. The middleware receives the parsed HTML string and returns the processed HTML string. C# middleware is applied after JavaScript middleware. |
| NoPrerender | bool | false | Disables parse and render of the markdown content in the prerendering phase. |
| OnParsing | EventCallback<string?> | null | A callback that is called before starting to parse the markdown. |
| OnParsed | EventCallback<string?> | null | A callback that is called after parsing the markdown. |
| OnRendered | EventCallback<string?> | null | A callback that is called after rendering the parsed markdown. |
BitComponentBase parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| AriaLabel | string? | null | Gets or sets the accessible label for the component, used by assistive technologies. |
| Class | string? | null | Gets or sets the CSS class name(s) to apply to the rendered element. |
| Dir | BitDir? | null | Gets or sets the text directionality for the component's content. |
| HtmlAttributes | Dictionary<string, object> | new Dictionary<string, object>() | Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters. |
| Id | string? | null | Gets or sets the unique identifier for the component's root element. |
| IsEnabled | bool | true | Gets or sets a value indicating whether the component is enabled and can respond to user interaction. |
| Style | string? | null | Gets or sets the CSS style string to apply to the rendered element. |
| TabIndex | string? | null | Gets or sets the tab order index for the component when navigating with the keyboard. |
| Visibility | BitVisibility | BitVisibility.Visible | Gets or sets the visibility state (visible, hidden, or collapsed) of the component. |
BitComponentBase public members
| Name | Type | Default value | Description |
|---|---|---|---|
| UniqueId | Guid | Guid.NewGuid() | Gets the readonly unique identifier for the component's root element, assigned when the component instance is constructed. |
| RootElement | ElementReference | Gets the reference to the root HTML element associated with this component. |
BitVisibility enum
| Name | Value | Description |
|---|---|---|
| Visible | 0 | The content of the component is visible. |
| Hidden | 1 | The content of the component is hidden, but the space it takes on the page remains (visibility:hidden). |
| Collapsed | 2 | The component is hidden (display:none). |
BitDir enum
| Name | Value | Description |
|---|---|---|
| Ltr | 0 | Ltr (left to right) is to be used for languages that are written from the left to the right (like English). |
| Rtl | 1 | Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic). |
| Auto | 2 | Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element. |
Feedback
You can give us your feedback through our GitHub repo by filing a new Issue or starting a new Discussion.
Or you can review / edit this page on GitHub.
- On this page