mrtoth/baseimage-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/baseimage-tutorial-framework synced 2024-11-22 12:51:32 +00:00
Code Issues Releases Wiki Activity

Created frontend.dashboard (markdown)

ni-richard 2019-09-12 18:01:45 +02:00
parent 79b29b6d66
commit f160464ba1
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
frontend.dashboard.md Normal file

@ -0,0 +1,30 @@
* **Description**: Configures the dashboard component on the frontend.
* **Subscribers**: *(none)*
```json
{
"key": "frontend.dashboard",
"scope": "websocket"
}
```
| Parameter | Type | Required | Description |
| ------------ |:--------:|:------------------:| --------------------------- |
| *layout* | `string` | | Default layout on challenge startup. See *enabledLayouts* for available options. |
| *hideMessages* | `boolean` | | Hides bot messages when `true`. |
| *iframeUrl* | `string` | | The URL of the web service, make it empty when there is none. |
| *showUrlBar* | `boolean` | | Displays an additional URL bar to manipulate the web service. |
| *terminalMenuItem* | `string` | | Selected tab on the terminal component: `"terminal"` or `"console"`. |
| *enabledLayouts* | `array` | | List of layouts on the right side of the page: `terminal-ide-web`, `terminal-ide-vertical`, `terminal-web`, `ide-web-vertical`, `terminal-ide-horizontal`, `terminal-only`, `ide-only`, `web-only`. |
***
**Example**:
```json
{
"key": "frontend.dashboard",
"scope": "websocket",
"layout": "terminal-web",
"terminalMenuItem": "console"
}
```