# @neo4j-nvl/base

> Base library for the Neo4j Visualization Library

Latest version **1.2.2** (published 2026-09-11) · SEE LICENSE IN 'LICENSE.txt' license · 0 weekly downloads

## Install

```sh
npm install @neo4j-nvl/base
pnpm add @neo4j-nvl/base
yarn add @neo4j-nvl/base
bun add @neo4j-nvl/base
```

## Health

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

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2026-09-11 |
| First published | 2024-05-08 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN 'LICENSE.txt' |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | neo4j-bloom-reader2, neo4j-bloom-publisher, neo4j-organization |
| Keywords | neo4j, visualization, graph |

## Links

- npm: https://www.npmjs.com/package/@neo4j-nvl/base
- Homepage: https://neo4j.com/docs/nvl/current/
- Issues: https://community.neo4j.com/c/neo4j-graph-platform/neo4j-bloom
- npm.io page: https://npm.io/package/@neo4j-nvl/base

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 1.2.2 (latest) — 2026-09-11
- 1.2.0-5fa31537 (next) — 2026-09-10
- 1.2.0-69184852 — 2026-09-10
- 1.2.0-60f5032a — 2026-09-09
- 1.2.0-b06ccb79 — 2026-09-03
- 1.2.0-dbc13ec2 — 2026-08-31
- 1.2.0-685572c8 — 2026-08-26
- 1.2.0-939c3c83 — 2026-08-26
- 1.2.0-eea71f07 — 2026-08-26
- 1.2.0-50be3731 — 2026-08-25
- 1.2.0-7097fcd1 — 2026-08-25
- 1.2.0-3f080b04 — 2026-08-19
- 1.2.0-84e1e1ad — 2026-08-17
- 1.2.0-af7504c8 — 2026-08-17
- 1.2.0-86e05dd9 — 2026-08-17
- … 273 more at https://npm.io/package/@neo4j-nvl/base/versions

## README

# Neo4j Visualization Library

Welcome to the Neo4j Visualization Library, NVL for short. NVL is a collection of libraries that can be used to build custom graph visualizations like those used in [Neo4j Bloom](https://neo4j.com/product/bloom/). NVL is written in TypeScript and can be used in any JavaScript project. It is also available as a React component that can be used in React applications.

## Consuming the library

### Installing the library

You can install the library with your preferred package manager, for example

```bash
npm install @neo4j-nvl/base
```

If you want to add common interactivity to the graph, you can install the [NVL interaction handlers](https://www.npmjs.com/package/@neo4j-nvl/interaction-handlers). If you are planning to use NVL in a React app, be sure to check out the [NVL React wrappers](https://www.npmjs.com/package/@neo4j-nvl/react).

### Using the library

This is a basic setup for a NVL instance.

```js
const nodes = [{ id: '1' }, { id: '2' }]
const relationships = [{ id: '12', from: '1', to: '2' }]

const options = {
  layout: 'forceDirected',
  initialZoom: 0.5
}

const callbacks = {
  onLayoutDone: () => console.log('Layout done')
}

const nvl = new NVL(document.getElementById('frame'), nodes, relationships, options, callbacks)
```

You can find more instructions and examples on how to use NVL in the [docs](https://neo4j.com/docs/nvl/current/).

### Product analytics

In order to improve the library we are collecting some information about the usage of NVL. If you prefer to disable this behavior set the parameter `disableTelemetry=true` as a parameter in `nvlOptions`.

## Further Resources

- NVL documentation: https://neo4j.com/docs/nvl/current/
- NVL API docs: https://neo4j.com/docs/api/nvl/current/
- NVL code examples: https://neo4j.com/docs/api/nvl/current/examples.html

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