mirror of
https://github.com/joBr99/nspanel-lovelace-ui.git
synced 2026-02-23 13:02:14 +01:00
add documentation for standalone version
This commit is contained in:
137
docs-standalone/cards.md
Normal file
137
docs-standalone/cards.md
Normal file
@@ -0,0 +1,137 @@
|
||||
# Cards
|
||||
|
||||
## Supported card types
|
||||
|
||||
- `cardEntities`
|
||||
- `cardGrid`
|
||||
- `cardQR`
|
||||
- `cardPower`
|
||||
- `cardMedia`
|
||||
- `cardThermo`
|
||||
- `cardAlarm`
|
||||
- `cardUnlock`
|
||||
|
||||
## Common card keys
|
||||
|
||||
key | required | type | description
|
||||
-- | -- | -- | --
|
||||
`type` | yes | string | Card type.
|
||||
`title` | no | string | Card title.
|
||||
`key` | no | string | Navigation key used by `navigate.<key>`.
|
||||
|
||||
## `cardEntities` and `cardGrid`
|
||||
|
||||
```yaml
|
||||
- type: cardEntities
|
||||
title: Main
|
||||
key: main
|
||||
entities:
|
||||
- entity: light.kitchen
|
||||
- entity: navigate.settings
|
||||
icon: mdi:cog
|
||||
```
|
||||
|
||||
- `entities` is required.
|
||||
- `cardGrid` auto-switches to `cardGrid2` if more than 6 entities are present.
|
||||
|
||||
## `cardQR`
|
||||
|
||||
```yaml
|
||||
- type: cardQR
|
||||
title: Guest WiFi
|
||||
qrCode: "WIFI:S:myssid;T:WPA;P:mypassword;;"
|
||||
entities:
|
||||
- entity: iText.myssid
|
||||
name: SSID
|
||||
icon: mdi:wifi
|
||||
```
|
||||
|
||||
Keys:
|
||||
|
||||
- `qrCode` optional (default value exists, but set it explicitly)
|
||||
- supports optional `entity` / `entities`
|
||||
|
||||
## `cardPower`
|
||||
|
||||
```yaml
|
||||
- type: cardPower
|
||||
title: Energy
|
||||
entities:
|
||||
- entity: sensor.house_power
|
||||
- entity: delete
|
||||
- entity: sensor.solar_power
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
- `entities` is required.
|
||||
- `speed` key is accepted in config but currently not applied by the renderer.
|
||||
|
||||
## `cardMedia`
|
||||
|
||||
```yaml
|
||||
- type: cardMedia
|
||||
title: Living Room
|
||||
entity: media_player.living_room
|
||||
entities:
|
||||
- entity: light.ambient
|
||||
- entity: switch.tv_bias_light
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
- Main media entity must exist (`entity` or first generated entity).
|
||||
- Additional `entities` are rendered as action buttons on the bottom row.
|
||||
|
||||
## `cardThermo`
|
||||
|
||||
```yaml
|
||||
- type: cardThermo
|
||||
title: Heating
|
||||
entity: climate.downstairs
|
||||
supported_modes: ["heat", "off"]
|
||||
```
|
||||
|
||||
Keys:
|
||||
|
||||
- `entity` required
|
||||
- `supported_modes` optional (filters shown HVAC mode buttons)
|
||||
|
||||
## `cardAlarm`
|
||||
|
||||
```yaml
|
||||
- type: cardAlarm
|
||||
title: House Alarm
|
||||
entity: alarm_control_panel.house
|
||||
supported_modes: ["arm_home", "arm_away", "arm_night"]
|
||||
```
|
||||
|
||||
Keys:
|
||||
|
||||
- `entity` required
|
||||
- `supported_modes` optional
|
||||
|
||||
## `cardUnlock`
|
||||
|
||||
```yaml
|
||||
- type: cardUnlock
|
||||
title: Admin
|
||||
pin: 1234
|
||||
destination: navigate.admin
|
||||
```
|
||||
|
||||
Keys:
|
||||
|
||||
- `pin` required
|
||||
- `destination` required
|
||||
|
||||
Typical target in `hiddenCards`:
|
||||
|
||||
```yaml
|
||||
hiddenCards:
|
||||
- type: cardGrid
|
||||
key: admin
|
||||
title: Admin
|
||||
entities:
|
||||
- entity: switch.maintenance_mode
|
||||
```
|
||||
Reference in New Issue
Block a user