# react-mermaid

> A react component to display mermaid diagrams and flowcharts.

Latest version **0.1.3** (published 2015-08-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-mermaid
pnpm add react-mermaid
yarn add react-mermaid
bun add react-mermaid
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2015-08-28 |
| First published | 2015-08-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+10 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 80 |
| Author | Jason Bellamy |
| Maintainers | jasonbellamy |
| Keywords | react, react-component, mermaid, diagram, markdown, flowchart, sequence diagram, gantt |

## Links

- npm: https://www.npmjs.com/package/react-mermaid
- Repository: https://github.com/jasonbellamy/react-mermaid
- Issues: https://github.com/jasonbellamy/react-mermaid/issues
- npm.io page: https://npm.io/package/react-mermaid

## Dependencies (1)

- [mermaid](https://npm.io/package/mermaid.md) ^0.5.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2015-08-28
- 0.1.2 — 2015-08-28
- 0.1.1 — 2015-08-28
- 0.1.0 — 2015-08-27

## README

# React <Mermaid>

> A react component to display [mermaid](https://github.com/knsv/mermaid) diagrams and flowcharts.


## Getting Started

- Install with [NPM](https://www.npmjs.org/) - `npm install --save react-mermaid`


## Usage

```javascript
var React   = require('react');
var Mermaid = require('react-mermaid');

var Component = React.createClass({
  render: function () {
    return (
      <Mermaid name="diagram">
        graph TD;
          A-->B;
          A-->C;
          B-->D;
          C-->D;
      </Mermaid>
    );
  }
});
```


## Options


Property | Type     | Argument     | Default   | Description
---------|----------|--------------|-----------|------------
name     | `string` | `<optional>` | `mermaid` | name of the diagram/flowchart


## Developing

[react-mermaid](https://github.com/jasonbellamy/react-mermaid) is built using **ES6**. Run the following task to compile the `src/` into `dist/`.

```bash
npm run build
```


## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.


## License
Copyright (c) 2015 [Jason Bellamy ](http://jasonbellamy.com)  
Licensed under the MIT license.

---
_Source: https://npm.io/package/react-mermaid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._