flan/advanced-camera-card
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bump prettier to v3 and format all files

Browse Source
This commit is contained in:
Felipe Santos
2024-06-10 00:29:50 -03:00
parent 2a637d92b9
commit fccb4c9afd
138 changed files with 6445 additions and 1678 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/configuration/overrides.md
+32 -57
View File
@@ -15,12 +15,12 @@ overrides:
The top-level `overrides` configuration block expects a list, with each list
item containing `conditions` and at least one of `merge`, `delete` or `set` specified.
| Option | Default | Description |
| - | - | - |
| `conditions` | | A list of [conditions](conditions.md) that must evaluate to `true` in order for the overrides to be applied. |
| `delete` | | An array of configuration paths to delete. See below. |
| `merge` | | A dictionary of configuration paths to merge. See below. |
| `set` | | A dictionary of configuration paths to set. See below. |
| Option | Default | Description |
| ------------ | ------- | ------------------------------------------------------------------------------------------------------------ |
| `conditions` | | A list of [conditions](conditions.md) that must evaluate to `true` in order for the overrides to be applied. |
| `delete` | | An array of configuration paths to delete. See below. |
| `merge` | | A dictionary of configuration paths to merge. See below. |
| `set` | | A dictionary of configuration paths to set. See below. |
## Configuration Paths
@@ -42,11 +42,10 @@ An array of configuration paths to delete.
```yaml
overrides:
- conditions:
[condition]
- conditions: [condition]
delete:
- [path_1]
- [path_2]
- [path_1]
- [path_2]
```
### Examples
@@ -55,29 +54,25 @@ Delete the 2nd camera:
```yaml
overrides:
- conditions:
[condition]
delete:
'cameras[2]'
- conditions: [condition]
delete: 'cameras[2]'
```
Delete the menu style parameter, thus falling back to the default:
```yaml
overrides:
- conditions:
[condition]
delete:
'menu.style'
- conditions: [condition]
delete: 'menu.style'
```
## `merge`
Specifies an object to recursively merge into existing configuration.
Specifies an object to recursively merge into existing configuration.
| Option | Default | Description |
| - | - | - |
| [configuration path] | | Arbitrary configuration object to merge. Must be an object (i.e. not a literal value). |
| Option | Default | Description |
| -------------------- | ------- | -------------------------------------------------------------------------------------- |
| [configuration path] | | Arbitrary configuration object to merge. Must be an object (i.e. not a literal value). |
### Examples
@@ -85,49 +80,36 @@ Hide the menu when a given condition is met:
```yaml
overrides:
- conditions:
[condition]
- conditions: [condition]
merge:
menu: {
style: 'hidden'
}
menu: { style: 'hidden' }
```
Enable thumbnails below the `live` feed:
```yaml
overrides:
- conditions:
[condition]
- conditions: [condition]
merge:
'live.controls.thumbnails': {
mode: 'below'
}
'live.controls.thumbnails': { mode: 'below' }
```
Also enables thumbnails below the `live` feed, but without using the dot-separated notation:
```yaml
overrides:
- conditions:
[condition]
- conditions: [condition]
merge:
live: {
controls: {
thumbnails: {
mode: 'below'
}
}
}
live: { controls: { thumbnails: { mode: 'below' } } }
```
## `set`
Specifies a value to set in the configuration. This differs from `merge` in that the existing value is entirely replaced.
| Option | Default | Description |
| - | - | - |
| [configuration path] | | Arbitrary configuration value / object / list to set. |
| Option | Default | Description |
| -------------------- | ------- | ----------------------------------------------------- |
| [configuration path] | | Arbitrary configuration value / object / list to set. |
### Examples
@@ -135,20 +117,16 @@ Set the entire menu configuration to defaults with the exception of the `style`
```yaml
overrides:
- conditions:
[condition]
- conditions: [condition]
set:
menu: {
style: 'overlay'
}
menu: { style: 'overlay' }
```
Set the menu style but without touching the other `menu` parameters:
```yaml
overrides:
- conditions:
[condition]
- conditions: [condition]
set:
'menu.style': 'overlay'
```
@@ -157,10 +135,7 @@ That is equivalent to merging the following:
```yaml
overrides:
- conditions:
[condition]
- conditions: [condition]
merge:
menu: {
style: 'overlay'
}
```
menu: { style: 'overlay' }
```