Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jbitton/neo4j-graph-renderer

A React.js component that allows you to render neo4j graphs
https://github.com/jbitton/neo4j-graph-renderer

component neo4j react

Last synced: 4 months ago
JSON representation

A React.js component that allows you to render neo4j graphs

Awesome Lists containing this project

README

        

# neo4j-graph-renderer

Since neo4j does not provide a way to render its graphs, I've created a react component that can be used in order to render a neo4j graph (with all the animations, etc).

## Installation

If you are using `create-react-app`:
```bash
# using NPM
$ npm install neo4j-graph-renderer --save
# using yarn
$ yarn add neo4j-graph-renderer
```

If you are not using `create-react-app`, please install the following:
```bash
$ npm install style-loader --save-dev # style-loader for webpack
$ npm install css-loader --save-dev # css-loader for webpack
```

## Usage

```javascript
// Using ES6 Syntax
import React from 'react';
import ReactDOM from 'react-dom';
import { Neo4jGraphRenderer } from 'neo4j-graph-renderer';

const App = () => (




);

ReactDOM.render(, document.getElementById('root'));
```

Props you must provide:
* ```url```: the url required to access your neo4j db (e.g. "http://localhost:7474")
* ```user```: the username required to access your neo4j db
* ```password```: the password required to access your neo4j db
* ```query```: the query you'd like to execute

& There you go! Your neo4j graph has been rendered!

**NOTE**: If you would like to add any extra CSS or your own font, the graph is generated in a ```div``` with id "graph"

## Issues

If you find a bug, please file an issue on the [issue tracker](https://github.com/jbitton/neo4j-graph-renderer/issues) on GitHub.