X6 is a graph editing engine based on HTML and SVG, offering low-cost customization capabilities and out-of-the-box built-in extensions, making it easy for us to quickly build applications such as DAG diagrams, ER diagrams, flowcharts, and lineage graphs.

If you haven't used X6 yet, we recommend experiencing its charm through the Getting Started Guide.

✨ Features

• 🌱 Highly Customizable: Supports customizing node styles and interactions using SVG/HTML/React/Vue.
• 🚀 Ready to Use: Comes with 10+ built-in graph editing extensions, such as selection, alignment lines, mini-map, etc.
• 🧲 Data-Driven: Based on MVC architecture, allowing users to focus more on data logic and business logic.
• 💯 Event-Driven: Can listen to any events occurring within the graph.

🍉 Documentation

• Getting Started
• Basics
• Advanced
• Plugins
• API

The X6 documentation is divided into two parts: documentation and API. It is recommended to read the documentation carefully, as it will help you get started with development. The API documentation is extensive, so you can refer to it when you encounter issues by searching for the relevant documents.

❤️ How to Communicate

If you have any questions, suggestions, feedback, or wish to communicate, you can contact us through the following methods:

• Official Recommendation: GitHub issues
• Email: antv@antfin.com
• Yuque Column: https://www.yuque.com/antv/blog

🤝 Contributing

Bugs

If you encounter any issues while using, please check issues to see if there are similar bugs or suggestions. Before reporting a bug, please ensure you have searched existing issues and read our FAQ.

Code of Conduct

We have a Code of Conduct that we hope all contributors will adhere to. Please take the time to read it to understand what is acceptable and what is not.

Join the Community

You can also refer to the contribution guidelines below to become a contributor to X6 step by step:

• How to Participate in X6 Open Source Development
• How to Contribute Code Elegantly on GitHub