Skip to content

Commit 785f786

Browse files
perjuryfrenck
andcommitted
Consistency and readability (#11897)
* Consistency and readability Change headings to match key names to avoid confusion (e.g heading Path instead of Paths to describe the Path key) Also readability changes to make the documentation clearer. * Update views.markdown * Update views.markdown * Update source/lovelace/views.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * Update source/lovelace/views.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl> Co-authored-by: Franck Nijhof <frenck@frenck.nl>
1 parent 8a7e31a commit 785f786

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

source/lovelace/views.markdown

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ views:
5757
default: true
5858
{% endconfiguration %}
5959

60-
## Options For Visible
60+
### Options For Visible
6161

6262
If you define `visible` as objects instead of a boolean to specify conditions for displaying the view tab:
6363

@@ -83,11 +83,11 @@ View config:
8383
image: /local/lights.png
8484
```
8585
86-
## Paths
86+
## Path
8787
88-
You can link to one view from another view by its path. For this use cards that support navigation (`navigation_path`). Do not use special characters in paths. Do not begin a path with a number. This will cause the parser to read your path as a view index.
88+
You can link to one view from a card in another view when using cards that support navigation (`navigation_path`). The string supplied here will be appended to the string `/lovelace/` to create the path to the view. Do not use special characters in paths. Do not begin a path with a number. This will cause the parser to read your path as a view index.
8989

90-
### Example
90+
#### Example
9191

9292
View config:
9393

@@ -107,11 +107,11 @@ Picture card config:
107107
navigation_path: /lovelace/living_room
108108
```
109109

110-
## Icons
110+
## Icon
111111

112112
If you define an icon the title will be used as a tool-tip.
113113

114-
### Example
114+
#### Example
115115

116116
```yaml
117117
- title: Garden
@@ -122,7 +122,7 @@ If you define an icon the title will be used as a tool-tip.
122122

123123
You can specify the visibility of views as a whole or per-user. (Note: This is only for the display of the tabs. The url path is still accessible)
124124

125-
### Example
125+
#### Example
126126

127127
```yaml
128128
views:
@@ -142,11 +142,11 @@ views:
142142
...
143143
```
144144

145-
## Panel mode
145+
## Panel
146146

147-
This renders the first card on full width, other cards in this view will not be rendered. Good for cards like `map`, `stack` or `picture-elements`.
147+
Setting panel true sets the view to panel mode. In this mode the first card is rendered full-width, other cards in the view will not be rendered. This mode is good when using cards like `map`, `stack` or `picture-elements`.
148148

149-
### Example
149+
#### Example
150150

151151
```yaml
152152
- title: Map
@@ -158,18 +158,18 @@ This renders the first card on full width, other cards in this view will not be
158158
- zone.home
159159
```
160160

161-
## Themes
161+
## Theme
162162

163163
Set a separate [theme](/integrations/frontend/#themes) for the view and its cards.
164164

165-
### Example
165+
#### Example
166166

167167
```yaml
168168
- title: Home
169169
theme: happy
170170
```
171171

172-
### Background
172+
## Background
173173

174174
You can style the background of your views with a [theme](/integrations/frontend/#themes). You can use the CSS variable `lovelace-background`. For wallpapers you probably want to use the example below, more options can be found [here](https://developer.mozilla.org/en-US/docs/Web/CSS/background).
175175

0 commit comments

Comments
 (0)