English | [简体中文](README.zh-CN.md)

# CyEditor

A visual flow chart editor based on [cytoscape.js](https://github.com/cytoscape/cytoscape.js).

## Demo

[Demo](https://demonray.github.io/cyeditor/)

## Installation

### npm

```sh
npm install cyeditor
```

### umd

```html
<script src="https://cdn.jsdelivr.net/npm/cyeditor@${version}/dist/cyeditor.umd.min.js"></script>
```

### run demo

```sh
$ git clone https://github.com/demonray/cyeditor.git
$ cd cyeditor
$ npm install
$ npm run serve
```

## Usage

### Vue

```jsx
todo
```
## Documentation

* You can find the documentation on the [Github Pages](https://demonray.github.io/guide/)

### feature 

- [x] Navigator provides previews for easy viewing
- [x] grid lines
- [x] built-in shape and support for custom shapes
- [x] configurable toolbar for common operations
- [x] node size control and node information editing
- [x] Support for custom right-click menu
- [x] Support flow chart export to image, export json data
- [ ] More edge type support, dotted line
- [ ] Element information popper