View background settings #36337
View background settings #36337
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes involve updates to the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
source/dashboards/views.markdown (4)
191-193: Improve clarity of the introductionThe introduction could be more precise about where theme variables should be defined.
-The background can be customied per view using individual background settings. Alternatively, a theme variable can be used to customize the background of all views. +The background can be customized per view using individual background settings. Alternatively, you can define a theme variable in your `configuration.yaml` to customize the background of all views.🧰 Tools
🪛 Markdownlint (0.37.0)
191-191: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
195-199: Add missing commas and fix list formattingFor better readability and consistency with Home Assistant's documentation style:
-**Image** - Sets the background image to use behind the view: - - **Upload picture** lets you pick an image from the system used to show your Home Assistant UI. - - **Local path** lets you pick an image stored on Home Assistant. For example: `/homeassistant/images/lights_view_background_image.jpg`. - - To store an image on Home Assistant, you need to [configure access to files](/common-tasks/os/#configuring-access-to-files), for example via [Samba](/common-tasks/os/#installing-and-using-the-samba-add-on) or the [Studio Code Server](/common-tasks/os/#installing-and-using-the-visual-studio-code-vsc-add-on) add-on. - - **web URL** let you pick an image from the web. For example `https://www.home-assistant.io/images/frontpage/assist_wake_word.png`. +**Image** - Sets the background image to use behind the view: + +- **Upload picture** lets you pick an image from the system used to show your Home Assistant UI. +- **Local path** lets you pick an image stored on Home Assistant. For example, `/homeassistant/images/lights_view_background_image.jpg`. + - To store an image on Home Assistant, you need to [configure access to files](/common-tasks/os/#configuring-access-to-files), for example, via [Samba](/common-tasks/os/#installing-and-using-the-samba-add-on) or the [Studio Code Server](/common-tasks/os/#installing-and-using-the-visual-studio-code-vsc-add-on) add-on. +- **Web URL** lets you pick an image from the web. For example, `https://www.home-assistant.io/images/frontpage/assist_wake_word.png`.🧰 Tools
🪛 LanguageTool
[typographical] ~199-~199: After the expression ‘for example’ a comma is usually used.
Context: ...let you pick an image from the web. For example `https://www.home-assistant.io/images/f...(COMMA_FOR_EXAMPLE)
🪛 Markdownlint (0.37.0)
196-196: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
197-197: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
198-198: Expected: 2; Actual: 5
Unordered list indentation(MD007, ul-indent)
199-199: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
195-195: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
196-196: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
203-216: Standardize list formatting and add blank linesFor consistency with Home Assistant's documentation style:
**Size** - Choose how the background fits the space: -* **Original**: Original size. -* **Fill view**: Fills the view, cropping if necessary. -* **Fit view**: Fits within the view, maintaining aspect ratio. + +- **Original**: Original size. +- **Fill view**: Fills the view, cropping if necessary. +- **Fit view**: Fits within the view, maintaining aspect ratio. **Alignment** - Precisely position the background: -* **Top Alignment**: Top left, top center, or top right -* **Center Alignment**: Center left, center, or center right -* **Bottom Alignment**: Bottom left, bottom center, or bottom right + +- **Top Alignment**: Top left, top center, or top right +- **Center Alignment**: Center left, center, or center right +- **Bottom Alignment**: Bottom left, bottom center, or bottom right **Repeat** - Controls whether the background repeats across the view: -* **Repeat**: Tiles the background. -* **No-repeat**: Prevents tiling, showing the image only once. + +- **Repeat**: Tiles the background. +- **No-repeat**: Prevents tiling, showing the image only once.🧰 Tools
🪛 Markdownlint (0.37.0)
204-204: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
205-205: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
206-206: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
209-209: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
210-210: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
211-211: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
214-214: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
215-215: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
204-204: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
204-204: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
209-209: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
214-214: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
219-228: Improve YAML example clarityThe YAML example could be more helpful with additional context:
-# Example background section in view yaml +# Example view configuration with background settings background: image: /local/background.png settings: - transparency: 50 # any percentage between 0 and 100 - size: auto # auto, cover, contain - alignment: center # top left, top center, top right, center left, center, center right, bottom left, bottom center, bottom right - repeat: no-repeat # repeat, no-repeat + transparency: 50 # Percentage between 0 (opaque) and 100 (transparent) + size: cover # Options: auto (original), cover (fill view), contain (fit view) + alignment: center # Options: top left, top center, top right, center left, center, center right, bottom left, bottom center, bottom right + repeat: no-repeat # Options: repeat (tile), no-repeat (single instance)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/dashboards/views.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/dashboards/views.markdown
[typographical] ~199-~199: After the expression ‘for example’ a comma is usually used.
Context: ...let you pick an image from the web. For example `https://www.home-assistant.io/images/f...
(COMMA_FOR_EXAMPLE)
[uncategorized] ~232-~232: A comma is probably missing here.
Context: ...CSS variable lovelace-background. For wallpapers you probably want to use the example be...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
🪛 Markdownlint (0.37.0)
source/dashboards/views.markdown
204-204: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
205-205: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
206-206: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
209-209: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
210-210: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
211-211: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
214-214: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
215-215: Expected: dash; Actual: asterisk
Unordered list style
(MD004, ul-style)
196-196: Expected: 0; Actual: 3
Unordered list indentation
(MD007, ul-indent)
197-197: Expected: 0; Actual: 3
Unordered list indentation
(MD007, ul-indent)
198-198: Expected: 2; Actual: 5
Unordered list indentation
(MD007, ul-indent)
199-199: Expected: 0; Actual: 3
Unordered list indentation
(MD007, ul-indent)
191-191: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
195-195: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
204-204: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
196-196: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
204-204: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
209-209: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
214-214: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
🔇 Additional comments (2)
source/dashboards/views.markdown (2)
62-63: LGTM!
Clear and helpful reference to the detailed background settings section.
304-305: LGTM!
The configuration reference accurately describes the background option.
Proposed change
Documentation changes for the view background settings coming in.
Not really happy about how it is presented right now, so suggestions are welcome.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit