Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate entity, device and area name in more info dialog header and entity picker #21951

Draft
wants to merge 7 commits into
base: dev
Choose a base branch
from

Conversation

piitaya
Copy link
Member

@piitaya piitaya commented Sep 11, 2024

Proposed change

An attempt to improve more info dialog for entities.
For now it uses the backward compatibility with friendly_name. We should use entry registry for that but has_entity_name should be exposed in EntityRegistryDisplayEntry for that.

Needs home-assistant/core#125832

More info dialog

With device and area
CleanShot 2024-09-11 at 15 54 15

Using device name as entity name (or empty entity name)
CleanShot 2024-09-11 at 15 54 28

No device, no area
CleanShot 2024-09-11 at 15 57 00

Entity picker

CleanShot 2024-09-11 at 18 56 13

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue or discussion:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Summary by CodeRabbit

  • New Features

    • Introduced utility functions for computing area, device, and entity names, enhancing clarity and usability in the application.
    • Updated the MoreInfoDialog to display more structured information, including device and area names alongside the main entity name.
  • Bug Fixes

    • Improved error handling for name retrieval, ensuring robustness when accessing area and device names.
  • Style

    • Enhanced visual layout of the MoreInfoDialog with updated styling for title and subtitle presentation.

Copy link
Contributor

coderabbitai bot commented Sep 11, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces several utility functions for computing names associated with areas, devices, and entities in a Home Assistant environment. New files are created to define these functions, which enhance the retrieval and presentation of entity-related information. Additionally, modifications are made to the MoreInfoDialog component to utilize these new functions, improving the display of contextual information about entities.

Changes

Files Change Summary
src/common/entity/compute_area_name.ts Added a utility function computeAreaName to extract and return the trimmed name of an area from an AreaRegistryEntry object.
src/common/entity/compute_device_name.ts Introduced computeDeviceName to return a string or undefined representing the name of a device, prioritizing name_by_user over name.
src/common/entity/compute_entity_name.ts Added functions computeEntityName, computeEntityDeviceName, and computeEntityAreaName to compute names based on state, device, and area IDs.
src/dialogs/more-info/ha-more-info-dialog.ts Updated the MoreInfoDialog to use new utility functions for computing entity names, areas, and devices, enhancing the information displayed in the dialog.

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?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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 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.

@piitaya piitaya marked this pull request as draft September 11, 2024 14:00
@piitaya piitaya changed the title Separate entity, device and area name in more info dialog header Separate entity, device and area name in more info dialog header and entity picker Sep 11, 2024
@piitaya piitaya force-pushed the entity_name_more_info_dialogs branch 2 times, most recently from 38e8471 to 5456a65 Compare September 18, 2024 15:58
@piitaya piitaya added backend merged The backend PR for this frontend PR has been merged and removed wait for backend labels Oct 30, 2024
@piitaya piitaya force-pushed the entity_name_more_info_dialogs branch from 5456a65 to 8464b00 Compare October 30, 2024 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend merged The backend PR for this frontend PR has been merged cla-signed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant