Complete documentation overhaul.

This commit is contained in:
Dermot Duffy
2024-04-01 21:09:20 -07:00
parent 9d62a5ceee
commit 955bcb3a9a
87 changed files with 6360 additions and 4540 deletions
+78
View File
@@ -0,0 +1,78 @@
# `media_gallery`
The `media_gallery` is used for providing an overview of all `clips`, `snapshots` and `recordings` in a thumbnail gallery.
```yaml
media_gallery:
[...]
```
| Option | Default | Description |
| - | - | - |
| `actions` | | [Actions](actions.md) to use for all views that use the `media_gallery` (e.g. `clips`, `snapshots`, `recordings`). |
| `controls` | | Configuration for the Media viewer controls. See below. |
## `controls`
### `filter`
Configure the media gallery filter.
```yaml
media_gallery:
controls:
filter:
[...]
```
| Option | Default | Description |
| - | - | - |
| `mode` | `right` | Whether to show the gallery media filter to the `left`, to the `right` or `none` for no media filter. |
### `thumbnails`
Configure the media gallery thumbnails.
```yaml
media_gallery:
controls:
thumbnails:
[...]
```
| Option | Default | Description |
| - | - | - |
| `show_details` | `false` | Whether to show media details (e.g. duration, start time, object detected, etc) alongside the thumbnail.|
| `show_download_control` | `true` | Whether to show the download control on each thumbnail.|
| `show_favorite_control` | `true` | Whether to show the favorite ('star') control on each thumbnail.|
| `show_timeline_control` | `true` | Whether to show the timeline ('target') control on each thumbnail.|
| `size` | `100` | The size of the thumbnails in the gallery. Must be >= `75` and <= `175`.|
## Fully expanded reference
[](common/expanded-warning.md ':include')
```yaml
media_gallery:
controls:
filter:
mode: 'right'
thumbnails:
size: 100
show_details: false
show_download_control: true
show_favorite_control: true
show_timeline_control: true
actions:
entity: light.office_main_lights
tap_action:
action: none
hold_action:
action: none
double_tap_action:
action: none
start_tap_action:
action: none
end_tap_action:
action: none
```