Skip to content

Areas dashboard: add description #38716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 24, 2025
Merged

Areas dashboard: add description #38716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc4a791
Areas dashboard: add description
c0ffeeca7 Apr 24, 2025
51844c9
Fix typo
c0ffeeca7 Apr 24, 2025
1782625
Fix alt text
c0ffeeca7 Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 35 additions & 4 deletions source/dashboards/dashboards.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ related:
title: Views
- docs: /dashboards/iframe/
title: Webpage card
- docs: /docs/organizing/
title: Grouping your assets
- docs: /docs/organizing/areas/
title: Grouping by areas
---

You can define multiple dashboards in Home Assistant. Each dashboard can be added to the sidebar. This makes it possible to create separate control dashboards for each individual part of your house.
Expand All @@ -27,6 +31,7 @@ Screenshot of the Dashboard list.

Home Assistant ships with some dashboards out of the box:

- [Areas dashboard (experimental)](#areas-dashboard-experimental)
- Energy dashboard
- [History dashboard](#history-dashboard)
- [Logbook dashboard](#logbook-dashboard)
Expand All @@ -36,6 +41,27 @@ Home Assistant ships with some dashboards out of the box:

Not all of the predefined dashboards are listed under {% my lovelace_dashboards title="**Settings** > **Dashboards**" %}. The **Logbook** and **History** dashboards are powered by their respective integrations.

### Areas dashboard (experimental)

The **Areas** dashboard is prepopulated by default and shows your {% term entities %} [grouped](/docs/organizing/) by [areas](/docs/organizing/areas/).

- It uses the [sections view](/dashboards/sections/) type and [tile cards](/dashboards/tile/).
- The first view shows all your areas and the {% term entities %} that are [assigned to those areas](/docs/organizing/areas/).
- In addition, the dashboard provides a separate view for each area.
- {% term entities Entities%}, such as lights, covers, and cameras are automatically grouped by {% term domain %}.

<p class='img'>
<img src='/images/dashboards/areas-dashboard-overview.png' alt='Screenshot of the Areas default dashboard'>
Screenshot of the Areas default dashboard.
</p>

After you [added the dashboard](#creating-a-new-dashboard), you can edit the **Areas** dashboard:

1. In the top-right corner, select the {% icon "mdi:pencil" %} icon.
2. You can show or hide sections, rearrange the content, or [add badges](/dashboards/badges/).

The **Areas** dashboard is still experimental. It is subject to change and may not always work as intended.

### History dashboard

The predefined **History** dashboard is powered by the [History integration](/integrations/history/). To learn about the data sources used and how to export data, refer to the documentation of the History integration.
Expand Down Expand Up @@ -84,21 +110,26 @@ This will leave the default dashboard intact.
2. Select **Add dashboard**.
![Screenshot of the dashboard list](/images/dashboards/dashboard-manage-02.png)
3. In the dialog, choose one of the options:
- If you want to start with a pre-populated dashboard, choose **Default dashboard**.
- If you want to start with a pre-populated dashboard, choose **Default dashboard** or one of the suggested ones, such as the **Areas** dashboard.
- If you want to start with a completely empty dashboard, choose **New dashboard from scratch**.
![Screenshot of the Add Dashboard dialog showing the Areas dashboard option](/images/dashboards/areas-experimental-dialog.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Verify screenshot path and alt text
Please confirm that the image file areas-experimental-dialog.png exists at the specified location and that the alt text follows the style guide.

🏁 Script executed:

#!/bin/bash
# Verify the screenshot file exists in the repository
fd areas-experimental-dialog.png

Length of output: 146

Verify screenshot path and update alt text

  • The file areas-experimental-dialog.png exists at source/images/dashboards/areas-experimental-dialog.png.
  • Per our alt-text style guide, drop the “Screenshot of” prefix. For example: 
    ![Add Dashboard dialog showing the Areas dashboard option](/images/dashboards/areas-experimental-dialog.png)


4. In the **Add new dashboard** dialog, enter a name and select an icon.
- Define if this dashboard should be visible only to the admin user.
- Define if you want the dashboard to be listed in the sidebar.
- Select **Create**.
- **Result**: The dashboard is added.
5. Open your new dashboard and in the top right of the screen, select the <img height="28px" src="/images/blog/2024-03-dashboard-chapter-1/mdi-edit.png" alt="Edit icon"/> button.
6. If you chose **Default dashboard**, you need to take control before you can edit it:

## Editing a new dashboard

1. Open your new dashboard and in the top right of the screen, select the {% icon "mdi:pencil" %} button.
2. If you are editing a **Default dashboard** for the first time, you need to take control before you can edit it:
- The **Edit dashboard** dialog appears.
- 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.
- Once you've taken control, you can't get this specific dashboard back to update automatically. However, you can create a new default dashboard.
- To continue, in the dialog, select the three dots {% icon "mdi:dots-vertical" %} menu, then select **Take control**.
7. You can now [add a card](/dashboards/cards/#adding-cards-to-your-dashboard) or [add a view](/dashboards/views/#adding-a-view-to-a-dashboard).
3. You can now [add a card](/dashboards/cards/#adding-cards-to-your-dashboard) or [add a view](/dashboards/views/#adding-a-view-to-a-dashboard).

## Deleting a dashboard

Expand Down
Binary file added source/images/dashboards/areas-dashboard-overview.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/dashboards/areas-experimental-dialog.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.