Use layout property for panel view

[piitaya]

Proposed change

Use layout property for panel view instead of isPanel property. Backward compatibilility has been added for custom cards.

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:

• Documentation added/updated for www.home-assistant.io

Summary by CodeRabbit

• Refactor

  • Replaced isPanel property with layout property across multiple card components for improved layout flexibility.
  • Updated logic to conditionally handle layout values, enhancing error handling and card configuration.

• New Features

  • Introduced layout property in cards to support various layout configurations such as "panel" and "grid".

• Bug Fixes

  • Fixed issues related to incorrect panel layouts by refining layout property handling.

[coderabbitai]

Walkthrough

Walkthrough

The changes primarily involve updating the HuiCard and related classes to use a layout string property instead of a isPanel boolean property. This modification refines the behavior and error handling related to the layout property, affecting how different card classes manage layout configurations and conditions.

Changes

File Path	Summary of Changes
src/panels/lovelace/cards/hui-card.ts	Adjusted logic for layout property and removed isPanel property.
src/panels/lovelace/cards/hui-entity-filter-card.ts	Replaced isPanel boolean with layout string.
src/panels/lovelace/cards/hui-iframe-card.ts	Removed isPanel property and adjusted related logic.
src/panels/lovelace/cards/hui-map-card.ts	Removed isPanel, introduced optional layout property. Modified _computePadding() method.
src/panels/lovelace/cards/hui-stack-card.ts	Replaced isPanel with layout and updated corresponding logic.
src/panels/lovelace/types.ts	Removed isPanel from LovelaceCard interface.
src/panels/lovelace/views/hui-panel-view.ts	Updated PanelView to set layout to "panel" instead of using isPanel.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

Outside diff range, codebase verification and nitpick comments (1)

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

180-186: Updated handling of layout property in HuiCard.

The handling of the layout property has been updated to conditionally set isPanel based on the layout value. This approach allows for more dynamic handling of layout configurations. Ensure that this change is well-documented and that all dependent components are aware of the new behavior.