Skip to content

Update README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 54 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@

[![dhtmlx.com](https://img.shields.io/badge/made%20by-DHTMLX-blue)](https://dhtmlx.com/)

[How to start](#how-to-start) | [Key features](#key-features) | [License](#license) | [Useful links](#links) | [Other examples](#examples) | [Join our online community](#join)

![DHTMLX Diagram with Vue Demo](diagram_editor.png)

The DHTMLX [JavaScript Diagram library](https://dhtmlx.com/docs/products/dhtmlxDiagram/) allows developers to create interactive, customizable diagrams such as flowcharts, organizational charts, network diagrams, mind maps, etc. It simplifies complex data visualization by organizing it into a clear hierarchical structure using automatic layouts and live editors.

<a name="how-to-start"></a>
## How to start

Clone the repository or download files.
Expand All @@ -22,17 +27,60 @@ npm run start

You can also use [GitHub Codespaces](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository) to run online.

## Useful links
<a name="key-features"></a>
## DHTMLX Diagram key features

- Live Diagram, Org chart, and Mindmap editors for a quick diagram arrangement
- Orthogonal and Radial auto layout modes
- Adding partner and assistant shapes
- Searching and filtering

[![diagram-shape-searching](https://dhtmlx.com/blog/wp-content/uploads/2024/05/image8-1.gif)](https://snippet.dhtmlx.com/846cz71r?tag=diagram_editor&mode=wide)

- Creating swimlanes and groups
- Expanding and collapsing branches
- Creating custom shapes

[![diagram-custom-shapes](https://dhtmlx.com/blog/wp-content/uploads/2024/05/image12.jpg)](https://snippet.dhtmlx.com/plqsq611?tag=diagram_editor&mode=wide)

- Group work with multiple objects (select, copy, move, delete)
- Intuitive drag-n-drop behavior
- Snap lines
- Configurable Toolbar, Shapebar, and Editbar elements

- **[Online demo](https://replit.com/@dhtmlx/dhtmlx-diagram-with-vue)**
[![diagram-configurable toolbar](https://dhtmlx.com/blog/wp-content/uploads/2024/05/Toolbar-menu.gif)](https://snippet.dhtmlx.com/1qh2r0ub?tag=diagram_editor&mode=wide)

- Built-in themes
- Inline editing
- Touch support
- Keyboard navigation
- Cross-browser support
- Export to PDF and PNG

<a name="license"></a>
## License ##
This demo is available under the Evaluation license. To use it in your projects, please choose a proper license on the DHTMLX website: [https://dhtmlx.com/docs/products/licenses.shtml](https://dhtmlx.com/docs/products/licenses.shtml)

<a name="links"></a>
## Useful links
- [More demos about the DHTMLX Diagram functionality](https://snippet.dhtmlx.com/a9t2z2dt?tag=diagram&mode=wide)
- [Technical support ](https://forum.dhtmlx.com/c/diagram)
- [Online documentation](https://docs.dhtmlx.com/diagram/)

## Follow us
<a name="examples"></a>
## Other examples

Check out examples of using DHTMLX Diagram with other technologies:

| JavaScript | Angular | React |
| ----- | ----- | ----- |
| [![javascript](https://dhtmlx.com/images/common/technologies/js.svg)](https://dhtmlx.com/docs/products/dhtmlxDiagram/) | [![angular](https://dhtmlx.com/images/common/technologies/angular.svg)](https://github.com/DHTMLX/angular-diagram-demo) | [![react](https://dhtmlx.com/images/common/technologies/react.svg)](https://github.com/DHTMLX/react-diagram-demo/) |

<a name="join"></a>
## Join our online community

- Star our GitHub repo :star:
- Watch our tutorials on [YouTube](https://www.youtube.com/user/dhtmlx/videos) :eyes:
- Watch our tutorials on [YouTube](https://www.youtube.com/user/dhtmlx/videos) :tv:
- Read us on [Medium](https://dhtmlx.medium.com) :newspaper:
- Follow us on [Twitter](https://twitter.com/dhtmlx) :feet:
- Like our page on [Facebook](https://www.facebook.com/dhtmlx/) :thumbsup:
- Follow us on [X](https://x.com/dhtmlx) :bird:
- Check our news and updates on [Facebook](https://www.facebook.com/dhtmlx/) :feet: