@lightenna/react-mermaid-diagram
TypeScript icon, indicating that this package has built-in type declarations

1.0.17 • Public • Published

react-mermaid-diagram

Simple React component to embed Mermaid diagrams.

Getting started

npm install mermaid react
npm install @lightenna/react-mermaid-diagram

Then use the component in your React app:

import {MermaidDiagram} from "@lightenna/react-mermaid-diagram";

const diagram_text="graph TD\nA-->B;\nB-->C;\n";
return <MermaidDiagram>
  {diagram_text}
</MermaidDiagram>;

If using with Next.js, Mermaid is a client-side library, so you'll need your containing component to identify that it's running on the client side:

'use client';
import { MermaidDiagram } from '@lightenna/react-mermaid-diagram';

export default function Diagram() {
  return <MermaidDiagram>{`graph TD;\nA-->B;\nB-->C;`}</MermaidDiagram>;
}

Readme

Keywords

none

Package Sidebar

Install

npm i @lightenna/react-mermaid-diagram

Weekly Downloads

1,223

Version

1.0.17

License

Apache-2.0

Unpacked Size

39.2 kB

Total Files

11

Last publish

Collaborators

  • cleverlight