JSPM

  • Created
  • Published
  • Downloads 454
  • Score
    100M100P100Q73985F
  • License MIT

Package Exports

  • isoflow
  • isoflow/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (isoflow) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

readme-header

GitHub License MIT

A highly customizable React component for building interactive flow diagrams.

Coming soon under the MIT licence | Use it now on isoflow.io

Key Features

  • Real-time: Display real-time data on diagrams.
  • Customizable: Use your own isometric icon packs, or use our free set of networking icons (also under MIT).
  • Export options: Export diagrams as images, JSON or YAML.
  • Powerful annotation tools: Annotate nodes, groups and connectors.
  • Step-by-step walkthroughs: Create interactive tours of large diagrams to help viewers easily digest information.

Roadmap

Migration to open-source: ██░░░░░░░░░

  • Set up automated publishing to NPM registry
  • Migrate private JS project to public Typescript project
    • Pan / Select / Zoom modes
    • Display icons in sidebar
    • Nodes
    • Groups
    • Connectors
  • Publish icons as separate importable package

Installation

Note: Isoflow is currently not production ready. To view it's current state of development:

npm install isoflow

import Isoflow from 'isoflow';

const App = () => (
  <Isoflow
    height={500}
    initialScene={{
      icons: [],
      nodes: [],
      connectors: [],
      groups: []
    }}
  >
)

If using Next.js, make sure you only import Isoflow in the browser:

const Isoflow = dynamic(() => import("isoflow"), {
  ssr: false,
});

License

Isoflow is MIT licensed (see ./LICENSE).