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

Fix hass object in nested hui-card #21178

Merged
merged 1 commit into from
Jun 26, 2024
Merged

Fix hass object in nested hui-card #21178

merged 1 commit into from
Jun 26, 2024

Conversation

piitaya
Copy link
Member

@piitaya piitaya commented Jun 26, 2024

Proposed change

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

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
    • Enhanced card components with improved update handling, ensuring that display and preview settings are more reliably synchronized.

@piitaya piitaya added this to the 2024.7 milestone Jun 26, 2024
Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Walkthrough

Walkthrough

The recent update to the HuiCard class involves assigning the hass and preview properties from the HuiCard instance (this) to the element parameter specifically within the ll-upgrade event listener. After making these assignments, a "card-updated" event is fired to signal that the card properties have been updated.

Changes

File Path Change Summary
src/panels/.../hui-card.ts Added assignments to element.hass and element.preview within the ll-upgrade event, and fired a card-updated event.

Sequence Diagram(s)

sequenceDiagram
    participant HuiCard
    participant Element

    HuiCard->>Element: listen for 'll-upgrade'
    Note over HuiCard: On 'll-upgrade' event
    HuiCard->>Element: assign hass and preview properties
    HuiCard->>Element: fire "card-updated" event
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between d9f1b06 and 4349bbd.

Files selected for processing (1)
  • src/panels/lovelace/cards/hui-card.ts (1 hunks)
Additional context used
Biome
src/panels/lovelace/cards/hui-card.ts

[error] 98-98: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.


[error] 142-142: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.


[error] 150-150: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.


[error] 151-151: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.


[error] 162-162: Unexpected any. Specify a different type. (lint/suspicious/noExplicitAny)

any disables many type checking rules. Its use should be avoided.

Additional comments not posted (2)
src/panels/lovelace/cards/hui-card.ts (2)

108-109: Ensure correct event handling and property propagation in ll-upgrade.

The changes correctly propagate hass and preview properties to the element during the ll-upgrade event, which is crucial for maintaining state consistency in nested components. This aligns with the PR's objectives to fix related issues.


109-109: Add triggering of card-updated event.

Triggering a card-updated event after setting properties ensures that any listeners for this event can react appropriately, potentially updating UI or state based on the new properties. This is a good practice for components that might have interconnected dependencies.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range comments (1)
src/panels/lovelace/cards/hui-card.ts (1)

Line range hint 98-98: Specify explicit types instead of any to enhance type safety.

Using any type can lead to potential runtime errors and makes the codebase harder to maintain due to lack of explicit type checking. Consider defining more specific types for error handling or other uses.

- catch (e: any) {
+ catch (e: Error) {

Please apply this change to all instances where any type is used if feasible.

Also applies to: 142-142, 150-150, 151-151, 162-162

@piitaya piitaya enabled auto-merge (squash) June 26, 2024 21:01
@piitaya piitaya merged commit b08b671 into dev Jun 26, 2024
10 checks passed
@piitaya piitaya deleted the fix_nested_card_loading branch June 26, 2024 21:05
piitaya added a commit that referenced this pull request Jun 26, 2024
* Fix undefined value in search (#21175)

* Fix hass object in nested hui-card (#21178)

* Bumped version to 20240626.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Vertical stack breaks cards
2 participants