Skip to content

Commit 46ff9f5

Browse files
mririgoyenfrenck
andauthored
Add new documentation concerning icons (home-assistant#22140)
Co-authored-by: Franck Nijhof <git@frenck.dev> Co-authored-by: Franck Nijhof <frenck@frenck.nl>
1 parent 54bf0ef commit 46ff9f5

File tree

7 files changed

+100
-4
lines changed

7 files changed

+100
-4
lines changed

source/_docs/frontend.markdown

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,23 @@ title: "Frontend of Home Assistant"
33
description: "Frontend of Home Assistant."
44
---
55

6-
The frontend of Home Assistant is built with [Polymer](https://www.polymer-project.org/).
6+
The Home Assistant frontend allows users to browse and control the state of their house, manage their automations and configure integrations.
7+
The frontend is built with [Polymer](https://www.polymer-project.org/).
78

89
<p class='img'>
9-
<img src='/images/screenshots/ui2015.png' />
10+
<img src='/images/frontend/ui2022.png' />
1011
</p>
1112

12-
The [User Interface section](/examples/#user-interface) can give you some starting points to expand the frontend.
13+
<div class='note info'>
14+
15+
If you're looking to contribute to the frontend, please refer to the [Frontend Development documentation](/developers/frontend/).
16+
17+
</div>
18+
19+
## Icons
1320

14-
If you want to work on the frontend, please refer to the [Frontend Development documentation](/developers/frontend/).
21+
Home Assistant utilizes the community-driven [Material Design Icons](https://www.materialdesignicons.com/) project for icons in the frontend. The [Icons section](/docs/frontend/icons/) has more information on how to use icons and suggest new ones.
22+
23+
## Examples
24+
25+
The [User Interface section](/examples/#user-interface) can give you some starting points to expand the frontend.

source/_docs/frontend/icons.markdown

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: "Icons"
3+
description: "Material Design Icons in the Home Assistant frontend"
4+
---
5+
6+
<p class='img'>
7+
<img src='/images/frontend/mdi.png' alt='Material Design Icons' />
8+
</p>
9+
10+
Home Assistant utilizes the community-driven [Material Design Icons](https://www.materialdesignicons.com/) (MDI) project for icons in the frontend. The icon library is a superset of the base icon library provided by Google and contains thousands of community-made icons for very specific applications, industries, and use-cases.
11+
12+
## Default Icons
13+
14+
Every entity in Home Assistant has a default icon assigned to it. There are way too many to list out here, but you'll see them in your dashboard. You can [customize any of your entities](/docs/configuration/customizing-devices/#icon) to change the icons displayed to you.
15+
16+
## Finding Icons
17+
18+
### Icon Picker
19+
20+
The most common way you can find icons is by using the icon picker built right into Home Assistant. Click into the "Icon" field when customizing an entity and start typing. The list will filter to icons that match your search criteria. You can also scroll through all available icons when the field is empty.
21+
22+
<p class='img'>
23+
<img src='/images/screenshots/icon-picker.png' alt='Icon Picker in Home Assistant' />
24+
</p>
25+
26+
<div class='note info'>
27+
28+
The icon picker will filter by icon name and by aliases applied to the icon by the MDI project. For example, typing "user" will show you most "account"-named icons.
29+
30+
</div>
31+
32+
### Material Design Icons Picker Browser Extension
33+
34+
The easiest way to browse and find icons outside of Home Assistant is with the official [Material Design Icons Picker](https://github.com/Pictogrammers/MaterialDesignIcons-Picker) browser extension. The extension is available for Chrome, Firefox, and Edge and is maintained by the MDI team.
35+
36+
<p class='img'>
37+
<img src='/images/screenshots/mdi-picker.png' alt='Material Design Icons Picker' />
38+
</p>
39+
40+
<div class='note info'>
41+
42+
Not all icons that appear in the MDI Picker Browser Extension may be available in Home Assistant (yet!). While the browser extension is updated as MDI releases new packages, Home Assistant may lag behind until its next release.
43+
44+
</div>
45+
46+
### MaterialDesignIcons.com
47+
48+
The last way to browse through available icons is on the official website, [MaterialDesignIcons.com](https://materialdesignicons.com).
49+
50+
<div class='note info'>
51+
52+
The official MDI website is updated in real-time as new icons are added. This means an icon you find there may not yet be released or available in Home Assistant (yet!) for several releases. You can check when an icon was added by viewing the [MDI history](https://materialdesignicons.com/history).
53+
54+
</div>
55+
56+
## Suggesting or Contributing New Icons
57+
58+
Being open-source like Home Assistant, the Material Design Icons project is always accepting suggestions and contributions to expand the library.
59+
60+
<div class='note info'>
61+
62+
Before suggesting or creating a new icon, it is very important that you [search the current library](https://materialdesignicons.com) and [search all issues](https://github.com/Templarian/MaterialDesign/issues?q=is%3Aissue), open and closed, on their GitHub. Try searching with different terms that might mean the same thing. (e.g. "user", "person", "account")
63+
64+
</div>
65+
66+
### Suggesting a New Icon
67+
68+
If you have an idea for an icon that isn't currently in the library, but are not interested in creating it yourself, [open a new icon suggestion](https://github.com/Templarian/MaterialDesign/issues/new?assignees=&labels=Icon+Request&template=1_icon_request.yml).
69+
70+
### Contributing a New Icon
71+
72+
If you want to contribute a new icon to the library, familiarize yourself with the [System icons guidelines](https://material.io/design/iconography/system-icons.html#design-principles) in the Material Design system. Then create your icon and [submit it to the MDI team for review](https://github.com/Templarian/MaterialDesign/issues/new?assignees=&labels=Icon+Request%2CContribution&template=2_contribution.yml).
73+
74+
#### Tips for Creating New Icons
75+
76+
- Really pay attention to [Material Design guidelines](https://material.io/design/iconography/system-icons.html#design-principles).
77+
- Keep in mind that icons are meant to be contextual, not literal.
78+
- When it comes to little details, less is more.
79+
- If you're unsure, open an issue with MDI. They're more than happy to help you!
80+
- Not all icons make it into the library and that is okay!
81+
82+
### Suggesting an Icon Alias
83+
84+
Sometimes an icon exists, but you aren't able to find it with the terms you were searching for. If this has ever happened to you, please [open an issue with the MDI team to suggest new aliases](https://github.com/Templarian/MaterialDesign/issues/new?assignees=&labels=Alias&template=4_alias.yml) that can be added to existing icons.

source/_includes/asides/docs_navigation.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ <h1 class="title delta">Topics</h1>
123123
%}
124124
</li>
125125
<li>{% active_link /dashboards Dashboards %}</li>
126+
<li>{% active_link /docs/frontend/icons/ Icons%}</li>
126127
</ul>
127128
</li>
128129
<li>

source/images/frontend/mdi.png

21.7 KB
Loading

source/images/frontend/ui2022.png

210 KB
Loading
5.8 KB
Loading
11 KB
Loading

0 commit comments

Comments
 (0)