OpenSource/homepage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated docs to reflect changes

Browse Source
This commit is contained in:
sgrtye 2024-02-14 20:32:31 +00:00
parent 946253a902
commit ccd1b64426
1 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/widgets/services/customapi.md
View File

@ -44,6 +44,15 @@ widget:
locale: nl # optional locale: nl # optional
style: short # optional - defaults to "long". Allowed values: `["long", "short", "narrow"]`. style: short # optional - defaults to "long". Allowed values: `["long", "short", "narrow"]`.
numeric: auto # optional - defaults to "always". Allowed values `["always", "auto"]`. numeric: auto # optional - defaults to "always". Allowed values `["always", "auto"]`.
- field: key
label: Field 6
format: text
additionalField: # optional
field:
hourly:
time: other key
color: theme # optional - defaults to "". Allowed values: `["theme", "adaptive", "black", "white"]`.
format: date # optional
``` ```
Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes`, `bitrate`, `date` and `relativeDate`. Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes`, `bitrate`, `date` and `relativeDate`.
@ -120,22 +129,22 @@ You can change the default block view to a list view (similar to the Coin Market
The list view utilizes extra space to display an additional field (which is optional) and to apply color to this additional field (also optional). The list view utilizes extra space to display an additional field (which is optional) and to apply color to this additional field (also optional).
`additionalField`: Similar to the `field` option, but only used for the list view. It displays additional information for the mapping object on the right side of the `field`. `additionalField`: Similar to `field`, but only used in the list view. It displays additional information for the mapping object on the right.
`additionalFieldColor`: Also list view only feature, it is used to color the additional field. `field`: Defined the key with the desired value for the additional information.
Allowed options: `["auto", "theme", "black", "white"]`. `color`: Define a color scheme to the additional information for customization and/or distinction.
`auto` will use the color based on the value of the `additionalField`, green for positive numbers, red for negative numbers. Allowed options: `["theme", "adaptive", "black", "white"]`. Other values will be ignored.
**Note:** Data transformation is still compatible with the list view, but the transformation only applies to the value of the `field`. `adaptive` will use the color based on the value of the `additionalField`, green for positive numbers, red for negative numbers.
**Note:** Data transformation remains compatible with the list view. However, the transformation for `additionalField` is now nested under `additionalField`. See the example below for clarification.
```yaml ```yaml
- field: key - field: key
label: Field label: Field
format: text format: text
additionalField: another key # optional
additionalFieldColor: auto # optional
remap: remap:
- value: 0 - value: 0
to: None to: None
@ -143,6 +152,12 @@ Allowed options: `["auto", "theme", "black", "white"]`.
to: Connected to: Connected
- any: true # will map all other values - any: true # will map all other values
to: Unknown to: Unknown
additionalField:
field:
hourly:
time: key
color: theme
format: date
``` ```
## Custom Headers ## Custom Headers