|
| 1 | +[](https://travis-ci.org/JelteMX/mendix-tree-view) |
| 2 | +[](https://coveralls.io/github/JelteMX/mendix-tree-view?branch=master) |
| 3 | +[]([https://david-dm.org/JelteMX/mendix-tree-view](https://david-dm.org/JelteMX/mendix-tree-view)) |
| 4 | +[]([https://david-dm.org/JelteMX/mendix-tree-view?type=dev](https://david-dm.org/JelteMX/mendix-tree-view?type=dev)) |
| 5 | +[-orange.svg)](https://docs.mendix.com/developerportal/app-store/app-store-content-support) |
| 6 | +[](https://appstore.home.mendix.com/link/modeler/) |
| 7 | +[](https://github.com/JelteMX/mendix-tree-view/releases/latest) |
| 8 | +[](https://github.com/JelteMX/mendix-tree-view/issues) |
| 9 | + |
| 10 | +# Tree View for Mendix |
| 11 | + |
| 12 | +Mendix Tree View widget using [Ant Design Table](https://ant.design/components/table/) (MIT License). |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | +Show a Tree structure in your Mendix project |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +> See test-project [https://treeview-react-sandbox.mxapps.io/](https://treeview-react-sandbox.mxapps.io/) for a live demo! |
| 21 | +
|
| 22 | +> Missing features? See TODO at the bottom to see which items are still on the TODO list. If you find other bugs, please report this as an issue [here](https://github.com/JelteMX/mendix-tree-table/issues) |
| 23 | +
|
| 24 | +## Features |
| 25 | + |
| 26 | +- Display a tree structure in a tree view |
| 27 | +- Data Sources: XPath, Microflow, Nanoflow |
| 28 | +- Load a complete tree structure |
| 29 | +- Two patterns: Node-Parent or Node-Children |
| 30 | +- Load children over reference, xpath or nanoflow |
| 31 | +- On Click events |
| 32 | +- Drag & Drop (Node-Parent) |
| 33 | +- **Experimental** Client side search (Only on loading a complete tree) |
| 34 | + |
| 35 | +> This widget is about 300Kb uncompressed, so in your cloud deployment this widget should take about 83 Kb of network resources |
| 36 | +
|
| 37 | +Tested: |
| 38 | + |
| 39 | +- IE11 & Edge |
| 40 | +- Chrome |
| 41 | +- Firefox |
| 42 | +- Safari |
| 43 | + |
| 44 | +## Basic Configuration |
| 45 | + |
| 46 | +### 1. Data Source |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | +### 2. Data |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | +- You can choose to load a complete tree, or partial |
| 55 | +- The rest of the settings are self-explanatory |
| 56 | + |
| 57 | +### 3. Relation |
| 58 | + |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +### 4. UI |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +### 5. Drag & Drop |
| 67 | + |
| 68 | + |
| 69 | + |
| 70 | +- Drag & Drop is only enabled for objects with a parent relation |
| 71 | +- The widget will do the changes on the object by itself |
| 72 | + |
| 73 | +### 6. Experimental - Search |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | +- This feature is highly experimental and might be subject to change in future releases |
| 78 | +- It requires another helper entity, which will be used in calling a Nanoflow |
| 79 | +- The helper entity has a reference set of all the objects that are loaded, and the search query. It is up to you to create a Nanoflow that returns a list of objects to be shown (act as a filter) |
| 80 | + |
| 81 | +### 7. Events |
| 82 | + |
| 83 | + |
| 84 | + |
| 85 | +## Demo project |
| 86 | + |
| 87 | +[https://treeview-react-sandbox.mxapps.io/](https://treeview-react-sandbox.mxapps.io/) |
| 88 | + |
| 89 | +### Domain model |
| 90 | + |
| 91 | + |
| 92 | + |
| 93 | +- This is an example of the domain model used in our test-project |
| 94 | +- **Note: Only use one type of relation! Either Node-Parent or Node-Children!** This domain model features both, as cwe reate two types of sets of nodes to show all capabilities |
| 95 | + |
| 96 | +## Issues, suggestions and feature requests |
| 97 | + |
| 98 | +Please report your issues [here](https://github.com/JelteMX/mendix-tree-view/issues) |
| 99 | + |
| 100 | +## Development and contribution |
| 101 | +[specify contribute] |
| 102 | + |
| 103 | +## TODO |
| 104 | + |
| 105 | +These are action items on the list for future releases |
| 106 | + |
| 107 | +- WebModeler preview |
| 108 | +- Draggable NodeChildren |
| 109 | +- On DragChange mf/nf |
| 110 | +- Selectable? Version 2.0 |
| 111 | +- Automated unit tests & CI/CD pipeline |
| 112 | + |
| 113 | +## License |
| 114 | + |
| 115 | +Apache 2 |
0 commit comments