# cytoscape-react

> React components for Cytoscape graphs with DOM-backed nodes

Latest version **5.0.4** (published 2026-06-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install cytoscape-react
pnpm add cytoscape-react
yarn add cytoscape-react
bun add cytoscape-react
```

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.0.4 |
| Published | 2026-06-29 |
| First published | 2021-07-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 83.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Michael Wright |
| Maintainers | mjwright |
| Keywords | cytoscape, react, graph, typescript |

## Links

- npm: https://www.npmjs.com/package/cytoscape-react
- Repository: https://github.com/mwri/cytoscape-react
- Homepage: https://github.com/mwri/cytoscape-react#readme
- Issues: https://github.com/mwri/cytoscape-react/issues
- npm.io page: https://npm.io/package/cytoscape-react

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 5.0.4 (latest) — 2026-06-29
- 5.0.3 — 2026-05-10
- 4.0.0 — 2022-10-02
- 3.0.2 — 2022-09-04
- 3.0.1 — 2022-09-04
- 3.0.0 — 2022-09-04
- 2.0.0 — 2022-03-12
- 1.0.6 — 2021-07-14
- 1.0.5 — 2021-07-14
- 1.0.4 — 2021-07-14
- 1.0.3 — 2021-07-12
- 1.0.2 — 2021-07-12
- 1.0.1 — 2021-07-11
- 1.0.0 — 2021-07-11

## README

# cytoscape-react

Cytoscape graphs with React components as nodes.

`cytoscape-react` renders React node content into a DOM overlay managed by
[`cytoscape-dom-node`](https://github.com/mwri/cytoscape-dom-node), while
Cytoscape keeps ownership of graph layout, edges, selection, zooming, and
panning.

For a full working demo, see [codepen qBmbVPg](https://codepen.io/mwri/pen/qBmbVPg).

## History

v5 is a conversion to typescript, which SHOULD be backwards compatible.
v4 is the latest pre typescript incarnation.

## Dependencies

- Cytoscape `^3.19.0`
- cytoscape-dom-node `^2.1.0`
- React `^17.0.2 || ^18.0.0 || ^19.0.0`
- React DOM `^17.0.2 || ^18.0.0 || ^19.0.0`

## Installation

```sh
npm install cytoscape-react cytoscape cytoscape-dom-node react react-dom
```

Import the package CSS once in your app:

```ts
import "cytoscape-react/index.css";
```

## Usage

```tsx
import { Edge, Graph, Node } from "cytoscape-react";

function MyGraph() {
  return (
    <Graph layoutParams={{ name: "cose" }}>
      <Node id="foo">
        <strong>Foo</strong>
      </Node>
      <Node id="bar">
        <label>
          Bar label
          <input defaultValue="editable" />
        </label>
      </Node>

      <Edge id="foo-bar" source="foo" target="bar" />
    </Graph>
  );
}
```

`Graph`, `Node`, and `Edge` remain named exports.

## Components

### Graph

`Graph` owns the Cytoscape core instance and injects it into child nodes and
edges.

Useful props:

- `cyParams`: additional Cytoscape constructor options. `container` is supplied
  by `Graph`.
- `domNodeOptions`: options forwarded to `cy.domNode()`. `domContainer` is
  supplied by `Graph`.
- `layoutParams`: Cytoscape layout options, defaulting to `{ name: "cose" }`.
- `layoutDebounce`: debounce delay for layout requests, defaulting to `100`.
- `onReady`: callback receiving the Cytoscape core and DOM-node renderer.

### Node

`Node` creates a Cytoscape node whose `data.dom` points at the rendered React
element.

Useful props:

- `id`: Cytoscape node id.
- `classes`: string or string array of Cytoscape classes.
- `data`: extra Cytoscape data fields.
- `position` or `renderedPosition`: initial position.
- `selected`, `locked`, `grabbable`, `selectable`: initial Cytoscape state.

### Edge

`Edge` creates a Cytoscape edge once both endpoint nodes exist. If either
endpoint is removed, the edge is removed too.

Useful props:

- `id`: Cytoscape edge id.
- `source`: source node id.
- `target`: target node id.
- `classes`: string or string array of Cytoscape classes.
- `data`: extra Cytoscape data fields.

## Compatibility

The v4 component names and core props are preserved:

- `Graph`, `Node`, `Edge`
- `cyParams`
- `layoutParams`
- `layoutDebounce`
- `classes`
- injected child props: `cytoInstance` and `layout`

Runtime `prop-types` were removed because the package is now authored in
TypeScript and publishes declaration files.

## Development

```sh
npm run lint
npm run typecheck
npm run test
npm run test:coverage
npm run build
npm run docs
npm run check
```

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