Created frontend.site (markdown)

ni-richard 2019-09-13 23:33:07 +02:00
parent 478f0ca672
commit 9fbb3be53b

25
frontend.site.md Normal file

@ -0,0 +1,25 @@
* **Description**: Configures the site's main properties.
* **Subscribers**: *(none)*
```json
{
"key": "frontend.site",
"scope": "websocket"
}
```
| Parameter | Type | Required | Description |
| ------------ |:--------:|:------------------:| --------------------------- |
| *askReloadSite* | `boolean` | | When the user tries to reload the page, this will prompt a confirmation dialog. It can be really useful, since the frontend serves as a single-page application. |
| *documentTitle* | `string` | | Provides title for the browser tab. |
***
**Example**:
```json
{
"key": "frontend.site",
"scope": "websocket",
"documentTitle": "My first tutorial"
}
```