@neo4j-nvl/react 1.0.0-b6554465 → 1.0.0-bb8a655f

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 All notable changes to NVL will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## [1.1.0] - 2026-02-16
+
+This 1.1.0 release introduces new rendering capabilities with the addition of a new SVG export method, alongside a new Circular Layout algorithm and touchpad gestures for zooming. It also includes performance improvements for the renderer and physics engine, as well as various fixes for the React wrappers and Minimap.
+
+### Added
+
+- new SVG export functionality.
+- new circular layout option.
+- two-finger pinch gesture to zoom with touchpads.
+- onCanvasDoubleClick callback to the interactive NVL React wrapper.
+
+### Changed
+
+- improved minimap handling for React components.
+- rendering performance improvements.
+- physics layout performance and gravity improvements.
+
+### Fixed
+
+- seed radius calculation in D3 layout for large graphs.
+- forceDirected layout unnecessarily reheating on switch without changes.
+- ensure drag operations are always correctly ended on mouse up.
+- minimap positioning issues.
+- background color for the 'os' theme in api documentation.
+
 ## [1.0.0] - 2025-09-30
 This 1.0.0 release is our first major release, with NVL's release strategy fully adopting semantic versioning going forward. Updates in this release include React 19 support for the React wrappers, a UI overhaul of the [examples app](https://neo4j.com/docs/api/nvl/current/examples.html).
 

package/lib/__tests__/BasicNvlWrapper.test.js

@@ -7,6 +7,17 @@ import { BasicNvlWrapper } from '../basic-wrapper/BasicNvlWrapper';
 jest.mock('@neo4j-nvl/base');
 jest.mock('@neo4j-nvl/layout-workers');
 describe('BasicNvlWrapper', () => {
+    let setZoom;
+    let setPan;
+    let setZoomAndPan;
+    beforeEach(() => {
+        setZoom = jest.fn();
+        setPan = jest.fn();
+        setZoomAndPan = jest.fn();
+        jest.spyOn(NVL.prototype, 'setZoom').mockImplementation(setZoom);
+        jest.spyOn(NVL.prototype, 'setPan').mockImplementation(setPan);
+        jest.spyOn(NVL.prototype, 'setZoomAndPan').mockImplementation(setZoomAndPan);
+    });
     afterEach(() => {
         jest.clearAllMocks();
     });
@@ -37,33 +48,78 @@ describe('BasicNvlWrapper', () => {
         expect(destroy).toHaveBeenCalledTimes(1);
     });
     test('calls setZoom when zoom property is provided', () => {
-        const setZoom = jest.fn();
-        jest.spyOn(NVL.prototype, 'setZoom').mockImplementation(setZoom);
         render(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 1.5 }) }));
         expect(setZoom).toHaveBeenCalledWith(1.5);
+        expect(setZoom).toHaveBeenCalledTimes(1);
     });
     test('calls setPan when pan property is provided', () => {
-        const setPan = jest.fn();
-        jest.spyOn(NVL.prototype, 'setPan').mockImplementation(setPan);
         render(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], pan: { x: 10, y: 20 } }) }));
         expect(setPan).toHaveBeenCalledWith(10, 20);
+        expect(setPan).toHaveBeenCalledTimes(1);
     });
     test('calls setZoomAndPan when both zoom and pan properties are provided', () => {
-        const setZoomAndPan = jest.fn();
-        jest.spyOn(NVL.prototype, 'setZoomAndPan').mockImplementation(setZoomAndPan);
         render(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 1.5, pan: { x: 10, y: 20 } }) }));
         expect(setZoomAndPan).toHaveBeenCalledWith(1.5, 10, 20);
+        expect(setZoomAndPan).toHaveBeenCalledTimes(1);
     });
     test('does not call zoom/pan methods when properties are undefined', () => {
-        const setZoom = jest.fn();
-        jest.spyOn(NVL.prototype, 'setZoom').mockImplementation(setZoom);
-        const setPan = jest.fn();
-        jest.spyOn(NVL.prototype, 'setPan').mockImplementation(setPan);
-        const setZoomAndPan = jest.fn();
-        jest.spyOn(NVL.prototype, 'setZoomAndPan').mockImplementation(setZoomAndPan);
         render(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [] }) }));
         expect(setZoom).not.toHaveBeenCalled();
         expect(setPan).not.toHaveBeenCalled();
         expect(setZoomAndPan).not.toHaveBeenCalled();
     });
+    test('only calls setZoom when zoom changes', () => {
+        const { rerender } = render(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 1.5 }) }));
+        expect(setZoom).toHaveBeenCalledTimes(1);
+        expect(setZoom).toHaveBeenCalledWith(1.5);
+        rerender(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 1.5 }) }));
+        expect(setZoom).toHaveBeenCalledTimes(1);
+        rerender(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 2.0 }) }));
+        expect(setZoom).toHaveBeenCalledTimes(2);
+        expect(setZoom).toHaveBeenCalledWith(2.0);
+        expect(setPan).not.toHaveBeenCalled();
+        expect(setZoomAndPan).not.toHaveBeenCalled();
+    });
+    test('only calls setPan when pan changes', () => {
+        const { rerender } = render(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], pan: { x: 10, y: 20 } }) }));
+        expect(setPan).toHaveBeenCalledTimes(1);
+        expect(setPan).toHaveBeenCalledWith(10, 20);
+        rerender(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], pan: { x: 10, y: 20 } }) }));
+        expect(setPan).toHaveBeenCalledTimes(1);
+        rerender(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], pan: { x: 30, y: 40 } }) }));
+        expect(setPan).toHaveBeenCalledTimes(2);
+        expect(setPan).toHaveBeenCalledWith(30, 40);
+        expect(setZoom).not.toHaveBeenCalled();
+        expect(setZoomAndPan).not.toHaveBeenCalled();
+    });
+    test('calls setZoomAndPan when both zoom and pan change', () => {
+        const { rerender } = render(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 1.5, pan: { x: 10, y: 20 } }) }));
+        expect(setZoomAndPan).toHaveBeenCalledTimes(1);
+        expect(setZoomAndPan).toHaveBeenCalledWith(1.5, 10, 20);
+        rerender(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 1.5, pan: { x: 10, y: 20 } }) }));
+        expect(setZoomAndPan).toHaveBeenCalledTimes(1);
+        rerender(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 2.0, pan: { x: 30, y: 40 } }) }));
+        expect(setZoomAndPan).toHaveBeenCalledTimes(2);
+        expect(setZoomAndPan).toHaveBeenCalledWith(2.0, 30, 40);
+        expect(setZoom).not.toHaveBeenCalled();
+        expect(setPan).not.toHaveBeenCalled();
+    });
+    test('calls appropriate methods when only zoom changes while both are set', () => {
+        const { rerender } = render(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 1.5, pan: { x: 10, y: 20 } }) }));
+        expect(setZoomAndPan).toHaveBeenCalledTimes(1);
+        rerender(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 2.0, pan: { x: 10, y: 20 } }) }));
+        expect(setZoom).toHaveBeenCalledTimes(1);
+        expect(setZoom).toHaveBeenCalledWith(2.0);
+        expect(setZoomAndPan).toHaveBeenCalledTimes(1);
+        expect(setPan).not.toHaveBeenCalled();
+    });
+    test('calls appropriate methods when only pan changes while both are set', () => {
+        const { rerender } = render(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 1.5, pan: { x: 10, y: 20 } }) }));
+        expect(setZoomAndPan).toHaveBeenCalledTimes(1);
+        rerender(_jsx("div", { children: _jsx(BasicNvlWrapper, { nodes: [], rels: [], zoom: 1.5, pan: { x: 30, y: 40 } }) }));
+        expect(setPan).toHaveBeenCalledTimes(1);
+        expect(setPan).toHaveBeenCalledWith(30, 40);
+        expect(setZoomAndPan).toHaveBeenCalledTimes(1);
+        expect(setZoom).not.toHaveBeenCalled();
+    });
 });

package/lib/basic-wrapper/BasicNvlWrapper.d.ts

@@ -45,4 +45,4 @@ export interface BasicReactWrapperProps {
  *
  * For examples, head to the {@link https://neo4j.com/docs/nvl/current/react-wrappers/#_basic_react_wrapper Basic React wrapper documentation page}.
  */
-export declare const BasicNvlWrapper: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Omit<BasicReactWrapperProps & HTMLProps<HTMLDivElement>, "ref"> & import("react").RefAttributes<Partial<Pick<NVL, "restart" | "destroy" | "addAndUpdateElementsInGraph" | "getSelectedNodes" | "getSelectedRelationships" | "removeNodesWithIds" | "removeRelationshipsWithIds" | "getNodes" | "getRelationships" | "getNodeById" | "getRelationshipById" | "getPositionById" | "getCurrentOptions" | "deselectAll" | "fit" | "resetZoom" | "setRenderer" | "setDisableWebGL" | "pinNode" | "unPinNode" | "setLayout" | "setLayoutOptions" | "getNodesOnScreen" | "getNodePositions" | "setNodePositions" | "isLayoutMoving" | "saveToFile" | "saveToSvg" | "getImageDataUrl" | "saveFullGraphToLargeFile" | "setZoom" | "getScale" | "getPan" | "getHits" | "getContainer">>>>>;
+export declare const BasicNvlWrapper: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Omit<BasicReactWrapperProps & HTMLProps<HTMLDivElement>, "ref"> & import("react").RefAttributes<Partial<Pick<NVL, "restart" | "destroy" | "addAndUpdateElementsInGraph" | "getSelectedNodes" | "getSelectedRelationships" | "removeNodesWithIds" | "removeRelationshipsWithIds" | "getNodes" | "getRelationships" | "getNodeById" | "getRelationshipById" | "getPositionById" | "getCurrentOptions" | "deselectAll" | "fit" | "resetZoom" | "setRenderer" | "setDisableWebGL" | "pinNode" | "unPinNode" | "setLayout" | "setLayoutOptions" | "getNodesOnScreen" | "getNodePositions" | "setNodePositions" | "isLayoutMoving" | "saveToFile" | "saveToSvg" | "getImageDataUrl" | "saveFullGraphToLargeFile" | "getZoomLimits" | "setZoom" | "getScale" | "getPan" | "getHits" | "getContainer">>>>>;

package/lib/basic-wrapper/BasicNvlWrapper.js

@@ -14,6 +14,8 @@ import { useDeepCompareEffect } from '../utils/hooks';
  */
 export const BasicNvlWrapper = memo(forwardRef(({ nodes, rels, layout, layoutOptions, nvlCallbacks = {}, nvlOptions = {}, positions = [], zoom, pan, onInitializationError, ...nvlEvents }, ref) => {
     const nvlRef = useRef(null);
+    const prevZoomRef = useRef(undefined);
+    const prevPanRef = useRef(undefined);
     useImperativeHandle(ref, () => {
         const nvlMethods = Object.getOwnPropertyNames(NVL.prototype);
         return nvlMethods.reduce((current, method) => ({
@@ -127,15 +129,21 @@ export const BasicNvlWrapper = memo(forwardRef(({ nodes, rels, layout, layoutOpt
         if (nvlRef.current === null) {
             return;
         }
-        if (zoom !== undefined && pan !== undefined) {
+        const currentZoom = prevZoomRef.current;
+        const currentPan = prevPanRef.current;
+        const zoomHasChanged = zoom !== undefined && zoom !== currentZoom;
+        const panHasChanged = pan !== undefined && (pan.x !== currentPan?.x || pan.y !== currentPan.y);
+        if (zoomHasChanged && panHasChanged) {
             nvlRef.current.setZoomAndPan(zoom, pan.x, pan.y);
         }
-        else if (zoom !== undefined) {
+        else if (zoomHasChanged) {
             nvlRef.current.setZoom(zoom);
         }
-        else if (pan !== undefined) {
+        else if (panHasChanged) {
             nvlRef.current.setPan(pan.x, pan.y);
         }
+        prevZoomRef.current = zoom;
+        prevPanRef.current = pan;
     }, [zoom, pan]);
     return _jsx("div", { id: BASIC_WRAPPER_ID, ref: containerRef, style: { height: '100%', outline: '0' }, ...nvlEvents });
 }));

package/lib/interactive-nvl-wrapper/InteractionHandlers.js

@@ -22,6 +22,7 @@ export const InteractionHandlers = ({ nvlRef, mouseEventCallbacks, interactionOp
     useInteraction(ClickInteraction, clickInteraction, mouseEventCallbacks.onCanvasRightClick, 'onCanvasRightClick', nvlRef, interactionOptions);
     useInteraction(PanInteraction, panInteraction, mouseEventCallbacks.onPan, 'onPan', nvlRef, interactionOptions);
     useInteraction(ZoomInteraction, zoomInteraction, mouseEventCallbacks.onZoom, 'onZoom', nvlRef, interactionOptions);
+    useInteraction(ZoomInteraction, zoomInteraction, mouseEventCallbacks.onZoomAndPan, 'onZoomAndPan', nvlRef, interactionOptions);
     useInteraction(DragNodeInteraction, dragNodeInteraction, mouseEventCallbacks.onDrag, 'onDrag', nvlRef, interactionOptions);
     useInteraction(DragNodeInteraction, dragNodeInteraction, mouseEventCallbacks.onDragStart, 'onDragStart', nvlRef, interactionOptions);
     useInteraction(DragNodeInteraction, dragNodeInteraction, mouseEventCallbacks.onDragEnd, 'onDragEnd', nvlRef, interactionOptions);

package/lib/interactive-nvl-wrapper/types.d.ts

@@ -1,4 +1,4 @@
-import type { BoxSelectInteraction, BoxSelectInteractionCallbacks, BoxSelectInteractionOptions, ClickInteraction, ClickInteractionCallbacks, ClickInteractionOptions, DragNodeInteraction, DragNodeInteractionCallbacks, DrawInteraction, DrawInteractionCallbacks, DrawInteractionOptions, HoverInteraction, HoverInteractionCallbacks, HoverInteractionOptions, LassoInteraction, LassoInteractionCallbacks, LassoInteractionOptions, PanInteraction, PanInteractionCallbacks, PanInteractionOptions, ZoomInteraction, ZoomInteractionCallbacks } from '@neo4j-nvl/interaction-handlers';
+import type { BoxSelectInteraction, BoxSelectInteractionCallbacks, BoxSelectInteractionOptions, ClickInteraction, ClickInteractionCallbacks, ClickInteractionOptions, DragNodeInteraction, DragNodeInteractionCallbacks, DrawInteraction, DrawInteractionCallbacks, DrawInteractionOptions, HoverInteraction, HoverInteractionCallbacks, HoverInteractionOptions, LassoInteraction, LassoInteractionCallbacks, LassoInteractionOptions, PanInteraction, PanInteractionCallbacks, PanInteractionOptions, ZoomInteraction, ZoomInteractionCallbacks, ZoomInteractionOptions } from '@neo4j-nvl/interaction-handlers';
 import type { BasicReactWrapperProps } from '../basic-wrapper/BasicNvlWrapper';
 export type MouseInteractionModule = typeof HoverInteraction | typeof ClickInteraction | typeof PanInteraction | typeof ZoomInteraction | typeof DragNodeInteraction | typeof DrawInteraction | typeof BoxSelectInteraction | typeof LassoInteraction;
 export type MouseInteraction = HoverInteraction | ClickInteraction | PanInteraction | ZoomInteraction | DragNodeInteraction | DrawInteraction | BoxSelectInteraction | LassoInteraction;
@@ -11,7 +11,7 @@ export type MouseEventCallbacks = ClickInteractionCallbacks & DragNodeInteractio
  * Collection of interaction options that can be used with
  * the {@link InteractiveNvlWrapper} component.
  */
-export type InteractionOptions = ClickInteractionOptions & BoxSelectInteractionOptions & HoverInteractionOptions & PanInteractionOptions & LassoInteractionOptions & DrawInteractionOptions;
+export type InteractionOptions = ClickInteractionOptions & BoxSelectInteractionOptions & HoverInteractionOptions & PanInteractionOptions & ZoomInteractionOptions & LassoInteractionOptions & DrawInteractionOptions;
 /**
  * The events that can be passed to the {@link MouseEventCallbacks} object
  * to turn on/off certain events for the {@link InteractiveNvlWrapper} component.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-nvl/react",
-  "version": "1.0.0-b6554465",
+  "version": "1.0.0-bb8a655f",
   "main": "lib/index.js",
   "homepage": "https://neo4j.com/docs/nvl/current/",
   "license": "SEE LICENSE IN 'LICENSE.txt'",
@@ -36,8 +36,8 @@
     "react-dom": "19.2.1"
   },
   "dependencies": {
-    "@neo4j-nvl/base": "1.0.0-b6554465",
-    "@neo4j-nvl/interaction-handlers": "1.0.0-b6554465",
+    "@neo4j-nvl/base": "1.0.0-bb8a655f",
+    "@neo4j-nvl/interaction-handlers": "1.0.0-bb8a655f",
     "lodash": "4.17.23"
   },
   "peerDependencies": {