diff --git a/frontend.dashboard.md b/frontend.dashboard.md new file mode 100644 index 0000000..9bdba16 --- /dev/null +++ b/frontend.dashboard.md @@ -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" +} +``` \ No newline at end of file