gg-editor
Version:
A visual graph editor based on G6 and React
32 lines (23 loc) • 1.07 kB
Markdown
# RegisterEdge
To register an edge.
## Usage
> G6 [Custom Shape (Chinese)](https://antv.alipay.com/zh-cn/g6/1.x/tutorial/custom-shape.html) Tutorial
```jsx
import GGEditor, { Flow, RegisterEdge } from 'gg-editor';
<GGEditor>
<Flow />
<RegisterEdge name={...} config={...} extend={...} />
</GGEditor>
```
## API
| Property | Description | Type | Default |
| :--- | :--- | :--- | :--- |
| name | The name of a `edge`. | `string` | - |
| config | To configurate a edge. | `object` | - |
| extend | To extend a shape. | `string` | - |
## Built-in Edges
| Edge Name | Preview | Applicable Page |
| :--- | :--- | :--- |
| flow-polyline |  | Flow |
| flow-polyline-round |  | Flow |
| flow-smooth |  | Flow |