Updating documentation
This commit is contained in:
parent
9ed13c6f07
commit
96f29045e0
94
README.md
94
README.md
@ -3,69 +3,57 @@ fold-entity-row
|
||||
|
||||
Make a group from entities in a lovelace entities card - and fold them away when you don't want to see them.
|
||||
|
||||
## Options
|
||||
|
||||
| Name | Type | Default | Description
|
||||
| ---- | ---- | ------- | -----------
|
||||
| type | string | **Required** | `custom:fold-entity-row`
|
||||
| head | string/object | **Required** | The entity or row that should be the header
|
||||
| items | list | none | Entites or rows to put in the fold
|
||||
| group_config | object | none | Extra options to put on each item in the list
|
||||
| open | boolean | false | Set to true to have the fold opened by default
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
resources:
|
||||
- url: /local/fold-entity-row.js
|
||||
type: js
|
||||
|
||||
views:
|
||||
- title: My view
|
||||
cards:
|
||||
- type: entities
|
||||
type: entities
|
||||
title: Folding entities
|
||||
entities:
|
||||
- light.bed_light
|
||||
- type: custom:fold-entity-row
|
||||
head: input_select.tod
|
||||
head: sensor.yr_symbol
|
||||
items:
|
||||
- switch.tod_dark
|
||||
- entity: input_datetime.tod_morning
|
||||
type: custom:time-input-row
|
||||
...
|
||||
```
|
||||
|
||||

|
||||
|
||||
### Options
|
||||
|
||||
- `head` (required) - The entity that will be on the top of the list. Can be any type of entity that works in a entities card, with any options. If the entity is a group, the items of the fold will be automatically populated by the entities in the group.
|
||||
- `items` - Entities in the fold. Can be any kind of entity that works in an entities card, with any options.
|
||||
- `group_config` - configuration options that will be applied to every entity in the fold.
|
||||
- `open` - set to `true` to have the fold opened by default.
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
- type: entities
|
||||
entities:
|
||||
- type: custom:fold-entity-row
|
||||
head: group.flux_switches
|
||||
- sensor.outside_humidity
|
||||
- sensor.outside_temperature
|
||||
- light.bed_light
|
||||
- type: custom:fold-entity-row
|
||||
head:
|
||||
entity: light.taklampa_vardagsrum
|
||||
type: custom:toggle-lock-entity-row
|
||||
type: section
|
||||
label: Lights
|
||||
group_config:
|
||||
icon: mdi:fan
|
||||
secondary_info: last-changed
|
||||
items:
|
||||
- light.takflakt1
|
||||
- light.takflakt2
|
||||
- entity: light.takflakt3
|
||||
type: custom:slider-entity-row
|
||||
- light.takflakt4
|
||||
- type: custom:fold-entity-row
|
||||
head:
|
||||
type: divider
|
||||
style:
|
||||
height: 30px
|
||||
margin: 4px 0
|
||||
background: center / contain url("/local/images/divider.png")
|
||||
background-repeat: no-repeat
|
||||
items:
|
||||
- light.takflakt1
|
||||
- light.takflakt2
|
||||
- light.takflakt3
|
||||
- light.takflakt4
|
||||
- light.bed_light
|
||||
- light.ceiling_lights
|
||||
- light.kitchen_lights
|
||||
- light.bed_light
|
||||
```
|
||||
|
||||

|
||||

|
||||
|
||||
### Groups will populate the fold automatically
|
||||
|
||||
```yaml
|
||||
type: entities
|
||||
title: Folding groups
|
||||
entities:
|
||||
- type: custom:fold-entity-row
|
||||
head: group.all_lights
|
||||
- type: custom:fold-entity-row
|
||||
head: group.all_scripts
|
||||
- type: custom:fold-entity-row
|
||||
head: group.all_automations
|
||||
```
|
||||
|
||||

|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user