mrtoth/frontend-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/frontend-tutorial-framework synced 2024-12-05 02:01:32 +00:00
Code Issues Releases Wiki Activity

Write even more documentation

Browse Source
This commit is contained in:
Kristóf Tóth 2018-04-23 18:54:09 +02:00
parent 6f93869dc0
commit 24636c07d1
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -69,6 +69,25 @@ The message format used:
You can use the `MessageSender` class to send messages from the TFW server or event handlers written in Python.
### Web
### Web – customisable component
in progress...
... explain iframing and custom Angular components...
### Dashboard
The dashboard is the component that composes all others and organises them into layouts.
It also exposes a frontend API to dynamically change layouts any time using a message format as such:
```
{
"key": "dashboard",
"data":
{
"command": "layout",
"layout": ...,
"hide_messages": ...
}
}
```
You can use the `hide_messages` key to hide the message component (sadly it currently still takes up the space it would occupy).