Updating documentation

This commit is contained in:
Thomas Lovén 2018-11-01 14:48:14 +01:00
parent 9ed13c6f07
commit 96f29045e0

104
README.md
View File

@ -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. Make a group from entities in a lovelace entities card - and fold them away when you don't want to see them.
--- ## Options
```yaml | Name | Type | Default | Description
resources: | ---- | ---- | ------- | -----------
- url: /local/fold-entity-row.js | type | string | **Required** | `custom:fold-entity-row`
type: js | head | string/object | **Required** | The entity or row that should be the header
| items | list | none | Entites or rows to put in the fold
views: | group_config | object | none | Extra options to put on each item in the list
- title: My view | open | boolean | false | Set to true to have the fold opened by default
cards:
- type: entities
entities:
- type: custom:fold-entity-row
head: input_select.tod
items:
- switch.tod_dark
- entity: input_datetime.tod_morning
type: custom:time-input-row
...
```
![closed open](https://user-images.githubusercontent.com/1299821/47018117-5b0f7d80-d154-11e8-91b1-3405cd5c0662.jpg)
### 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 ```yaml
- type: entities type: entities
entities: title: Folding entities
- type: custom:fold-entity-row entities:
head: group.flux_switches - light.bed_light
- type: custom:fold-entity-row - type: custom:fold-entity-row
head: head: sensor.yr_symbol
entity: light.taklampa_vardagsrum items:
type: custom:toggle-lock-entity-row - sensor.outside_humidity
group_config: - sensor.outside_temperature
icon: mdi:fan - light.bed_light
items: - type: custom:fold-entity-row
- light.takflakt1 head:
- light.takflakt2 type: section
- entity: light.takflakt3 label: Lights
type: custom:slider-entity-row group_config:
- light.takflakt4 secondary_info: last-changed
- type: custom:fold-entity-row items:
head: - light.bed_light
type: divider - light.ceiling_lights
style: - light.kitchen_lights
height: 30px - light.bed_light
margin: 4px 0
background: center / contain url("/local/images/divider.png")
background-repeat: no-repeat
items:
- light.takflakt1
- light.takflakt2
- light.takflakt3
- light.takflakt4
``` ```
![special options](https://user-images.githubusercontent.com/1299821/47018785-cf96ec00-d155-11e8-8156-d54524d387ad.jpg) ![fold-entity-row](https://user-images.githubusercontent.com/1299821/47855185-281be980-dde4-11e8-92a6-643e8a47d8e9.png)
### 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
```
![folding groups](https://user-images.githubusercontent.com/1299821/47855259-5d283c00-dde4-11e8-8405-94c269e53935.png)