Skip to content

Commit 4458bde

Browse files
authored
chore(graph-layers): Move react-graph-layers code into React example. (#155)
1 parent 25fdb09 commit 4458bde

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+135
-365
lines changed

docs/modules/graph-layers/api-reference/layouts/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Layouts
22

3-
Use one of the layouts provided by react-graph-layers. Right now react-graph-layers provides D3-Force and Simple layout for basic usage.
3+
Use one of the layouts provided by `@deck.gl-community/graph-layers`. Right now `@deck.gl-community/graph-layers` provides D3-Force and Simple layout for basic usage.
44

55
## SimpleLayout
66
Please see /docs/api-reference/simple-layout.

docs/modules/graph-layers/api-reference/layouts/custom-layout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Here's the method you will likely to implement when creating your own custom layout:
44

55
```js
6-
import {BaseLayout} from 'react-graph-layers';
6+
import {BaseLayout} from '@deck.gl-community/graph-layers';
77

88
export default class MyLayout extends BaseLayout {
99
// initialize the layout
@@ -184,7 +184,7 @@ getEdgePosition = (edge) => {
184184
### Full source code
185185

186186
```js
187-
import {BaseLayout} from 'react-graph-layers';
187+
import {BaseLayout} from '@deck.gl-community/graph-layers';
188188

189189
export default class RandomLayout extends BaseLayout {
190190
constructor(options) {

docs/modules/graph-layers/api-reference/layouts/d3-layout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
</p>
66

77

8-
This layout is an integration between [d3-force](https://github.com/d3/d3-force) and react-graph-layers to render the layout in a WebGL context.
8+
This layout is an integration between [d3-force](https://github.com/d3/d3-force) and graph-layers to render the layout in a WebGL context.
99

1010
## Configurations
1111

docs/modules/graph-layers/api-reference/layouts/simple-layout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img src="/gatsby/images/layouts/simple.png" height="400" />
55
</p>
66

7-
This example demonstrates how to render a pre-layout graph using react-graph-layers.
7+
This example demonstrates how to render a pre-layout graph using `@deck.gl-community/graph-layers`.
88
You can pre-compute the layout and have the position information in each node.
99
By simply specifying the `nodePositionAccessor` through constructor, you'll be able to render the graph right away.
1010

docs/modules/react-graph-layers/README.md renamed to docs/modules/graph-layers/wip/react-graph-layers/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The deck.gl-community repo is specifically set up to collect useful code that no
88
There is an ambition to phase out React specific code for deck.gl-community modules. This model is expected to be deprecated in the near future.
99
:::
1010

11-
react-graph-layers provides React components for visualizing large graphs with several utility functions.
11+
graph-layers provides React components for visualizing large graphs with several utility functions.
1212

13-
react-graph-layers can build a highly customizable graph visualization through its composable API. The rendering is powered by deck.gl which is a WebGL based visualization framework. With react-graph-layers, users are enabled to build various type of graph/network applications with minimum efforts while having the capability to extend the existing styles and layouts.
13+
graph-layers can build a highly customizable graph visualization through its composable API. The rendering is powered by deck.gl which is a WebGL based visualization framework. With graph-layers, users are enabled to build various type of graph/network applications with minimum efforts while having the capability to extend the existing styles and layouts.
1414

docs/modules/react-graph-layers/api-reference/graphgl.md renamed to docs/modules/graph-layers/wip/react-graph-layers/api-reference/graphgl.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
### Usage
88

99
```js
10-
import GraphGL, {JSONLoader, NODE_TYPE, D3ForceLayout} from 'react-graph-layers';
10+
import GraphGL, {JSONLoader, NODE_TYPE, D3ForceLayout} from '@deck.gl-community/graph-layers';
1111

1212
const App = ({data}) => {
1313
const graph = JSONLoader({
@@ -60,13 +60,13 @@ const data = {
6060
Then, you can convert the data into `Graph` by `JSONLoader`:
6161

6262
```js
63-
import {JSONLoader} from 'react-graph-layers';
63+
import {JSONLoader} from '@deck.gl-community/graph-layers';
6464
const graph = JSONLoader({json: data});
6565
```
6666

6767
### `layout` (Layout, required)
6868

69-
Use one of the layouts provided by react-graph-layers or create a new custom layout class by following the instruction. For more detail, please see the Layout docs/api-reference/layout section.
69+
Use one of the layouts provided by @deck.gl-community/graph-layers or create a new custom layout class by following the instruction. For more detail, please see the Layout docs/api-reference/layout section.
7070

7171
### `initialViewState` (Object, optional)
7272

docs/modules/react-graph-layers/developer-guide/get-started.md renamed to docs/modules/graph-layers/wip/react-graph-layers/developer-guide/get-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# react-graph-layers
1+
# graph-layers
22

33
<p align="center">
44
<img src="https://i.imgur.com/BF9aOEu.png" height="400" />
55
</p>
66

77
## Abstract
8-
react-graph-layers is a React component for visualizing large graphs with several utility functions. It can build a highly customizable graph visualization through its composable API. The rendering is powered by deck.gl which is a WebGL based visualization framework. With react-graph-layers, users are enabled to build various type of graph/network applications with minimum efforts while having the capability to extend the existing styles and layouts.
8+
graph-layers is a React component for visualizing large graphs with several utility functions. It can build a highly customizable graph visualization through its composable API. The rendering is powered by deck.gl which is a WebGL based visualization framework. With graph-layers, users are enabled to build various type of graph/network applications with minimum efforts while having the capability to extend the existing styles and layouts.
99

1010
## Motivation
1111
Uber originally started this project as Graph.gl. After stopping efforts on Graph.gl, the OpenJS Foundation has resumed efforts.
1212

13-
With react-graph-layers, developers are allowed to create graph visualization with minimum efforts while having the capability to override anything they want in the library.
13+
With graph-layers, developers are allowed to create graph visualization with minimum efforts while having the capability to override anything they want in the library.
1414

1515
## Roadmap
1616

@@ -22,7 +22,7 @@ import GraphGL, {
2222
JSONLoader,
2323
NODE_TYPE,
2424
D3ForceLayout
25-
} from 'react-deck-graph-layers';
25+
} from 'deck-graph-layers';
2626

2727
const App = ({data}) => {
2828
const graph = JSONLoader({
@@ -63,7 +63,7 @@ const App = ({data}) => {
6363
#### Clone the repo:
6464

6565
```
66-
git clone git@github.com:deck.gl-community/react-graph-layers.git
66+
git clone git@github.com:deck.gl-community/graph-layers.git
6767
```
6868
6969
#### Install yarn

0 commit comments

Comments
 (0)