@neo4j-nvl/base 0.3.3 → 0.3.4-34f121d2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +8 -7
  2. package/dist/base.mjs +1 -1
  3. package/dist/types/index.d.ts +30 -49
  4. package/dist/types/layouts/forcedirectedlayout/cosebilkentlayout/CoseBilkentLayout.d.ts +2 -1
  5. package/dist/types/layouts/hierarchicallayout/HierarchicalLayout.d.ts +1 -0
  6. package/dist/types/modules/CallbackHelper.d.ts +1 -1
  7. package/dist/types/modules/state.d.ts +4 -5
  8. package/dist/types/types/graph-element.d.ts +10 -10
  9. package/dist/types/utils/canvasManagement.d.ts +1 -1
  10. package/dist/types/utils/geometry.d.ts +5 -5
  11. package/package.json +4 -9
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Neo4j Visualization Library
2
2
 
3
- Welcome to NVL (Neo4j Visualization Library). NVL is a collection of libraries that can be used to build custom graph visualizations like [Neo4j Bloom](https://neo4j.com/product/bloom/). The NVL library is also available as a React component that can be used in React applications.
3
+ 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 and Explore(powered by 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.
4
4
 
5
5
  ## Consuming the library
6
6
 
@@ -12,18 +12,14 @@ You can install the library with your preferred package manager, for example
12
12
  npm install @neo4j-nvl/base
13
13
  ```
14
14
 
15
- If you want to add common interactivity to the graph, install the NVL interaction handlers. If you are planning to use NVL in a React app, be sure to check out the NVL React wrappers.
15
+ 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).
16
16
 
17
17
  ### Using the library
18
18
 
19
19
  This is a basic setup for a NVL instance.
20
20
 
21
21
  ```js
22
- const nodes = [
23
- { id: '1', label: 'Node 1', color: '#e04141' },
24
- { id: '2', label: 'Node 2', color: '#e09c41' }
25
- ]
26
-
22
+ const nodes = [{ id: '1' }, { id: '2' }]
27
23
  const relationships = [{ id: '12', from: '1', to: '2' }]
28
24
 
29
25
  const options = {
@@ -43,3 +39,8 @@ You can find more instructions and examples on how to use NVL in the [docs](http
43
39
  ### Product analytics
44
40
 
45
41
  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`.
42
+
43
+ ## Further Resources
44
+
45
+ - NVL documentation: https://neo4j.com/docs/nvl/current/
46
+ - NVL API docs: https://neo4j.com/docs/api/nvl/current/