85 lines
4.3 KiB
Markdown
85 lines
4.3 KiB
Markdown
# `status_bar`
|
|
|
|
Configures the card status bar.
|
|
|
|
```yaml
|
|
status_bar:
|
|
# [...]
|
|
```
|
|
|
|
| Option | Default | Description |
|
|
| --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
| `position` | `bottom` | Whether to place the status bar at the `top` or `bottom` of the card. |
|
|
| `popup_seconds` | `3` | The number of seconds to display the status bar when using the `popup` style. |
|
|
| `height` | `46` | The height of the status bar in pixels. |
|
|
| `items` | | Whether to show or hide built-in status bar items. See below. |
|
|
| `style` | `popup` | The status bar style to show by default, one of `none`, `hover`, `hover-card`, `overlay`, `outside` or `popup`. See below. |
|
|
|
|
## `items`
|
|
|
|
All configuration is under:
|
|
|
|
```yaml
|
|
status_bar:
|
|
items:
|
|
[item]:
|
|
# [...]
|
|
```
|
|
|
|
### Available Items
|
|
|
|
| Button name | Description |
|
|
| ------------ | ------------------------------------------------------ |
|
|
| `engine` | The icon of the camera engine for the relevant camera. |
|
|
| `resolution` | The detected media resolution (if any). |
|
|
| `technology` | The detected media technology (if any). |
|
|
| `title` | The media title. |
|
|
|
|
### Options for each item
|
|
|
|
| Option | Default | Description |
|
|
| ---------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `enabled` | `true` | Whether or not to show the item. |
|
|
| `priority` | `50` | The item priority. Higher priority items are ordered closer to the start of the status bar (i.e. an item with priority `70` will order further to the left than an item with priority `60`). Minimum `0`, maximum `100`. |
|
|
|
|
## `style`
|
|
|
|
This card supports several menu styles.
|
|
|
|
| Key | Description |
|
|
| ------------ | --------------------------------------------------------------------------------------------------------------------- |
|
|
| `hover-card` | Overlay the status bar over the card contents when the mouse is over the **card**, otherwise it is not shown. |
|
|
| `hover` | Overlay the status bar over the card contents when the mouse is over the **status bar**, otherwise it is not shown. |
|
|
| `none` | No status bar is shown. |
|
|
| `outside` | Render the status bar outside the card (i.e. above it if `position` is `top`, or below it if `position` is `bottom`). |
|
|
| `overlay` | Overlay the status bar over the card contents. |
|
|
| `popup` | Equivalent to `overlay` except the status bar disappears after `popup_seconds`. |
|
|
|
|
## Fully expanded reference
|
|
|
|
> [!TIP]
|
|
> To add custom status bar contents, see [status bar custom elements](elements/custom/README.md?id=status-bar-icon).
|
|
|
|
[](common/expanded-warning.md ':include')
|
|
|
|
```yaml
|
|
status_bar:
|
|
position: bottom
|
|
popup_seconds: 3
|
|
height: 46
|
|
style: popup
|
|
items:
|
|
engine:
|
|
enabled: true
|
|
priority: 50
|
|
resolution:
|
|
enabled: true
|
|
priority: 50
|
|
technology:
|
|
enabled: true
|
|
priority: 50
|
|
title:
|
|
enabled: true
|
|
priority: 50
|
|
```
|