Add exclude entities params to area card #39710
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
47e6db8 to
8132e7c
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for the Area card by adding two new parameters—color and exclude_entities—and removing the theme parameter to reflect upcoming feature changes.
- Added a new optional color parameter to customize the icon and hover/focus state.
- Added a new optional exclude_entities parameter to filter out specific entities from the card.
- Removed the theme parameter.
Comments suppressed due to low confidence (1)
source/_dashboards/area.markdown:85
- [nitpick] Consider clarifying in the description how the list provided in the exclude_entities parameter is used. This could include a note on the behavior when an empty list is supplied.
exclude_entities:
Add color and drop theme option Add color and drop theme option Undo gem changes
668e2ce to
8e3703e
Compare
📝 WalkthroughWalkthroughThe documentation for the Area card was updated to reflect recent changes: the deprecated Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant AreaCardDoc
User->>AreaCardDoc: Reads Area card documentation
AreaCardDoc-->>User: Presents updated options (color, exclude_entities, display_type)
User->>AreaCardDoc: References color tokens section for valid values
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_dashboards/area.markdown (4)
43-47: Tighten link + wording for the newcoloroptionSmall copy-editing tweaks will improve clarity and future-proof the link:
- description: Set the color for the icon and the hover/focus state. It accepts [color token](/dashboards/area/#available-colors) or hex color code. + description: Set the color for the icon and its hover/focus states. Accepts a [color token](#available-colors) or a hex color code.• Keeps wording consistent with plural “states”.
• Uses an in-page anchor instead of a hard-coded path, so the link survives any URL restructures.
85-88: Add article + Oxford comma for smoother reading- description: A list of entities that will be excluded from the card. It will affect sensor_classes, alert_classes and features. + description: A list of entities that will be excluded from the card. It will affect the `sensor_classes`, `alert_classes`, and `features`.Minor grammar/readability polish; no content change.
105-115: Showcase the new options in the “Complex example”Since this block is meant to demonstrate advanced usage, consider including the newly-added
colorandexclude_entitiesproperties so readers instantly see them in context:area: bedroom display_type: picture navigation_path: my_bedroom + color: indigo sensor_classes: - temperature - humidity alert_classes: - moisture - motion features: - type: area-controls + exclude_entities: + - light.bedroom_lampHelps users adopt the new features without hunting through docs.
117-119: Light grammar touch-up in “Available colors” header-You want to colorize the area card? Choose one of the following colors: +Want to colorize the area card? Choose one of the following colors:Removes an extra auxiliary verb for smoother phrasing.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (1)
Gemfile.lockis excluded by!**/*.lock
📒 Files selected for processing (1)
source/_dashboards/area.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_dashboards/area.markdown
[grammar] ~118-~118: It seems that an auxiliary verb is missing at the beginning of this question.
Context: ...area-controls ``` ## Available colors You want to colorize the area card? Choose ...
(PRP_VB_QUESTION)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_dashboards/area.markdown (4)
43-47: Polish wording + give a concrete example forcolorMinor copy-editing makes the sentence flow better and an inline example clarifies the expected value format.
-color: - required: false - description: Set the color for the icon and the hover/focus state. It accepts [color token](/dashboards/area/#available-colors) or hex color code. - type: string +color: + required: false + description: Set the color of the icon and its hover/focus state. Accepts a [color token](/dashboards/area/#available-colors) or a hex color code (e.g., `#FF0000`). + type: string
85-88: Tighten description ofexclude_entitiesShorter wording and code-style formatting improve readability.
-exclude_entities: - required: false - description: A list of entities that will be excluded from the card. It will affect sensor_classes, alert_classes and features. - type: list +exclude_entities: + required: false + description: List of entities to hide from this card. Applies to `sensor_classes`, `alert_classes`, and `features`. + type: list
105-115: Extend complex example to showcase the new parametersIncluding the freshly documented
colorandexclude_entitiesmakes the example self-contained and demonstrates typical usage.type: area area: bedroom display_type: picture +color: teal navigation_path: my_bedroom sensor_classes: - temperature - humidity alert_classes: - moisture - motion features: - type: area-controls +exclude_entities: + - switch.bedroom_lamp
117-119: Grammar & punctuation tweak in “Available colors” section-You want to colorize the area card? Choose one of the following colors: `primary`, `accent`, `disabled`, `red`, `pink`, `purple`, `deep-purple`, `indigo`, `blue`, `light-blue`, `cyan`, `teal`, `green`, `light-green`, `lime`, `yellow`, `amber`, `orange`, `deep-orange`, `brown`, `grey`, `blue-grey`, `black` and `white`. +To colorize the area card, choose one of the following color tokens: `primary`, `accent`, `disabled`, `red`, `pink`, `purple`, `deep-purple`, `indigo`, `blue`, `light-blue`, `cyan`, `teal`, `green`, `light-green`, `lime`, `yellow`, `amber`, `orange`, `deep-orange`, `brown`, `grey`, `blue-grey`, `black`, or `white`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (1)
Gemfile.lockis excluded by!**/*.lock
📒 Files selected for processing (1)
source/_dashboards/area.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_dashboards/area.markdown
[grammar] ~118-~118: It seems that an auxiliary verb is missing at the beginning of this question.
Context: ...area-controls ``` ## Available colors You want to colorize the area card? Choose ...
(PRP_VB_QUESTION)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_dashboards/area.markdown (3)
43-46: Minor grammar tweak forcolordescription
Add an article before “color token” and keep parallel structure for clarity.- description: Set the color for the icon and the hover/focus state. It accepts [color token](/dashboards/area/#available-colors) or hex color code. + description: Set the color for the icon and the hover/focus state. It accepts a [color token](/dashboards/area/#available-colors) or a hex color code.
85-88: Streamline wording ofexclude_entitiesdescription
Using the simple present makes the sentence shorter and clearer.- description: A list of entities that will be excluded from the card. It will affect sensor_classes, alert_classes, and features. + description: A list of entities to exclude from the card. This affects `sensor_classes`, `alert_classes`, and `features`.
117-119: Fix awkward question phrasing in “Available colors” section
LanguageTool flagged the missing auxiliary verb; dropping it reads better in documentation.-You want to colorize the area card? Choose one of the following colors: `primary`, `accent`, `disabled`, `red`, `pink`, `purple`, `deep-purple`, `indigo`, `blue`, `light-blue`, `cyan`, `teal`, `green`, `light-green`, `lime`, `yellow`, `amber`, `orange`, `deep-orange`, `brown`, `grey`, `blue-grey`, `black`, and `white`. +Want to colorize the area card? Choose one of the following colors: `primary`, `accent`, `disabled`, `red`, `pink`, `purple`, `deep-purple`, `indigo`, `blue`, `light-blue`, `cyan`, `teal`, `green`, `light-green`, `lime`, `yellow`, `amber`, `orange`, `deep-orange`, `brown`, `grey`, `blue-grey`, `black`, and `white`.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_dashboards/area.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_dashboards/area.markdown
[grammar] ~118-~118: It seems that an auxiliary verb is missing at the beginning of this question.
Context: ...area-controls ``` ## Available colors You want to colorize the area card? Choose ...
(PRP_VB_QUESTION)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
Proposed change
Adds two new parameters for the area card :
colorexclude_entitiesRemove one parameter for the area card :
themeType of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit