Skip to content

Commit 9452b99

Browse files
committed
docs(en): icons page
1 parent ceba903 commit 9452b99

File tree

1 file changed

+95
-0
lines changed

1 file changed

+95
-0
lines changed

Diff for: docs/reference/icons.md

+95
Original file line numberDiff line numberDiff line change
@@ -1 +1,96 @@
11
# Icons
2+
3+
## Link
4+
5+
Link to the image. You can specify both external and internal links.
6+
7+
```yaml
8+
url: icons/example.svg
9+
```
10+
11+
::: info
12+
For an internal link, you need to add a folder to the docker container. More details are written in
13+
[getting started](../guide/getting-started.md).
14+
:::
15+
16+
## Name
17+
18+
Icon name from [iconify](https://icon-sets.iconify.design/) or [emoji](https://getemoji.com/).
19+
20+
```yaml
21+
name: simple-icons:homeassistant
22+
```
23+
24+
## Bubble
25+
26+
Wraps the icon in a bubble, necessary if the icon has no background or indentation on the sides.
27+
28+
```yaml
29+
bubble: true
30+
```
31+
32+
## Color
33+
34+
Icon color. You can specify any value from [css](https://developer.mozilla.org/ru/docs/Web/CSS/color_value).
35+
36+
```yaml
37+
color: '#3dbcf3'
38+
```
39+
40+
::: warning
41+
If you use an image link, no color will be applied to the icon.
42+
:::
43+
44+
## Background
45+
46+
Icon background. You can specify any value from [css](https://developer.mozilla.org/ru/docs/Web/CSS/background).
47+
48+
```yaml
49+
background: '#eee'
50+
```
51+
52+
## Examples
53+
54+
### Emoji
55+
56+
```yaml
57+
services:
58+
- title: Home Assistant
59+
description: Home automation
60+
link: https://home-assistant.home.local/
61+
icon:
62+
name: 👋
63+
```
64+
65+
### Iconify
66+
67+
```yaml
68+
services:
69+
- title: Home Assistant
70+
description: Home automation
71+
link: https://home-assistant.home.local/
72+
icon:
73+
name: simple-icons:homeassistant
74+
```
75+
76+
### Local icons
77+
78+
```yaml
79+
services:
80+
- title: Home Assistant
81+
description: Home automation
82+
link: https://home-assistant.home.local/
83+
icon:
84+
url: icons/example.svg
85+
```
86+
87+
### External link
88+
89+
```yaml
90+
services:
91+
- title: Home Assistant
92+
description: Home automation
93+
link: https://home-assistant.home.local/
94+
icon:
95+
url: https://mafl.hywax.space/logotype.svg
96+
```

0 commit comments

Comments
 (0)