Visual history for Phylocanvas
JavaScript CSS HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dev
dist
src
.eslintrc
.gitignore
LICENSE
README.md
package.json
unstyled.js
webpack.config.js

README.md

Phylocanvas History Plugin

Visual History for Phylocanvas.

Usage

npm install phylocanvas phylocanvas-plugin-history
import Phylocanvas from 'phylocanvas';
import historyPlugin from 'phylocanvas-plugin-history';

Phylocanvas.plugin(historyPlugin);

Phylocanvas.createTree('id', {
  // config defaults
  history: {
    parent: tree.containerElement,
    zIndex: 1,
  }
})

N.B. It is the responsibility of the developer to ensure that the overflow of the parent element is hidden.

Style

An unstyled bundle is also available:

import historyPlugin from 'phylocanvas-plugin-history/unstyled';

Events

A historytoggle event is fired when the history is opened or closed, with an isOpen flag in the event data.