Bookmark status page documentation

This commit is contained in:
dvdandroid 2024-08-04 23:01:15 +02:00
parent 58ffe6e55f
commit 88452c0ae3
2 changed files with 44 additions and 7 deletions

View File

@ -1192,13 +1192,15 @@ To make the widget scale appropriately in a `full` size column, set the style to
| links | array | yes | |
###### Properties for each link
| Name | Type | Required | Default |
| ---- | ---- | -------- | ------- |
| title | string | yes | |
| url | string | yes | |
| icon | string | no | |
| same-tab | boolean | no | false |
| hide-arrow | boolean | no | false |
| Name | Type | Required | Default |
|-----------------|---------| -------- |---------|
| title | string | yes | |
| url | string | yes | |
| icon | string | no | |
| same-tab | boolean | no | false |
| hide-arrow | boolean | no | false |
| status-page.url | string | no | |
| status-page.show-if-operational | boolean | no | false |
`icon`
@ -1222,6 +1224,41 @@ Whether to open the link in the same tab or a new one.
Whether to hide the colored arrow on each link.
`status-page`
Display a status indicator for the link. The status is determined by the response of the status page API.
```yaml
- type: bookmarks
groups:
- links:
- title: Github
url: https://github.com/
status-page:
url: https://www.githubstatus.com/
show-if-operational: true
- title: Reddit
url: https://www.reddit.com/
status-page:
url: https://www.redditstatus.com/
show-if-operational: false
```
![](images/bookmarks-statuspages.png)
> [!NOTE]
>
> From the screenshot above, Github results operational and indicator is marked to be visibile, Reddit is operational but the indicator is hidden.
> Site 1 has major issues and is marked Site 2 has minor issues.
`status-page.url`
URL pointing to a status page for the link. Supported status page is [Statuspage](https://www.statuspage.io/).
`status-page.show-if-operational`
Whether to show the indicator if the API reports that the site is operational. If set to `false` the indicator will be hidden if the service is operational.
### ChangeDetection.io
Display a list watches from changedetection.io.

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB