Update map.markdown for icon mode #36465
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 pull request updates the documentation for the map card in the dashboard, focusing on the Changes
Sequence DiagramsequenceDiagram
participant User as User
participant MapCard as Map Card
participant Entity as Map Entity
User->>MapCard: Configure label_mode
alt label_mode = icon
MapCard->>Entity: Render entity icon
else label_mode = state
MapCard->>Entity: Render entity state
else default
MapCard->>Entity: Render entity name
end
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
🧹 Nitpick comments (2)
source/_dashboards/map.markdown (2)
149-150: Remove trailing spaces.There are trailing spaces at the end of these lines that should be removed.
- description: When set to `icon`, renders the geolocation entity's icon in the marker instead of text. When set to `state`, renders the entity's state as the label for the map marker instead of the entity's name. - type: string + description: When set to `icon`, renders the geolocation entity's icon in the marker instead of text. When set to `state`, renders the entity's state as the label for the map marker instead of the entity's name. + type: string🧰 Tools
🪛 Markdownlint (0.37.0)
149-149: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
150-150: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
Line range hint
1-1: Consider adding an example with the new icon mode.The documentation would benefit from an example that demonstrates the new
iconmode for both entities and geolocation sources. This would help users better understand how to implement this new feature.Consider adding an example like this:
type: map entities: - entity: device_tracker.demo_paulus label_mode: icon geo_location_sources: - source: nsw_rural_fire_service_feed label_mode: icon
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_dashboards/map.markdown(2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_dashboards/map.markdown
149-149: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
150-150: Expected: 0 or 2; Actual: 4
Trailing spaces
(MD009, no-trailing-spaces)
🔇 Additional comments (3)
source/_dashboards/map.markdown (3)
128-128: LGTM! Clear documentation for the new icon mode.
The updated description clearly explains both the new icon mode and existing state mode, with a helpful note about zone entities.
146-150: LGTM! Well-documented geolocation label modes.
The documentation for geolocation sources' label_mode is clear and consistent with the entity configuration.
🧰 Tools
🪛 Markdownlint (0.37.0)
149-149: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
150-150: Expected: 0 or 2; Actual: 4
Trailing spaces
(MD009, no-trailing-spaces)
Line range hint 1-1: Verify documentation matches frontend implementation.
Since this documentation update corresponds to frontend changes in PR #23247, let's verify the alignment between documentation and implementation.
home-assistant
bot
removed
the
parent-merged
Proposed change
Document new options for
label_modefor map card.Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
label_modeoption for geolocation sources, allowing users to choose between displaying an icon or state as the marker label.Documentation
label_modeoption in entity configuration for improved clarity on its functionality.