From 478f0ca67231bd2456a0fc2fe59bb50d8078bc28 Mon Sep 17 00:00:00 2001 From: ni-richard Date: Fri, 13 Sep 2019 23:02:20 +0200 Subject: [PATCH] Created frontend.ide (markdown) --- frontend.ide.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 frontend.ide.md diff --git a/frontend.ide.md b/frontend.ide.md new file mode 100644 index 0000000..ce24ade --- /dev/null +++ b/frontend.ide.md @@ -0,0 +1,26 @@ +* **Description**: Configures the IDE component on the frontend. +* **Subscribers**: *(none)* + +```json +{ + "key": "frontend.ide", + "scope": "websocket" +} +``` + +| Parameter | Type | Required | Description | +| ------------ |:--------:|:------------------:| --------------------------- | +| *autoSaveInterval* | `number` | | Saves the currently edited file at every *n* seconds automatically. | +| *showDeployButton* | `boolean` | | Displays the deploy button in the upper right corner of the IDE. | +| *deployButtonText* | `object` | | Customizes the status messages of the deploy button. It expects key-value pairs, where the possible keys are: `TODEPLOY`, `DEPLOYED`, `DEPLOYING`, `FAILED`. **Important**: You have set all of them, otherwise you will see empty buttons in the undefined states. | + +*** + +**Example**: +```json +{ + "key": "frontend.ide", + "scope": "websocket", + "showDeployButton": true +} +``` \ No newline at end of file