Blazorade.Mermaid 1.1.1

dotnet add package Blazorade.Mermaid --version 1.1.1
NuGet\Install-Package Blazorade.Mermaid -Version 1.1.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Blazorade.Mermaid" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Blazorade.Mermaid --version 1.1.1
#r "nuget: Blazorade.Mermaid, 1.1.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Blazorade.Mermaid as a Cake Addin
#addin nuget:?package=Blazorade.Mermaid&version=1.1.1

// Install Blazorade.Mermaid as a Cake Tool
#tool nuget:?package=Blazorade.Mermaid&version=1.1.1

Blazorade Mermaid

Blazorade Mermaid is a library that allows you to easily add Mermaid diagrams to your Blazor application. You don't have to bother with importing the JavaScript library, or calling the right JavaScript functions in the Mermaid library at the right time.

You just add the MermaidDiagram component to your application, set its Code parameter to the Mermaid code you want to render as a diagram, the Blazorade Mermaid takes care of the rest.

Getting Started

Please refer to the Blazorade Mermaid wiki for information on how to get started with the library.

Please note that this library is still in beta phase, and the wiki is still heavily under construction. However, using Blazorade is pretty simple.

  • Add a reference to Blazorade.Mermaid
  • Add a using statement to the following namespace: Blazorade.Mermaid.Components
  • Add the <MermaidDiagram /> to the page or component where you want to display a diagram.
  • Set the Definition property of the MermaidDiagram component to the Mermaid Code you want to render as a diagram.

Blazorade Mermaid will take care of the rest for you.

Version Highlights

v1.1.1

  • Fixed a bug that caused diagrams with inline themese not to render when the diagram with inline theme was the first diagram to render after the page load. PR #7

v1.1.0

  • Added the MermaidRender component which can be added on a page to render Mermaid definitions published mixed with other HTML content. Read more about how to use this component on the wiki.

v1.0.1

  • Changed package icon.
  • Added XML documentation file to the package to enable inline documentation with intellisense.

v1.0.0

The first stable version of Blazorade Mermaid.

  • Changed the Code parameter on the MermaidDiagram component to Definition to better match the terminology on the Mermaid website.

v1.0.0-beta.3

  • Prefixed the generated ID for the MermaidDiagram component with the character m to ensure that it never starts with a digit. id attributes for HTML elements MUST start with a letter, not a digit.

v1.0.0-beta.2

  • Added support for updating the diagram after it has been rendered the first time.

v1.0.0-beta.1

The first published prerelease of the library.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Blazorade.Mermaid:

Package Downloads
Frank.Blazor.Mermaid

Wrapper for Blazorade Mermaid

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.1 310 3/29/2024
1.1.0 85 3/25/2024
1.0.1 153 3/1/2024
1.0.0 659 2/26/2024

For details about this release, check out the release notes on Nuget at Blazorade.Mermaid.