Updated Dashboard layout tool (markdown)

Nick O'Leary 2019-02-27 11:14:15 +00:00
parent 9e8912b9b7
commit 6760ae42ab
1 changed files with 1 additions and 31 deletions

@ -1,31 +1 @@
_**This is a work in progress.**_
# Description
User cannot visually design a layout of dashboard widgets. This layout tool will allow a user to deploy dashboard widgets by drag & drop.
There are several requirements that this layout tool should satisfy.
1. Change the order of widgets in a group by drag & drop.
2. Change the size of a widget.
3. Pad [`ui_spacer` widgets](https://github.com/node-red/node-red-dashboard/tree/spacedout) when blank spaces are needed.
4. Move a widget from one group to the another.
5. (optional) Change the size of a group.
# User interface
To show the layout tool of dashboard, Add `layout` button on the tab menu.
![dashboard sidebar](https://raw.githubusercontent.com/wiki/node-red-hitachi/node-red/images/layout_tool/dashboard_sidebar.png)
When a user clicks the `layout` button, the window of a layout tool will appear. It should look like the maximized window of function node.
After a user adjusts the layout on the window:
- If the user clicks `Done` button:
- inserts ui_spacer widget if necessary.
- updates the layout of sidebar and workspace.
- If the user clicks `Cancel` button, the change will be discarded.
![Layout tool](https://raw.githubusercontent.com/wiki/node-red-hitachi/node-red/images/layout_tool/Layout_tool_overview.png)
# Future discussion
- Add a node on the layout tool.
- Add/remove a group.
**Moved to https://github.com/node-red/designs/blob/master/designs/dashboard-layout-tool/dashboard-layout-tool.md**