From 473d9d3fae4fc26a2b8daff192bc08bf72530249 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Sat, 18 Nov 2023 11:47:45 +0100 Subject: [PATCH] Dashboards: apply sentence style caps (#29890) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Dashboards: apply sentence-style capitalization * Apply sentence-style capitalization, apply reuse * Apply suggestions from code review Co-authored-by: Joakim Sørensen * Apply suggestions from code review * Add substep on dashboard control * Remove code fence from title - to focus on the topic of the content, rather than the code itself * Apply suggestions from code review Co-authored-by: Joakim Sørensen --------- Co-authored-by: Joakim Sørensen --- source/_dashboards/alarm-panel.markdown | 16 ++++++++-------- source/_dashboards/area.markdown | 14 +++++++------- source/_dashboards/button.markdown | 18 +++++++++--------- source/_dashboards/calendar.markdown | 10 +++++----- source/_dashboards/conditional.markdown | 7 ++++--- source/_dashboards/entities.markdown | 14 +++++++------- source/_dashboards/entity-filter.markdown | 20 ++++++++++---------- source/_dashboards/entity.markdown | 10 +++++----- source/_dashboards/gauge.markdown | 12 ++++++------ source/_dashboards/glance.markdown | 16 ++++++++-------- source/_dashboards/grid.markdown | 12 ++++++------ source/_dashboards/history-graph.markdown | 18 +++++++++--------- source/_dashboards/horizontal-stack.markdown | 14 +++++++------- source/_dashboards/humidifier.markdown | 10 +++++----- source/_dashboards/iframe.markdown | 12 ++++++------ source/_dashboards/light.markdown | 12 ++++++------ source/_dashboards/logbook.markdown | 12 ++++++------ source/_dashboards/map.markdown | 12 ++++++------ source/_dashboards/markdown.markdown | 6 +++--- source/_dashboards/masonry.markdown | 2 +- source/_dashboards/media-control.markdown | 14 +++++++------- source/_dashboards/panel.markdown | 4 ++-- source/_dashboards/picture-elements.markdown | 12 ++++++------ source/_dashboards/picture-entity.markdown | 12 ++++++------ source/_dashboards/picture-glance.markdown | 16 ++++++++-------- source/_dashboards/picture.markdown | 8 ++++---- source/_dashboards/plant-status.markdown | 12 ++++++------ source/_dashboards/sensor.markdown | 10 +++++----- source/_dashboards/shopping-list.markdown | 18 +++++++++--------- source/_dashboards/sidebar.markdown | 2 +- source/_dashboards/statistic.markdown | 12 +++++++----- source/_dashboards/statistics-graph.markdown | 18 +++++++++--------- source/_dashboards/thermostat.markdown | 12 ++++++------ source/_dashboards/tile.markdown | 6 +++--- source/_dashboards/vertical-stack.markdown | 12 ++++++------ source/_dashboards/weather-forecast.markdown | 14 +++++++------- source/_includes/dashboard/edit_dashboard.md | 8 ++++++++ source/dashboards/actions.markdown | 10 +++++----- source/dashboards/badges.markdown | 4 ++-- source/dashboards/views.markdown | 2 +- 40 files changed, 232 insertions(+), 221 deletions(-) create mode 100644 source/_includes/dashboard/edit_dashboard.md diff --git a/source/_dashboards/alarm-panel.markdown b/source/_dashboards/alarm-panel.markdown index 0b4e970b7db..9d1938b50b0 100644 --- a/source/_dashboards/alarm-panel.markdown +++ b/source/_dashboards/alarm-panel.markdown @@ -1,24 +1,24 @@ --- type: card -title: "Alarm Panel Card" -sidebar_label: Alarm Panel -description: "The Alarm Panel card allows you to arm and disarm your alarm control panel integrations." +title: "Alarm panel card" +sidebar_label: Alarm panel +description: "The alarm panel card allows you to arm and disarm your alarm control panel integrations." --- -The Alarm Panel card allows you to arm and disarm your [alarm control panel](/integrations/#alarm) integrations. +The alarm panel card allows you to arm and disarm your [alarm control panel](/integrations/#alarm) integrations.

Screenshot of the alarm panel card -Screenshot of the Alarm Panel card. +Screenshot of the alarm panel card.

-To add the Alarm Panel card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: @@ -66,7 +66,7 @@ entity: alarm_control_panel.alarm

Screenshot of the alarm panel card -Screenshot of the Alarm Panel card. +Screenshot of the alarm panel card.

Define the state list: diff --git a/source/_dashboards/area.markdown b/source/_dashboards/area.markdown index 1cf81cfceeb..b468505d985 100644 --- a/source/_dashboards/area.markdown +++ b/source/_dashboards/area.markdown @@ -1,18 +1,18 @@ --- type: card -title: "Area Card" +title: "Area card" sidebar_label: Area -description: "The Area card gives control of your entities in a specified area." +description: "The area card gives control of your entities in a specified area." --- -The Area card lets you control and monitor an individual area. +The area card lets you control and monitor an individual area.

- Screenshot of the Area card - Screenshot of the Area card. + Screenshot of the area card + Screenshot of the area card.

-To add the Area card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. @@ -22,7 +22,7 @@ If a camera is added to the area you can show the camera feed instead of the are ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/button.markdown b/source/_dashboards/button.markdown index fedeca3101c..88ce2c1eba7 100644 --- a/source/_dashboards/button.markdown +++ b/source/_dashboards/button.markdown @@ -1,18 +1,18 @@ --- type: card -title: "Button Card" +title: "Button card" sidebar_label: Button description: "The Button card allows you to add buttons to perform tasks." --- -The Button card allows you to add buttons to perform tasks. +The button card allows you to add buttons to perform tasks.

-Screenshot of three Button Cards -Screenshot of three Button Cards. +Screenshot of three button cards +Screenshot of three button cards.

-To add the Button card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. @@ -41,7 +41,7 @@ Hold Action: ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: @@ -119,7 +119,7 @@ type: button entity: light.living_room ``` -Button Card with a button name and a script that runs when card is tapped: +Button card with a button name and a script that runs when card is tapped: ```yaml type: button @@ -133,6 +133,6 @@ tap_action: ```

-Screenshot of the Button card with Script Service -Screenshot of the Button card with Script Service. +Screenshot of the Button card with script service +Screenshot of the button card with script service.

diff --git a/source/_dashboards/calendar.markdown b/source/_dashboards/calendar.markdown index 9a82615a629..18ae6b31661 100644 --- a/source/_dashboards/calendar.markdown +++ b/source/_dashboards/calendar.markdown @@ -1,19 +1,19 @@ --- type: card -title: "Calendar Card" +title: "Calendar card" sidebar_label: Calendar description: "The calendar card displays your calendar entities in a month, day and list view" --- -The Calendar card displays your [calendar](/integrations/#calendar) entities in a month, day and list view (7 days). +The calendar card displays your [calendar](/integrations/#calendar) entities in a month, day and list view (7 days).

Screenshot of the calendar card - Screenshot of the Calendar card. + Screenshot of the calendar card.

-To add the Calendar card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. @@ -32,7 +32,7 @@ Theme: ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/conditional.markdown b/source/_dashboards/conditional.markdown index bdbaa90b152..ac25d30af4f 100644 --- a/source/_dashboards/conditional.markdown +++ b/source/_dashboards/conditional.markdown @@ -5,17 +5,18 @@ sidebar_label: Conditional description: The Conditional card displays another card based on conditions. --- -The Conditional card displays another card based on conditions. +The conditional card displays another card based on conditions. Note: if there are multiple conditions there will be treated as an 'and' condition. This means that for the card to show, _all_ conditions must be met. -To add the Conditional card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. Note that while editing the dashboard, the card will always be shown, so be sure to exit editing mode to test the conditions. +{% include dashboard/edit_dashboard.md %} +Note that while editing the dashboard, the card will always be shown, so be sure to exit editing mode to test the conditions. Most options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/entities.markdown b/source/_dashboards/entities.markdown index 8fdd6b46842..69f74e67c5a 100644 --- a/source/_dashboards/entities.markdown +++ b/source/_dashboards/entities.markdown @@ -2,16 +2,16 @@ type: card title: "Entities Card" sidebar_label: Entities -description: "The Entities card is the most common type of card. It groups items together into lists." +description: "The entities card is the most common type of card. It groups items together into lists." --- -The Entities card is the most common type of card. It groups items together into lists. It can be used to display an entity's state or attribute, but also contain buttons, web links, etc. +The entities card is the most common type of card. It groups items together into lists. It can be used to display an entity's state or attribute, but also contain buttons, web links, etc. -To add the Entities card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: @@ -54,7 +54,7 @@ footer: type: map {% endconfiguration %} -## Options For Entities +## Options for entities If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configuration. @@ -110,9 +110,9 @@ double_tap_action: type: map {% endconfiguration %} -## Special Row Elements +## Special row elements -Rather than only displaying an entity's state as a text output, the Entities card supports multiple special rows for buttons, attributes, web links, dividers and sections, etc. +Rather than only displaying an entity's state as a text output, the entities card supports multiple special rows for buttons, attributes, web links, dividers and sections, etc. ### Attribute diff --git a/source/_dashboards/entity-filter.markdown b/source/_dashboards/entity-filter.markdown index 91e66b07afd..201e7067261 100644 --- a/source/_dashboards/entity-filter.markdown +++ b/source/_dashboards/entity-filter.markdown @@ -1,22 +1,22 @@ --- type: card -title: "Entity Filter Card" -sidebar_label: Entity Filter -description: "The Entity Filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. " +title: "Entity filter card" +sidebar_label: Entity filter +description: "The entity filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. " --- -The Entity Filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. +The entity filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home.

-Screenshot of the Entity Filter card -Screenshot of the Entity Filter card. +Screenshot of the entity filter card +Screenshot of the entity filter card.

This type of card can also be used together with other cards that allow multiple entities, allowing you to use [glance](/dashboards/glance/) or [picture-glance](/dashboards/picture-glance/). By default, it uses the [entities](/dashboards/entities/) card model. -To add the Entity Filter card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} -## YAML Configuration +## YAML configuration This card can only be configured in YAML. @@ -45,7 +45,7 @@ show_empty: default: true {% endconfiguration %} -### Options For Entities +### Options for entities If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configurations: @@ -80,7 +80,7 @@ state_filter: type: list {% endconfiguration %} -### Options For state_filter +### Options for state filter If you define `state_filter` as objects instead of strings (by adding `value:` before your state value), you can add more customization to your filter: diff --git a/source/_dashboards/entity.markdown b/source/_dashboards/entity.markdown index 37aeb2b499d..c095ded88c1 100644 --- a/source/_dashboards/entity.markdown +++ b/source/_dashboards/entity.markdown @@ -1,24 +1,24 @@ --- type: card -title: "Entity Card" +title: "Entity card" sidebar_label: Entity -description: "The Entity card gives you a quick overview of your entity's state" +description: "The entity card gives you a quick overview of your entity's state" --- -The Entity card gives you a quick overview of your entity's state. +The entity card gives you a quick overview of your entity's state.

Screenshot of the entity card Screenshot of the Entity card.

-To add the Entity card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/gauge.markdown b/source/_dashboards/gauge.markdown index 625c4ecbd96..3a738f87fc8 100644 --- a/source/_dashboards/gauge.markdown +++ b/source/_dashboards/gauge.markdown @@ -2,28 +2,28 @@ type: card title: "Gauge Card" sidebar_label: Gauge -description: "The Gauge card is a basic card that allows visually seeing sensor data." +description: "The gauge card is a basic card that allows visually seeing sensor data." --- -The Gauge card is a basic card that allows visually seeing sensor data. +The gauge card is a basic card that allows visually seeing sensor data.

Screenshot of the Gauge card -Screenshot of the Gauge card. +Screenshot of the gauge card.

Screenshot of the Gauge card in needle mode -Screenshot of the Gauge card in needle mode. +Screenshot of the gauge card in needle mode.

-To add the Gauge card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/glance.markdown b/source/_dashboards/glance.markdown index 9ec0d241411..77319525283 100644 --- a/source/_dashboards/glance.markdown +++ b/source/_dashboards/glance.markdown @@ -1,24 +1,24 @@ --- type: card -title: "Glance Card" +title: "Glance card" sidebar_label: Glance -description: "The Glance card is useful to group multiple sensors in a compact overview." +description: "The glance card is useful to group multiple sensors in a compact overview." --- -The Glance card is useful to group multiple sensors in a compact overview. Keep in mind that this can be used together with [entity-filter](/dashboards/entity-filter/) cards to create dynamic cards. +The glance card is useful to group multiple sensors in a compact overview. Keep in mind that this can be used together with [entity-filter](/dashboards/entity-filter/) cards to create dynamic cards.

Screenshot of the glance card -Screenshot of the Glance card. +Screenshot of the glance card.

-To add the Glance card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: @@ -63,7 +63,7 @@ state_color: default: true {% endconfiguration %} -### Options For Entities +### Options for entities If you define entities as objects instead of strings, you can add more customization and configuration: @@ -108,7 +108,7 @@ double_tap_action: type: map {% endconfiguration %} -### Options For Exemptions +### Options for exemptions {% configuration badges %} user: diff --git a/source/_dashboards/grid.markdown b/source/_dashboards/grid.markdown index 345557f3869..bb0fee77676 100644 --- a/source/_dashboards/grid.markdown +++ b/source/_dashboards/grid.markdown @@ -1,24 +1,24 @@ --- type: card -title: "Grid Card" +title: "Grid card" sidebar_label: Grid -description: "The Grid card allows you to show multiple cards in a grid." +description: "The grid card allows you to show multiple cards in a grid." --- -The Grid card allows you to show multiple cards in a grid. It will first fill the columns, automatically adding new rows as needed. +The grid card allows you to show multiple cards in a grid. It will first fill the columns, automatically adding new rows as needed.

Screenshot of the grid card - Screenshot of the Grid card. + Screenshot of the grid card.

-To add the Grid card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/history-graph.markdown b/source/_dashboards/history-graph.markdown index 27546beb7a9..ebdc99dc689 100644 --- a/source/_dashboards/history-graph.markdown +++ b/source/_dashboards/history-graph.markdown @@ -1,29 +1,29 @@ --- type: card -title: "History Graph Card" -sidebar_label: History Graph -description: "The History Graph card allows you to display a graph for each of the entities listed." +title: "History graph card" +sidebar_label: History graph +description: "The history graph card allows you to display a graph for each of the entities listed." --- -The History Graph card allows you to display a graph for each of up to eight entities. +The history graph card allows you to display a graph for each of up to eight entities.

Screenshot of the history graph card for entities without a unit_of_measurement -Screenshot of the History Graph card, when the sensor has no `unit_of_measurement` defined. +Screenshot of the history graph card, when the sensor has no `unit_of_measurement` defined.

Screenshot of the history graph card for entities with a unit_of_measurement -Screenshot of the History Graph card, when the sensor has a `unit_of_measurement` defined. +Screenshot of the history graph card, when the sensor has a `unit_of_measurement` defined.

-To add the History Graph card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: @@ -50,7 +50,7 @@ show_names: default: true {% endconfiguration %} -### Options For Entities +### Options for entities If you define entities as objects instead of strings, you can add more customization and configuration: diff --git a/source/_dashboards/horizontal-stack.markdown b/source/_dashboards/horizontal-stack.markdown index 6b4a98c8bd3..ecf71a94c73 100644 --- a/source/_dashboards/horizontal-stack.markdown +++ b/source/_dashboards/horizontal-stack.markdown @@ -1,17 +1,17 @@ --- type: card -title: "Horizontal Stack Card" -sidebar_label: Horizontal Stack -description: "The Horizontal Stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column." +title: "Horizontal stack card" +sidebar_label: Horizontal stack +description: "The horizontal stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column." --- -The Horizontal Stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column. +The horizontal stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column. -To add the Horizontal Stack card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: @@ -44,5 +44,5 @@ cards:

Two picture cards in a horizontal stack card - Two Picture cards in a Horizontal Stack card. + Two picture cards in a horizontal stack card.

diff --git a/source/_dashboards/humidifier.markdown b/source/_dashboards/humidifier.markdown index 8c2f7a5bc86..2e98a915d72 100644 --- a/source/_dashboards/humidifier.markdown +++ b/source/_dashboards/humidifier.markdown @@ -1,24 +1,24 @@ --- type: card -title: "Humidifier Card" +title: "Humidifier card" sidebar_label: Humidifier -description: "The Humidifier card gives control of your humidifier entity, allowing you to change the target humidity and mode of the entity." +description: "The humidifier card gives control of your humidifier entity, allowing you to change the target humidity and mode of the entity." --- -The Humidifier card lets you control and monitor humidifiers, dehumidifiers, and hygrostat devices. +The humidifier card lets you control and monitor humidifiers, dehumidifiers, and hygrostat devices.

Screenshot of the humidifier card Screenshot of the humidifier card.

-To add the Humidifier card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/iframe.markdown b/source/_dashboards/iframe.markdown index 3c5385860e1..fdaa049ed41 100644 --- a/source/_dashboards/iframe.markdown +++ b/source/_dashboards/iframe.markdown @@ -1,18 +1,18 @@ --- type: card -title: "Webpage Card" +title: "Webpage card" sidebar_label: Webpage -description: "The Webpage card allows you to embed your favorite webpage right into Home Assistant." +description: "The webpage card allows you to embed your favorite webpage right into Home Assistant." --- -The Webpage card allows you to embed your favorite webpage right into Home Assistant. You can also embed files stored in your `/www` folder and reference them using `/local/`. +The webpage card allows you to embed your favorite webpage right into Home Assistant. You can also embed files stored in your `/www` folder and reference them using `/local/`.

Windy weather radar as Webpage - Windy weather radar as Webpage. + Windy weather radar as webpage.

-To add the Webpage card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. @@ -22,7 +22,7 @@ You can't embed sites using HTTP if you are using HTTPS for your Home Assistant. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/light.markdown b/source/_dashboards/light.markdown index e52ebd0c526..f1cd3c965b5 100644 --- a/source/_dashboards/light.markdown +++ b/source/_dashboards/light.markdown @@ -1,24 +1,24 @@ --- type: card -title: "Light Card" +title: "Light card" sidebar_label: Light -description: "The Light card allows you to change the brightness of the light." +description: "The light card allows you to change the brightness of the light." --- -The Light card allows you to change the brightness of the light. +The light card allows you to change the brightness of the light.

Screenshot of the Light card -Screenshot of the Light card. +Screenshot of the light card.

-To add the Light card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/logbook.markdown b/source/_dashboards/logbook.markdown index d58893d2843..d4fdabb5c5e 100644 --- a/source/_dashboards/logbook.markdown +++ b/source/_dashboards/logbook.markdown @@ -1,18 +1,18 @@ --- type: card -title: "Logbook Card" +title: "Logbook card" sidebar_label: Logbook -description: "The Logbook card displays entries from the logbook for specific entities." +description: "The logbook card displays entries from the logbook for specific entities." --- -The Logbook card displays entries from the logbook for specific entities. +The logbook card displays entries from the logbook for specific entities.

Screenshot of the logbook card - Screenshot of the Logbook card. + Screenshot of the logbook card.

-To add the Logbook card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## Card settings @@ -29,7 +29,7 @@ Theme: ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/map.markdown b/source/_dashboards/map.markdown index 460d83b7ce7..203859950d3 100644 --- a/source/_dashboards/map.markdown +++ b/source/_dashboards/map.markdown @@ -1,24 +1,24 @@ --- type: card -title: "Map Card" +title: "Map card" sidebar_label: Map -description: "The Map card that allows you to display entities on a map" +description: "The map card that allows you to display entities on a map" --- -The Map card that allows you to display entities on a map +The map card that allows you to display entities on a map

Screenshot of the map card Screenshot of the map card.

-To add the Map card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: @@ -75,7 +75,7 @@ hours_to_show: -## Options For Entities +## Options for entities If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configuration. diff --git a/source/_dashboards/markdown.markdown b/source/_dashboards/markdown.markdown index b525a054e05..f1886128004 100644 --- a/source/_dashboards/markdown.markdown +++ b/source/_dashboards/markdown.markdown @@ -1,6 +1,6 @@ --- type: card -title: "Markdown Card" +title: "Markdown card" sidebar_label: Markdown description: "The Markdown card is used to render Markdown" --- @@ -14,11 +14,11 @@ Screenshot of the Markdown card. The renderer uses [Marked.js](https://marked.js.org), which supports [several specifications of Markdown](https://marked.js.org/#specifications), including CommonMark, GitHub Flavored Markdown (GFM) and `markdown.pl`. -To add the Markdown card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/masonry.markdown b/source/_dashboards/masonry.markdown index 1f12a83e445..76615e5cd52 100644 --- a/source/_dashboards/masonry.markdown +++ b/source/_dashboards/masonry.markdown @@ -1,6 +1,6 @@ --- type: view -title: Masonry View +title: Masonry view sidebar_label: Masonry (default) description: "The default panel layout uses a masonry algorithme." --- diff --git a/source/_dashboards/media-control.markdown b/source/_dashboards/media-control.markdown index 23ee969bb1d..0ba077b45e7 100644 --- a/source/_dashboards/media-control.markdown +++ b/source/_dashboards/media-control.markdown @@ -1,22 +1,22 @@ --- type: card -title: "Media Control Card" -sidebar_label: Media Control -description: "The Media Control card is used to display media player entities on an interface with easy to use controls." +title: "Media control card" +sidebar_label: Media control +description: "The media control card is used to display media player entities on an interface with easy to use controls." --- -The Media Control card is used to display [Media Player](/integrations/#media-player) entities on an interface with easy to use controls. +The media control card is used to display [media player](/integrations/#media-player) entities on an interface with easy to use controls.

Screenshot of the media player control card -Screenshot of the Media Control card. +Screenshot of the media control card.

-To add the Media Control card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/panel.markdown b/source/_dashboards/panel.markdown index 9eb981207fd..8cc91c122f0 100644 --- a/source/_dashboards/panel.markdown +++ b/source/_dashboards/panel.markdown @@ -1,11 +1,11 @@ --- type: view -title: Panel View +title: Panel view sidebar_label: Panel description: "The panel view shows a single card in the full width of the screen." --- -The view must have exactly one card. This card is rendered full-width. +The view must have exactly one card. This card is rendered full-width. This view doesn't have support for badges. diff --git a/source/_dashboards/picture-elements.markdown b/source/_dashboards/picture-elements.markdown index 455a6fcf4c4..b494e2810dc 100644 --- a/source/_dashboards/picture-elements.markdown +++ b/source/_dashboards/picture-elements.markdown @@ -1,11 +1,11 @@ --- type: card -title: "Picture Elements Card" -sidebar_label: Picture Elements -description: "The Picture Elements card is one of the most versatile types of cards. The cards allow you to position icons or text and even services! On an image based on coordinates." +title: "Picture elements card" +sidebar_label: Picture elements +description: "The picture elements card is one of the most versatile types of cards. The cards allow you to position icons or text and even services! On an image based on coordinates." --- -The Picture Elements card is one of the most versatile types of cards. +The picture elements card is one of the most versatile types of cards.

A functional floorplan powered by picture elements @@ -14,7 +14,7 @@ The Picture Elements card is one of the most versatile types of cards. The cards allow you to position icons or text and even services on an image based on coordinates. Imagine floor plan, imagine [picture-glance](/dashboards/picture-glance/) with no restrictions! -To add the Picture Elements card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## YAML configuration @@ -70,7 +70,7 @@ Elements are the active components (icons, badges, buttons, text, etc.) that ove There are several different element types that can be added to a Picture Elements card: -- [State Badge](#state-badge) +- [State badge](#state-badge) - [State Icon](#state-icon) - [State Label](#state-label) - [Service Call Button](#service-call-button) diff --git a/source/_dashboards/picture-entity.markdown b/source/_dashboards/picture-entity.markdown index 32304ad2ec6..e3f14b9eecc 100644 --- a/source/_dashboards/picture-entity.markdown +++ b/source/_dashboards/picture-entity.markdown @@ -1,22 +1,22 @@ --- type: card -title: Picture Entity Card -sidebar_label: Picture Entity -description: The Picture Entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities. +title: Picture entity card +sidebar_label: Picture entity +description: The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities. --- -The Picture Entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of `camera` entities. +The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of `camera` entities.

Picture entity card Background changes according to the entity state.

-To add the Picture Entity card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/picture-glance.markdown b/source/_dashboards/picture-glance.markdown index f7f152b732b..f612cc307c4 100644 --- a/source/_dashboards/picture-glance.markdown +++ b/source/_dashboards/picture-glance.markdown @@ -1,22 +1,22 @@ --- type: card -title: "Picture Glance Card" -sidebar_label: Picture Glance -description: "The Picture Glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog." +title: "Picture glance card" +sidebar_label: Picture glance +description: "The picture glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog." --- -The Picture Glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog. +The picture glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog.

Picture glance card for a living room Picture glance card for a living room.

-To add the Picture Glance card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: @@ -88,7 +88,7 @@ double_tap_action: type: map {% endconfiguration %} -### Options For Entities +### Options for entities If you define entities as objects instead of strings, you can add more customization and configuration: @@ -132,7 +132,7 @@ double_tap_action: type: map {% endconfiguration %} -### Options For Exemptions +### Options for exemptions {% configuration badges %} user: diff --git a/source/_dashboards/picture.markdown b/source/_dashboards/picture.markdown index 3b45b687563..5a2fca27cc0 100644 --- a/source/_dashboards/picture.markdown +++ b/source/_dashboards/picture.markdown @@ -2,21 +2,21 @@ type: card title: "Picture Card" sidebar_label: Picture -description: "The Picture card allows you to set an image to use for navigation to various paths in your interface or to call a service." +description: "The picture card allows you to set an image to use for navigation to various paths in your interface or to call a service." --- -The Picture card allows you to set an image to use for navigation to various paths in your interface or to call a service. +The picture card allows you to set an image to use for navigation to various paths in your interface or to call a service.

Screenshot of the picture card Screenshot of the picture card.

-To add the Picture card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/plant-status.markdown b/source/_dashboards/plant-status.markdown index 6a611a1a4db..031def93771 100644 --- a/source/_dashboards/plant-status.markdown +++ b/source/_dashboards/plant-status.markdown @@ -1,24 +1,24 @@ --- type: card -title: "Plant Status Card" -sidebar_label: Plant Status -description: "The Plant Status card is for all the lovely botanists out there." +title: "Plant status card" +sidebar_label: Plant status +description: "The plant status card is for all the lovely botanists out there." --- -The Plant Status card is for all the lovely botanists out there. +The plant status card is for all the lovely botanists out there.

Screenshot of the plant status card Screenshot of the plant status card.

-To add the Plant Status card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/sensor.markdown b/source/_dashboards/sensor.markdown index 94bc44f5cfb..5769fb7f787 100644 --- a/source/_dashboards/sensor.markdown +++ b/source/_dashboards/sensor.markdown @@ -1,24 +1,24 @@ --- type: card -title: "Sensor Card" +title: "Sensor card" sidebar_label: Sensor -description: "The Sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time." +description: "The sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time." --- -The Sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time. +The sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time.

Screenshot of the sensor card Screenshot of the sensor card.

-To add the Sensor card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/shopping-list.markdown b/source/_dashboards/shopping-list.markdown index f9143284116..0c6e77eac83 100644 --- a/source/_dashboards/shopping-list.markdown +++ b/source/_dashboards/shopping-list.markdown @@ -1,26 +1,26 @@ --- type: card -title: "Shopping List Card" -sidebar_label: Shopping List -description: "The Shopping List card allows you to add, edit, check-off, and clear items from your shopping list." +title: "Shopping list card" +sidebar_label: Shopping list +description: "The shopping list card allows you to add, edit, check-off, and clear items from your shopping list." --- -The Shopping List card allows you to add, edit, check-off, and clear items from your shopping list. +The shopping list card allows you to add, edit, check-off, and clear items from your shopping list.

Screenshot of the shopping list card -Screenshot of the Shopping List card. +Screenshot of the shopping list card.

-Setup of the [Shopping List integration](/integrations/shopping_list/) is required. +Setup of the [shopping list integration](/integrations/shopping_list/) is required. -To add the Shopping List card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: @@ -43,5 +43,5 @@ Title Example: ```yaml type: shopping-list -title: Shopping List +title: shopping list ``` diff --git a/source/_dashboards/sidebar.markdown b/source/_dashboards/sidebar.markdown index 14ff2ab1205..bfa851b9392 100644 --- a/source/_dashboards/sidebar.markdown +++ b/source/_dashboards/sidebar.markdown @@ -1,6 +1,6 @@ --- type: view -title: Sidebar View +title: Sidebar view sidebar_label: Sidebar description: "The sidebar view has 2 columns, a wide one and a smaller one on the right." --- diff --git a/source/_dashboards/statistic.markdown b/source/_dashboards/statistic.markdown index 83349cd32b1..8e34f583fa9 100644 --- a/source/_dashboards/statistic.markdown +++ b/source/_dashboards/statistic.markdown @@ -1,11 +1,11 @@ --- type: card -title: "Statistic Card" +title: "Statistic card" sidebar_label: Statistic -description: "The Statistic card allows you to display a statistical value for an entity." +description: "The statistic card allows you to display a statistical value for an entity." --- -The Statistic card allows you to display a statistical value for an entity. +The statistic card allows you to display a statistical value for an entity. Statistics are gathered every 5 minutes for sensors that support it. It will either keep the `min`, `max` and `mean` of a sensors value for a specific period, or the `sum` for a metered entity. @@ -16,7 +16,9 @@ If your sensor doesn't work with statistics, check [this](/more-info/statistics/ Screenshot of the statistic card for a temperature sensor.

-To add the Statistic card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the "Add Card" button in the bottom right corner and select **Statistic** from the card picker. All options for this card can be configured via the user interface, but if you want more options for the period, you will have to define them in `yaml`. +{% include dashboard/edit_dashboard.md %} + +All options for this card can be configured via the user interface, but if you want more options for the period, you will have to define them in `yaml`. {% configuration %} type: @@ -72,7 +74,7 @@ period: stat_type: change ``` -## Options For Period +## Options for period Periods can be configured in 3 different ways: diff --git a/source/_dashboards/statistics-graph.markdown b/source/_dashboards/statistics-graph.markdown index 3fc29901653..3d006cb58bf 100644 --- a/source/_dashboards/statistics-graph.markdown +++ b/source/_dashboards/statistics-graph.markdown @@ -1,33 +1,33 @@ --- type: card -title: "Statistics Graph Card" -sidebar_label: Statistics Graph -description: "The Statistics Graph card allows you to display a graph with statistics data for each of the entities listed." +title: "Statistics graph card" +sidebar_label: Statistics graph +description: "The statistics graph card allows you to display a graph with statistics data for each of the entities listed." --- -The Statistics Graph card allows you to display a graph of statistics data for each of the entities listed. +The statistics graph card allows you to display a graph of statistics data for each of the entities listed.

Screenshot of the statistics graph card for power entities -Screenshot of the Statistics Graph card with none metered entities and `chart_type` `line`. +Screenshot of the statistics graph card with none metered entities and `chart_type` `line`.

Screenshot of the statistics graph card for energy entities -Screenshot of the Statistics Graph card with a metered entity and `chart_type` `bar`. +Screenshot of the statistics graph card with a metered entity and `chart_type` `bar`.

Statistics are gathered every 5 minutes for sensors that support it. It will either keep the `min`, `max`, and `mean` of a sensor's value for a specific hour or the `sum` for a metered entity. If your sensor doesn't work with statistics, check [this](/more-info/statistics/). -To add the Statistics Graph card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: @@ -66,7 +66,7 @@ hide_legend: default: false {% endconfiguration %} -### Options For Entities +### Options for entities If you define entities as objects instead of strings, you can add more customization and configuration: diff --git a/source/_dashboards/thermostat.markdown b/source/_dashboards/thermostat.markdown index 567620b7b31..1979d07be70 100644 --- a/source/_dashboards/thermostat.markdown +++ b/source/_dashboards/thermostat.markdown @@ -1,24 +1,24 @@ --- type: card -title: "Thermostat Card" +title: "Thermostat card" sidebar_label: Thermostat -description: "The Thermostat card gives control of your climate entity, allowing you to change the temperature and mode of the entity." +description: "The thermostat card gives control of your climate entity, allowing you to change the temperature and mode of the entity." --- -The Thermostat card gives control of your [climate](/integrations/#climate) entity, allowing you to change the temperature and mode of the entity. +The thermostat card gives control of your [climate](/integrations/#climate) entity, allowing you to change the temperature and mode of the entity.

Screenshot of the thermostat card - Screenshot of the Thermostat card. + Screenshot of the thermostat card.

-To add the Thermostat card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} All options for this card can be configured via the user interface. ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/tile.markdown b/source/_dashboards/tile.markdown index e8791423cf4..ebaaa242929 100644 --- a/source/_dashboards/tile.markdown +++ b/source/_dashboards/tile.markdown @@ -1,6 +1,6 @@ --- type: card -title: "Tile Card" +title: "Tile card" sidebar_label: Tile description: "The tile card gives you a quick overview of your entity. The card allows you to toggle the entity, show the more-info dialog, or custom actions." --- @@ -9,10 +9,10 @@ The tile card gives you a quick overview of your entity. The card allows you to

Screenshot of tile cards - Screenshot of Tile cards. + Screenshot of tile cards.

-To add the Tile card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the "Add Card" button in the bottom right corner and select **Tile** from the card picker. +{% include dashboard/edit_dashboard.md %} {% configuration %} type: diff --git a/source/_dashboards/vertical-stack.markdown b/source/_dashboards/vertical-stack.markdown index f533c90c31d..0e13b9ce21e 100644 --- a/source/_dashboards/vertical-stack.markdown +++ b/source/_dashboards/vertical-stack.markdown @@ -1,17 +1,17 @@ --- type: card -title: "Vertical Stack Card" -sidebar_label: Vertical Stack -description: "The Vertical Stack card allows you to group multiple cards so they always sit in the same column." +title: "Vertical stack card" +sidebar_label: Vertical stack +description: "The vertical stack card allows you to group multiple cards so they always sit in the same column." --- -The Vertical Stack card allows you to group multiple cards so they always sit in the same column. +The vertical stack card allows you to group multiple cards so they always sit in the same column. -To add the Vertical Stack card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_dashboards/weather-forecast.markdown b/source/_dashboards/weather-forecast.markdown index 7964d29bfb6..5e6f3a4e198 100644 --- a/source/_dashboards/weather-forecast.markdown +++ b/source/_dashboards/weather-forecast.markdown @@ -1,18 +1,18 @@ --- type: card -title: "Weather Forecast Card" -sidebar_label: Weather Forecast -description: "The Weather Forecast card displays the weather. Very useful to include on interfaces that people display on the wall." +title: "Weather forecast card" +sidebar_label: Weather forecast +description: "The weather forecast card displays the weather. Very useful to include on interfaces that people display on the wall." --- -The Weather Forecast card displays the weather. Very useful to include on interfaces that people display on the wall. +The weather forecast card displays the weather. This card is particularly useful on wall-mounted displays.

Screenshot of the weather card - Screenshot of the Weather card. + Screenshot of the weather card.

-To add the Weather card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. +{% include dashboard/edit_dashboard.md %} ## Card settings @@ -41,7 +41,7 @@ Theme: ## YAML configuration -The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI. +The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI. {% configuration %} type: diff --git a/source/_includes/dashboard/edit_dashboard.md b/source/_includes/dashboard/edit_dashboard.md new file mode 100644 index 00000000000..d826f6906b9 --- /dev/null +++ b/source/_includes/dashboard/edit_dashboard.md @@ -0,0 +1,8 @@ +{% capture name %}{{ include.name | default: page.title }}{% endcapture %} +{% capture domain %}{{ include.domain | default: page.ha_domain }}{% endcapture %} +{% capture title %}{{ include.title | default: page.title }}{% endcapture %} + +To add the {{ title | downcase }} to your user interface: +1. In the top right of the screen, select the three dots menu and then select **Edit dashboard**. + - By editing the dashboard, you are taking over control of this dashboard. This means that it is no longer automatically updated when new dashboard elements become available. To continue, in the dialog, select **Take control**. +2. In the bottom right corner, select the **Add card** button and select from the card picker. diff --git a/source/dashboards/actions.markdown b/source/dashboards/actions.markdown index 25bfa59cae0..31de1e1b0aa 100644 --- a/source/dashboards/actions.markdown +++ b/source/dashboards/actions.markdown @@ -12,9 +12,9 @@ Actions can be enabled on: - [Glance](/dashboards/glance/) - [Light](/dashboards/light/) - [Picture](/dashboards/picture/) -- [Picture Element](/dashboards/picture-elements/) -- [Picture Entity](/dashboards/picture-entity/) -- [Picture Glance](/dashboards/picture-glance/) +- [Picture element](/dashboards/picture-elements/) +- [Picture entity](/dashboards/picture-entity/) +- [Picture glance](/dashboards/picture-glance/) ## Tap-Action @@ -202,7 +202,7 @@ double_tap_action: default: none {% endconfiguration %} -## Options For Confirmation +## Options for confirmation If you define confirmation as an object instead of boolean, you can add more customization and configurations. @@ -229,7 +229,7 @@ exemptions: type: list {% endconfiguration %} -## Options For Exemptions +## Options for exemptions {% configuration exemptions %} user: diff --git a/source/dashboards/badges.markdown b/source/dashboards/badges.markdown index e64048c79ed..0a32b826a5e 100644 --- a/source/dashboards/badges.markdown +++ b/source/dashboards/badges.markdown @@ -63,7 +63,7 @@ state_filter: type: list {% endconfiguration %} -### Options For Entities +### Options for entities If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configurations: @@ -94,7 +94,7 @@ state_filter: type: list {% endconfiguration %} -### Options For state_filter +### Options for state filter If you define state_filter as objects instead of strings (by adding `value:` before your state value), you can add more customization to your filter: diff --git a/source/dashboards/views.markdown b/source/dashboards/views.markdown index 77d9efb8614..27423182592 100644 --- a/source/dashboards/views.markdown +++ b/source/dashboards/views.markdown @@ -73,7 +73,7 @@ views: ... ``` -### Options For Visible +### Options for visible objects If you define `visible` as objects instead of a boolean to specify conditions for displaying the view tab: