Map card: add "unit" option #38535

ildar170975 · 2025-04-14T19:51:41Z

Proposed change

Added prefix & suffix options (home-assistant/frontend#25033).
Update: no prefix, only unit (former suffix).

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase: Map card: add prefix & suffix for "label_mode: attribute" frontend#25033
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Updated map card documentation to include new optional unit fields for both entity and source configurations, allowing specification of units for attribute values when using attribute label mode.

netlify · 2025-04-14T19:51:58Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`425f74a`
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/68389e1ff478b20008ff75bd
😎 Deploy Preview	https://deploy-preview-38535--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2025-04-14T19:59:58Z

📝 Walkthrough

Walkthrough

The documentation for the map card's YAML configuration was updated to include a new optional string field, unit, within both the entity and source configuration objects. This field specifies a unit for attribute values when label_mode is set to attribute. No application logic or control flow was changed.

Changes

File	Change Summary
source/_dashboards/map.markdown	Added optional `unit` field to `entity` and `source` config objects in map card YAML documentation

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.

📜 Recent 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

📥 Commits

Reviewing files that changed from the base of the PR and between 3605f6a and 425f74a.

📒 Files selected for processing (1)

source/_dashboards/map.markdown (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

source/_dashboards/map.markdown

⏰ 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

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

source/_dashboards/map.markdown (2)

139-146: Entity Configuration: New Prefix and Suffix Fields Added
The new prefix and suffix fields are correctly added to the entity configuration block. Their optional nature and type (string) are clearly specified, and the descriptions are consistent with related fields such as attribute.

It might be beneficial to include an example or a brief note in the documentation that illustrates how these fields affect the displayed label when label_mode is set to attribute, to further aid user understanding.

172-179: Geolocation Source: New Prefix and Suffix Fields Added
The addition of prefix and suffix fields in the geolocation sources configuration is well aligned with the updates in the entity configuration. The optional status, type declaration, and descriptions are consistent and clear.

As with the entities section, consider adding an example usage or note in the documentation to demonstrate the impact of these settings for users.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 99032bb and 3605f6a.

📒 Files selected for processing (1)

source/_dashboards/map.markdown (2 hunks)

frenck

✅ Approved. Can be merged as soon as the parent PR gets merged.

add "prefix" & "suffix" options

3605f6a

home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Apr 14, 2025

github-project-automation bot added this to Documentation PRs Apr 14, 2025

github-project-automation bot moved this to Todo in Documentation PRs Apr 14, 2025

ildar170975 mentioned this pull request Apr 14, 2025

Map card: add prefix & suffix for "label_mode: attribute" home-assistant/frontend#25033

Merged

9 tasks

ildar170975 marked this pull request as ready for review April 14, 2025 19:53

coderabbitai bot reviewed Apr 14, 2025

View reviewed changes

frenck previously approved these changes Apr 14, 2025

View reviewed changes

github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 14, 2025

frenck added the awaits-parent Awaits the merge of an parent PR label Apr 14, 2025

ildar170975 marked this pull request as draft May 29, 2025 15:15

remove prefix, rename suffix -> unit

0c88e58

ildar170975 dismissed frenck’s stale review via 0c88e58 May 29, 2025 15:16

ildar170975 changed the title ~~Map card: add "prefix" & "suffix" options~~ Map card: add "unit" option May 29, 2025

ildar170975 marked this pull request as ready for review May 29, 2025 17:49

Merge branch 'next' into map-card-prefix-suffix

425f74a

home-assistant bot added the parent-merged The parent PR has been merged already label May 30, 2025

silamon approved these changes Jun 3, 2025

View reviewed changes

silamon merged commit 28c56e7 into home-assistant:next Jun 3, 2025
7 checks passed

home-assistant bot removed awaits-parent Awaits the merge of an parent PR parent-merged The parent PR has been merged already labels Jun 3, 2025

ildar170975 deleted the map-card-prefix-suffix branch June 4, 2025 00:00

github-actions bot locked and limited conversation to collaborators Jun 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Map card: add "unit" option #38535

Map card: add "unit" option #38535

Uh oh!

ildar170975 commented Apr 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented Apr 14, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Apr 14, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

frenck left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Map card: add "unit" option #38535

Map card: add "unit" option #38535

Uh oh!

Conversation

ildar170975 commented Apr 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

netlify bot commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

coderabbitai bot commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

frenck left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ildar170975 commented Apr 14, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Apr 14, 2025 •

edited

Loading

coderabbitai bot commented Apr 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)