# QuickQanava

![Build linux master](https://github.com/cneben/QuickQanava/actions/workflows/build-linux-master.yml/badge.svg) ![Build linux develop](https://github.com/cneben/QuickQanava/actions/workflows/build-linux-develop.yml/badge.svg)
![Build win64 master](https://github.com/cneben/QuickQanava/actions/workflows/build-win64-master.yml/badge.svg) ![Build win64 develop](https://github.com/cneben/QuickQanava/actions/workflows/build-win64-develop.yml/badge.svg)

[![Documentation](https://img.shields.io/badge/docs-doxygen-blue.svg)](http://cneben.github.io/QuickQanava/)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
![](https://img.shields.io/badge/version-1.0.0-blue.svg)
[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/fold_left.svg?style=social&label=Follow%20%40QuickQanava)](https://twitter.com/QuickQanava)

![](https://github.com/cneben/QuickQanava/blob/master/doc/web/docs/images/home.png)

`QuickQanava` is a C++14 library designed to display graphs and relational content in a Qt/QML application. QuickQanava provide QML components and C++ classes to visualize medium-sized directed graphs in a C++/QML application. QuickQanava focus on displaying relational content into a dynamic user interface with DnD support, resizable content and visual creation of topology. More advanced layouts algorithms might be integrated in future versions.

QuickQanava main repository is hosted on GitHub: http://cneben.github.io/QuickQanava/index.html

QuickQanava is primarily developed for Linux with Qt 5.15 with MSVC2017 and g++7.5 (minimal required Qt version is **Qt 5.10**, recommended is **Qt 5.15.2**)

+ [CHANGELOG.md](CHANGELOG.md)
+ Project homepage: http://cneben.github.io/QuickQanava/index.html

+ [Building](./doc/BUILDING.md)

+ [Installation](http://cneben.github.io/QuickQanava/installation.html)
+ [Graph Data Model](http://cneben.github.io/QuickQanava/graph.html#data-model)
  + [Ports and Docks](http://cneben.github.io/QuickQanava/nodes.html#docks-and-ports)
  + [Visual node connection](http://cneben.github.io/QuickQanava/edges.html#visual-creation-of-edges)
  + [Selection](http://cneben.github.io/QuickQanava/nodes.html#selection)
  + [Groups](http://cneben.github.io/QuickQanava/nodes.html#grouping-nodes)
+ [Styling](http://cneben.github.io/QuickQanava/styles.html)
+ [Advanced use, custom topology](http://cneben.github.io/QuickQanava/advanced.html)


For any questions, please contact: benoit@destrat.io

QuickQanava focus on writing content delegates in QML (even if they could be 100% defined in C++, a QML engine is still necessary in the background).

## QuickQanava Showcase

**Edges:**

![Curved-Straight Edges](https://github.com/cneben/QuickQanava/blob/master/doc/web/docs/images/edges-curved-straight.gif)

**Nodes:** User Doc:  [QuickStart - Custom Nodes](http://cneben.github.io/QuickQanava/nodes.html#defining-custom-nodes)

![Custom content](https://github.com/cneben/QuickQanava/blob/master/doc/web/docs/images/sample-nodes.gif)

**Visual Connector:** User Doc:  [QuickStart - Visual Connector](http://cneben.github.io/QuickQanava/edges.html#visual-connectors)

![Visual Connector](https://github.com/cneben/QuickQanava/blob/master/doc/web/docs/images/sample-dataflow-short.gif)

**Groups:** User Doc:  [QuickStart - Using Groups](http://cneben.github.io/QuickQanava/nodes.html#grouping-nodes)

![Groups](https://github.com/cneben/QuickQanava/blob/master/doc/web/docs/nodes/sample-groups.gif)

**Styles:** User Doc:  [QuickStart - Using Styles](http://cneben.github.io/QuickQanava/styles.html)

![Custom styles](https://github.com/cneben/QuickQanava/blob/master/doc/web/docs/images/sample-styles.gif)

## Contributors

![GitHub Contributors Image](https://contrib.rocks/image?repo=cneben/QuickQanava)

 - @kwallner / Conan.io and CMake configuration
 - @Letrab / Edge configuration
 - @machinekoder / QML plugin and CMake configuration
 - @NielsBillen / Ports support and stability fixes
 - @walterbrebels
 - @chesnoksatan / Major connector feature, build configuration

## License

[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

Copyright (c) 2017-2020 BA