# react-node-graph-hook

> [![IMAGE ALT TEXT](http://img.youtube.com/vi/C-pETutAfrE/1.jpg)](http://www.youtube.com/watch?v=C-pETutAfrE "React Node Graph Demo")

Latest version **0.6.4** (published 2020-05-29) · 0 weekly downloads

## Install

```sh
npm install react-node-graph-hook
pnpm add react-node-graph-hook
yarn add react-node-graph-hook
bun add react-node-graph-hook
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.4 |
| Published | 2020-05-29 |
| First published | 2020-05-06 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 631.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | shafferchance |

## Links

- npm: https://www.npmjs.com/package/react-node-graph-hook
- npm.io page: https://npm.io/package/react-node-graph-hook

## Dependencies (6)

- [react-draggable](https://npm.io/package/react-draggable.md) ^4.3.1
- [react-onclickoutside](https://npm.io/package/react-onclickoutside.md) ^6.9.0
- [@fortawesome/fontawesome-free](https://npm.io/package/@fortawesome/fontawesome-free.md) ^5.13.0
- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) ^0.1.9
- [@fortawesome/fontawesome-svg-core](https://npm.io/package/@fortawesome/fontawesome-svg-core.md) ^1.2.28
- [@fortawesome/free-regular-svg-icons](https://npm.io/package/@fortawesome/free-regular-svg-icons.md) ^5.13.0

## Recent versions

- 0.6.4 (latest) — 2020-05-29
- 0.6.3 — 2020-05-29
- 0.6.2 — 2020-05-29
- 0.6.1 — 2020-05-29
- 0.6.0 — 2020-05-19
- 0.5.0 — 2020-05-15
- 0.4.0 — 2020-05-14
- 0.3.2 — 2020-05-13
- 0.3.1 — 2020-05-11
- 0.3.0 — 2020-05-11
- 0.2.0 — 2020-05-11
- 0.1.0 — 2020-05-06

## README

## Demo

[![IMAGE ALT TEXT](http://img.youtube.com/vi/C-pETutAfrE/1.jpg)](http://www.youtube.com/watch?v=C-pETutAfrE "React Node Graph Demo")

## Install

#### Npm:
```sh
npm install --save react-node-graph
```

## Usage

node data should follow this structure (ripped from https://github.com/idflood/ThreeNodes.js):

```js

var exampleGraph = {
  "nodes":[
    {"nid":0,"type":"Timer","x":89,"y":82,"fields":{"in":[{"name":"reset"},{"name":"pause"},{"name":"max"}],"out":[{"name":"out"}]}},
    {"nid":1,"type":"MathMult","x":284,"y":82,"fields":{"in":[{"name":"in"},{"name":"factor"}],"out":[{"name":"out"}]}},
    {"nid":2,"type":"Vector3","x":486,"y":188,"fields":{"in":[{"name":"xyz"},{"name":"x"},{"name":"y"},{"name":"z"}],"out":[{"name":"xyz"},{"name":"x"},{"name":"y"},{"name":"z"}]}}
  ],
  "connections":[
    {"from_node":nid,"from":"field_name","to_node":nid,"to":"field_name"},
  ]
};

```

and passed to our component

```js

<ReactNodeGraph 
            data={exampleGraph} 
            onNodeMove={(nid, pos)=>this.onNodeMove(nid, pos)}
            onNodeStartMove={(nid)=>this.onNodeStartMove(nid)}
            onNewConnector={(n1,o,n2,i)=>this.onNewConnector(n1,o,n2,i)} 
            onRemoveConnector={(connector)=>this.onRemoveConnector(connector)}
/>

```

#### Events:

OnNodeMove : triggered on a completed node drag

onNodeStartMove : triggered at the start of a node move

onNewConnector : triggered when a new connection is made

onRemoveConnector : triggered when a connection is removed

---
_Source: https://npm.io/package/react-node-graph-hook · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
