Add entity badge #33866
Add entity badge #33866
Conversation
home-assistant
bot
added
has-parent
WalkthroughWalkthroughThis update enhances the configuration documentation for dashboards by introducing detailed guidelines for the "Entity Badge" feature in 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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (2)
source/_dashboards/tile.markdown (1)
64-64: Improve description for clarity.The description can be improved by forming a complete sentence.
- Content to display for the state. Can be `state`, `last_changed`, `last_updated`, or any attribute of the entity. Can be either a string with a single item, or a list of string items. Default depends on the entity domain. + The content to display for the state. It can be `state`, `last_changed`, `last_updated`, or any attribute of the entity. It can be either a string with a single item, or a list of string items. The default depends on the entity domain.Tools
LanguageTool
[style] ~64-~64: To form a complete sentence, be sure to include a subject.
Context: ...> Content to display for the state. Can bestate,last_changed, `last_updat...(MISSING_IT_THERE)
[style] ~64-~64: To form a complete sentence, be sure to include a subject.
Context: ...dated`, or any attribute of the entity. Can be either a string with a single item, ...(MISSING_IT_THERE)
source/dashboards/badges.markdown (1)
57-57: Improve description for clarity.The description can be improved by forming a complete sentence.
- Content to display for the state. Can be `state`, `last_changed`, `last_updated`, or any attribute of the entity. Can be either a string with a single item, or a list of string items. Default depends on the entity domain. + The content to display for the state. It can be `state`, `last_changed`, `last_updated`, or any attribute of the entity. It can be either a string with a single item, or a list of string items. The default depends on the entity domain.Tools
LanguageTool
[style] ~57-~57: To form a complete sentence, be sure to include a subject.
Context: ...> Content to display for the state. Can bestate,last_changed, `last_updat...(MISSING_IT_THERE)
[style] ~57-~57: To form a complete sentence, be sure to include a subject.
Context: ...dated`, or any attribute of the entity. Can be either a string with a single item, ...(MISSING_IT_THERE)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (3)
source/dashboards/badges.markdown (3)
41-41: Consider adding the article "the".The sentence might be missing the article "the" before "state".
- By default, the color is based on `state`, `domain`, and `device_class` of your entity. + By default, the color is based on the `state`, `domain`, and `device_class` of your entity.Tools
LanguageTool
[uncategorized] ~41-~41: You might be missing the article “the” here.
Context: ...tive. By default, the color is based onstate,domain, anddevice_classof ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
57-57: Consider revising for clarity.The sentence could be more clear by including a subject and determiner.
- Can be either a string with a single item, or a list of string items. Default depends on the entity domain. + It can be either a string with a single item, or a list of string items. The default depends on the entity domain.Tools
LanguageTool
[style] ~57-~57: To form a complete sentence, be sure to include a subject.
Context: ...> Content to display for the state. Can bestate,last_changed, `last_updat...(MISSING_IT_THERE)
[style] ~57-~57: To form a complete sentence, be sure to include a subject.
Context: ...dated`, or any attribute of the entity. Can be either a string with a single item, ...(MISSING_IT_THERE)
[uncategorized] ~57-~57: A determiner appears to be missing. Consider inserting it.
Context: ...single item, or a list of string items. Default depends on the entity domain. type: [...(AI_EN_LECTOR_MISSING_DETERMINER)
55-58: Clarify the description ofstate_content.The description could be more clear by including a subject and determiner.
- Content to display for the state. Can be `state`, `last_changed`, `last_updated`, or any attribute of the entity. Can be either a string with a single item, or a list of string items. Default depends on the entity domain. + The content to display for the state. It can be `state`, `last_changed`, `last_updated`, or any attribute of the entity. It can be either a string with a single item, or a list of string items. The default depends on the entity domain.Tools
LanguageTool
[style] ~57-~57: To form a complete sentence, be sure to include a subject.
Context: ...> Content to display for the state. Can bestate,last_changed, `last_updat...(MISSING_IT_THERE)
[style] ~57-~57: To form a complete sentence, be sure to include a subject.
Context: ...dated`, or any attribute of the entity. Can be either a string with a single item, ...(MISSING_IT_THERE)
[uncategorized] ~57-~57: A determiner appears to be missing. Consider inserting it.
Context: ...single item, or a list of string items. Default depends on the entity domain. type: [...(AI_EN_LECTOR_MISSING_DETERMINER)
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (4)
source/dashboards/badges.markdown (4)
22-23: Improve description for thetypefield.The description "
entity" is not clear. It should specify that the value must beentity.- description: "`entity`" + description: "Must be `entity`"
31-34: Clarify description for thenamefield.The description "Overwrites the entity name" could be clearer. Specify that it overwrites the displayed entity name.
- description: Overwrites the entity name. + description: Overwrites the displayed entity name.
Line range hint
109-111: Clarify description for theentitiesfield.The description "A list of entity IDs or
entityobjects, see below." could be clearer. Specify that it is a list of entity IDs or objects with anentitykey.- description: A list of entity IDs or `entity` objects, see below. + description: A list of entity IDs or objects with an `entity` key, see below.Tools
LanguageTool
[style] ~57-~57: To form a complete sentence, be sure to include a subject.
Context: ...> Content to display for the state. Can bestate,last_changed, `last_updat...(MISSING_IT_THERE)
[style] ~57-~57: To form a complete sentence, be sure to include a subject.
Context: ...dated`, or any attribute of the entity. Can be either a string with a single item, ...(MISSING_IT_THERE)
Line range hint
233-235: Clarify description for thestatefield.The description "Entity state or ID to be equal to this value." could be clearer. Specify that it is the entity state or ID that must be equal to the specified value.
- description: Entity state or ID to be equal to this value. + description: The entity state or ID that must be equal to this value.Tools
LanguageTool
[style] ~57-~57: To form a complete sentence, be sure to include a subject.
Context: ...> Content to display for the state. Can bestate,last_changed, `last_updat...(MISSING_IT_THERE)
[style] ~57-~57: To form a complete sentence, be sure to include a subject.
Context: ...dated`, or any attribute of the entity. Can be either a string with a single item, ...(MISSING_IT_THERE)
Proposed change
Add new badge : the entity badge
I also replaced the screenshot at the top as this badge will be the default. Another PR will come to remove the
state-labelone as it will be replaced by this one.I also fixed
state_contentdescription (last_changedandlast_updated).Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit