ferns

Ferns

Try editing the tree live on CodeSandbox

How to use

You'll need to add the ferns package with yarn or npm.

Browser rendering

Create your trees with the special "ferns-tree" class name:

<pre class="ferns-tree">
a
  -- arrow -->
    b
    c
    d
  -- other arrow -->
    d
    e
    f
</pre>

Finally, invoke DOM.makeFerns() in the browser:

import { DOM } from "ferns";

DOM.makeFerns();

Alternatively, you can invoke DOM.makeSingleFern() and pass your tree code directly:

import { DOM } from "ferns";

DOM.makeSingleFern(containerElement, {
  code: `
    a
      -- arrow -->
        b
        c
    `,
  zoomable: true,
  draggable: true,
});

Server rendering

You can render a fern to PNG (or SVG, or PDF) in Node using the canvas package:

import { createCanvas } from "canvas";
import { Renderer } from "ferns";

const buffer = Renderer.render(
  (width, height) => {
    const canvas = createCanvas(width, height);
    return {
      ctx: canvas.getContext("2d"),
      save: () => canvas.toBuffer(),
    };
  },
  {
    code: `
    a
      -- arrow -->
        b
        c
    `,
    maxWidth: 600,
  }
);

Dependencies

This package doesn't have any runtime dependencies. As of v0.0.7, it's 3.6 kB minified + gzipped.

It does use the Roboto font, but you can override it by specifying fontFamily in the options:

DOM.makeFerns({
  style: {
    fontFamily: "your preferred font",
  },
});

Acknowledgements

This was inspired by the amazing Mermaid.