Dermot Duffy
f924537025
* fix: Replace `max_height` with `height` BREAKING CHANGE: This entirely removes `min_height`, and replaces `max_height` with `height`. The behavior is obviously not exactly the same, but the prior behavior did not actually work correctly. CSS does not limit the height of child elements that are `100%` of their parents height if the parent does not have an explicit height set (this caused spillage over the set max height). As such, it's simpler to just allow the user to set the actual height of the card should they need to do so, with a (hopefully) minor loss of flexibility. * Test fixes
46 lines
3.1 KiB
Markdown
46 lines
3.1 KiB
Markdown
# `dimensions`
|
|
|
|
These options control the dimensions and aspect-ratio of the card (See [Camera
|
|
Dimensions](./cameras/README.md?id=dimensions) to set the dimensions of a camera
|
|
and not the whole card). These options configuration applies once to the entire
|
|
card (including the menu, thumbnails, etc), not just to displayed media. This
|
|
only applies to the card in normal render mode -- when in fullscreen, or when in
|
|
expanded (popup/dialog mode) the aspect ratio is chosen dynamically to maximize
|
|
the amount of content shown.
|
|
|
|
```yaml
|
|
dimensions:
|
|
# [...]
|
|
```
|
|
|
|
| Option | Default | Description |
|
|
| ------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `aspect_ratio_mode` | `dynamic` | The aspect ratio mode to use. Acceptable values: `dynamic`, `static`, `unconstrained`. See below. |
|
|
| `aspect_ratio` | `16:9` | The aspect ratio to use. Acceptable values: `[W]:[H]` or `[W]/[H]`. See below. |
|
|
| `height` | `auto` | The height for the card. Specified in [CSS units](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Values_and_units). Generally users should not need to change this. |
|
|
|
|
### `aspect_ratio_mode`
|
|
|
|
| Option | Description |
|
|
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `dynamic` | The aspect-ratio of the entire card will match the aspect-ratio of the last selected media item. |
|
|
| `static` | A fixed aspect-ratio (as defined by `aspect_ratio`) will be applied to the card. |
|
|
| `unconstrained` | No aspect ratio is enforced in any view, the card will expand with the content. This may be especially useful for a panel-mode dashboard, or in views that have no intrinsic aspect-ratio (e.g. the media gallery). |
|
|
|
|
### `aspect_ratio`
|
|
|
|
- `16 / 9` or `16:9`: Default widescreen ratio.
|
|
- `4 / 3` or `4:3`: Default fullscreen ratio.
|
|
- `[W]/[H]` or `[W]:[H]`: Any arbitrary aspect-ratio.
|
|
|
|
## Fully expanded reference
|
|
|
|
[](common/expanded-warning.md ':include')
|
|
|
|
```yaml
|
|
dimensions:
|
|
aspect_ratio_mode: dynamic
|
|
aspect_ratio: 16:9
|
|
height: auto
|
|
```
|