70 lines
3.0 KiB
Markdown
70 lines
3.0 KiB
Markdown
# template-entity-row
|
|
|
|
[](https://github.com/custom-components/hacs)
|
|
|
|
Display whatever you want in an entities card row.
|
|
|
|
For installation instructions [see this guide](https://github.com/thomasloven/hass-config/wiki/Lovelace-Plugins).
|
|
|
|
Install `template-entity-row.js` as a `module`.
|
|
|
|
```yaml
|
|
resources:
|
|
- url: /local/template-entity-row.js
|
|
type: module
|
|
```
|
|
|
|
## Usage example
|
|
|
|
**Note:** This is *not* a card. It's a row for an [entities](https://www.home-assistant.io/lovelace/entities/).
|
|
|
|
|
|
```yaml
|
|
type: entities
|
|
title: Default
|
|
entities:
|
|
- light.bed_light
|
|
- entity: input_boolean.car_home
|
|
- type: custom:template-entity-row
|
|
icon: mdi:lamp
|
|
name: "The light is {{states('light.bed_light')}} but nobody's"
|
|
state: "{% if is_state('input_boolean.car_home', 'on')%} home {% else %} away {% endif %}"
|
|
secondary: "It's {{states('sensor.time')}}"
|
|
active: "{{ is_state('light.bed_light', 'off') }}"
|
|
- type: custom:template-entity-row
|
|
icon: mdi:car
|
|
name: Hi there
|
|
condition: "{{is_state('input_boolean.car_home', 'on')}}"
|
|
```
|
|
|
|
## Options
|
|
- `icon`, `name`, `state`, `secondary`, `image` selects what icon, name, state, secondary_info text and entity_picture to display respectively.
|
|
- `active` if this evaluates to "true", the icon gets the color `--paper-item-icon-active-color`. Otherwise `--paper-item-icon-color`.
|
|
- `entity` if this evaluates to an entity id, `icon`, `name`, `state` and `image` will be taken from that entity unless manually overridden.
|
|
- `condition` if this is set but does not evaluate to "true", the row is not displayed.
|
|
|
|
All options accept [jinja2 templates](https://www.home-assistant.io/docs/configuration/templating/).
|
|
|
|
Jinja templates have access to a few special variables. Those are:
|
|
|
|
- `config` - an object containing the card configuration
|
|
- `user` - the username of the currently logged in user
|
|
- `browser` - the deviceID of the current browser (see [browser_mod](https://github.com/thomasloven/hass-browser_mod)).
|
|
- `hash` - the hash part of the current URL.
|
|
|
|
In evaluated templates the function `_(<key>)` (underscore) will localize the `<key>` to the current language.
|
|
E.g. `_(state.binary_sensor.motion.off)` will be replaced with `Clear` if your language is set to English.
|
|
|
|
To find the available keys, open your browsers console, type in the following and press Enter:
|
|
```javascript
|
|
document.querySelector("home-assistant").hass.resouces
|
|
```
|
|
|
|
# FAQ
|
|
|
|
### Why does this look weird?
|
|
Because you're not using it correctly. This is **not** a card. It's an entity row, and is meant to be used *inside* the [entities card](https://www.home-assistant.io/lovelace/entities/)
|
|
|
|
---
|
|
<a href="https://www.buymeacoffee.com/uqD6KHCdJ" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/white_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
|