neo-flow-viz

React Flow based Neo4j Vizualization Library written in TypeScript

Storybook

npm install neo-flow-viz

Documentation

  <NeoFlowViz
    query={query} // CYPHER Query
    response={response} // NodeJS style Neo4j Raw Response (checkout neo4j-server directory for an example)
    width={1500} // width
    height={800} // height
    colorMode="system" // dark, light, system
    direction="DOWN" // direction of ELKJS based layout
    onNodeClick={(event, node) => console.log({node})} // callback
    onEdgeClick={(event, edge) => console.log({edge})} // callback
    showDetails={true} // shows the panel with the properties on the right side
  />

Neo4j Server

npm run neo4j-server

Development

Make sure you install all dependencies first. Both in the test directory and main directory.

Running the neo4j server, for getting some sample responses

cd test/neo4j-server && npm install && docker compose build

docker compose up -d

Running storybook

This will run the storybook server (from the root)

npm test

Contributors: @rish-0-0