Skip to content

Commit d46e7c5

Browse files
committed
tslib as dependency (not peer)
1 parent 50bd1ed commit d46e7c5

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# React Sigma v2 [![CI](https://github.com/sim51/react-sigma-v2/actions/workflows/test.yml/badge.svg)](https://github.com/sim51/react-sigma-v2/actions/workflows/test.yml)
22

33
A set of react components to display graphs with Sigma v2.
4-
This project is in beta test.
54

65
You can find some online examples here : https://sim51.github.io/react-sigma-v2/examples/
76

7+
Or test it on cocdesanbox with this link: https://githubbox.com/sim51/react-sigma-v2/tree/main/demo
8+
89
## Philosophy
910

1011
This library shares the same philosophy as [react-leaflet](https://react-leaflet.js.org), it just provides some bindings (and helpers) between React and Sigma.
1112

1213
The main component, ie. `SigmaContainer` create a Sigma instance with an empty graph. If its option `initialSettings` or `graphOptions` is updated, the instance is killed and re-created.
1314

1415
I recommend you to NOT UPDATE those options to avoid performance issues.
15-
Sigma (& graphology) comes with methods that allow the user to update the settings.
16+
Sigma (& graphology) comes with methods that allow users to update the settings.
17+
You should treat it as an immutable component.
1618

1719
Every child has access to the sigma instance (and so the graph instance) via the React context created by the `SigmaContainer`.
1820

@@ -47,7 +49,7 @@ ReactDOM.render(
4749
You need to install this library and its peer dependencies :
4850

4951
```bash
50-
$> npm install tslib sigma graphology graphology-layout-forceatlas2 react-sigma-v2
52+
$> npm install sigma graphology graphology-layout-forceatlas2 react-sigma-v2
5153
```
5254

5355
## How to use it

demo/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
"react-scripts": "4.0.3",
1919
"react-sigma-v2": "latest",
2020
"sigma": "latest",
21-
"tslib": "2.3.1",
2221
"typescript": "^4.4.4",
2322
"web-vitals": "^1.1.2"
2423
},

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@
100100
"graphology-layout-forceatlas2": ">=0.6.0",
101101
"react": "^17.0.0",
102102
"react-dom": "^17.0.0",
103-
"sigma": "^2.0.0",
104-
"tslib": "^2.3.1"
103+
"sigma": "^2.0.0"
105104
},
106105
"dependencies": {
107-
"lodash": "^4.17.21"
106+
"lodash": "^4.17.21",
107+
"tslib": "^2.3.1"
108108
}
109109
}

0 commit comments

Comments
 (0)