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

Better resizing support for thermostat card #21120

Merged
merged 5 commits into from
Jun 26, 2024

Conversation

piitaya
Copy link
Member

@piitaya piitaya commented Jun 20, 2024

Proposed change

Thermostat card now better supports resizing in a grid.

Before

CleanShot_2024-06-20_at_16.08.04.mp4

After

CleanShot_2024-06-20_at_16.08.36.mp4

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

    • Improved responsiveness for the Humidifier and Thermostat cards, ensuring they dynamically adjust to container size changes.
  • Style

    • Enhanced styling for Humidifier and Thermostat cards to better adapt to different container sizes and improve user experience.

Copy link
Contributor

coderabbitai bot commented Jun 20, 2024

Walkthrough

Walkthrough

The updates introduce ResizeController to dynamically manage height adjustments and enhance responsiveness in the HuiHumidifierCard and HuiThermostatCard. These improvements also refine element structure and styling to better adapt to container size changes.

Changes

Files Change Summaries
src/panels/lovelace/cards/hui-humidifier-card.ts - Imported ResizeController
- Added ResizeController instance for dynamic adjustments
- Refined responsive styles
src/panels/lovelace/cards/hui-thermostat-card.ts - Imported ResizeController
- Introduced ResizeController instance
- Adjusted element structure and styles for responsiveness
- Added custom elements and callbacks for connected/disconnected states

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant HuiHumidifierCard
    participant ResizeController

    User->>+Browser: Load hui-humidifier-card
    Browser->>+HuiHumidifierCard: Initialize Component
    HuiHumidifierCard->>+ResizeController: Create ResizeController Instance
    ResizeController->>HuiHumidifierCard: Trigger Callback on Resize
    HuiHumidifierCard-->>Browser: Adjust Component Height
    Browser-->>User: Display updated hui-humidifier-card

    participant User
    participant Browser
    participant HuiThermostatCard
    participant ResizeController

    User->>+Browser: Load hui-thermostat-card
    Browser->>+HuiThermostatCard: Initialize Component
    HuiThermostatCard->>+ResizeController: Create ResizeController Instance
    ResizeController->>HuiThermostatCard: Trigger Callback on Resize
    HuiThermostatCard-->>Browser: Adjust Component Height
    Browser-->>User: Display updated hui-thermostat-card
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between c6b885e and 37440ba.

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

[error] 80-80: Forbidden non-null assertion. (lint/style/noNonNullAssertion)

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator


[error] 124-124: Forbidden non-null assertion. (lint/style/noNonNullAssertion)

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator


[error] 149-149: Forbidden non-null assertion. (lint/style/noNonNullAssertion)

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

src/panels/lovelace/cards/hui-humidifier-card.ts

[error] 88-88: Forbidden non-null assertion. (lint/style/noNonNullAssertion)

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator


[error] 132-132: Forbidden non-null assertion. (lint/style/noNonNullAssertion)

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator


[error] 157-157: Forbidden non-null assertion. (lint/style/noNonNullAssertion)

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

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

135-146: Enhanced responsive layout within ha-card

The use of styleMap to dynamically set styles based on the state is a good approach. However, ensure that prevent-interaction-on-scroll is necessary and correctly implemented as it can affect user interaction.

Consider adding a comment explaining the use of prevent-interaction-on-scroll for future maintainability.


Line range hint 170-235: CSS Styling Consistency and Flexibility

The CSS styles are well-organized and make good use of flexbox to ensure the card components are aligned and spaced properly. The use of :host to set default styles is also noted. However, ensure that the responsive behavior is consistent across different screen sizes.


128-130: Dynamic control width calculation

The logic for dynamically setting the maxWidth based on the ResizeController value is sound. However, ensure that the resize values are being updated correctly in the state to trigger re-renders as necessary.

src/panels/lovelace/cards/hui-humidifier-card.ts (3)

136-138: Dynamic Width Adjustment for Controls

The approach to dynamically adjust the control's width based on the resize controller's value is appropriate. This should help in maintaining a responsive layout.


143-154: Responsive Layout Enhancements in ha-card

The modifications to the card's layout to support responsiveness are well-done. The use of styleMap for dynamic styling based on state is effective. Again, verify the necessity and implementation of prevent-interaction-on-scroll.

A brief comment on the purpose of prevent-interaction-on-scroll would enhance code readability and maintainability.


Line range hint 178-243: Consistency and Flexibility in CSS Styling

The CSS styling is consistent with the thermostat card, utilizing flexbox for alignment and spacing. The responsiveness should be tested across various devices to ensure uniform behavior.


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.

@piitaya piitaya force-pushed the thermostat-humidifier-card-resizing branch from 68591a1 to 4aa5bc1 Compare June 20, 2024 14:15
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: 2

src/panels/lovelace/cards/hui-thermostat-card.ts Outdated Show resolved Hide resolved
src/panels/lovelace/cards/hui-humidifier-card.ts Outdated Show resolved Hide resolved
@@ -26,6 +26,39 @@ import { HumidifierCardConfig } from "./types";

@customElement("hui-humidifier-card")
export class HuiHumidifierCard extends LitElement implements LovelaceCard {
private _resizeObserver?: ResizeObserver;
Copy link
Member

Choose a reason for hiding this comment

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

Can we use the ResizeController from lit-labs instead?

Copy link
Member Author

Choose a reason for hiding this comment

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

I tried without success but now I succeeded 😅

@piitaya piitaya force-pushed the thermostat-humidifier-card-resizing branch from 11cf3cf to c6b885e Compare June 24, 2024 09:29
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: 4

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

Line range hint 165-204: Optimize CSS for better maintainability and performance.

The CSS styles for the .container and host elements can be optimized to reduce redundancy and improve performance, especially during resizing.

-        position: relative;
-        display: block;
-        height: 100%;
-        width: 100%;
-        padding: 0;
-        display: flex;
-        flex-direction: column;
-        align-items: center;
-        justify-content: space-between;
+        position: relative;
+        display: flex;
+        flex-direction: column;
+        align-items: center;
+        justify-content: space-between;
+        height: 100%;
+        width: 100%;
+        padding: 0;
src/panels/lovelace/cards/hui-humidifier-card.ts (1)

Line range hint 173-212: Optimize CSS for better maintainability and performance.

The CSS styles for the .container and host elements can be optimized to reduce redundancy and improve performance, especially during resizing.

-        position: relative;
-        display: block;
-        height: 100%;
-        width: 100%;
-        padding: 0;
-        display: flex;
-        flex-direction: column;
-        align-items: center;
-        justify-content: space-between;
+        position: relative;
+        display: flex;
+        flex-direction: column;
+        align-items: center;
+        justify-content: space-between;
+        height: 100%;
+        width: 100%;
+        padding: 0;

@@ -7,7 +8,7 @@
html,
nothing,
} from "lit";
import { customElement, property, state } from "lit/decorators";
import { customElement, property, query, state } from "lit/decorators";
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider removing unused imports to clean up the code.

While reviewing the imports, ensure that all are necessary for this file. Redundant imports can lead to unnecessary bloat and confusion.

src/panels/lovelace/cards/hui-thermostat-card.ts Outdated Show resolved Hide resolved
src/panels/lovelace/cards/hui-humidifier-card.ts Outdated Show resolved Hide resolved
src/panels/lovelace/cards/hui-humidifier-card.ts Outdated Show resolved Hide resolved
@@ -26,6 +27,18 @@ import { HumidifierCardConfig } from "./types";

@customElement("hui-humidifier-card")
export class HuiHumidifierCard extends LitElement implements LovelaceCard {
// @ts-ignore
Copy link
Member

Choose a reason for hiding this comment

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

Why the @ts-ignore?

Copy link
Member Author

@piitaya piitaya Jun 24, 2024

Choose a reason for hiding this comment

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

Because the property is not used. We already have this pattern in other components.

) as HTMLElement | undefined;
if (!container) return;
const height = container.clientHeight;
container.style.setProperty("--height", `${height}px`);
Copy link
Member

Choose a reason for hiding this comment

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

Why don't we do this inside render instead? We should avoid having side effects here, we should just store clientHeight as the state of the _resizeController

Copy link
Member Author

Choose a reason for hiding this comment

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

I did that do avoid re-render but yeah I will update it to avoid side effect 🙂

Copy link
Member Author

Choose a reason for hiding this comment

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

@bramkragten Done!

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: 2

@bramkragten bramkragten merged commit 128dbbc into dev Jun 26, 2024
13 checks passed
@bramkragten bramkragten deleted the thermostat-humidifier-card-resizing branch June 26, 2024 08:03
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.

2 participants