Move badge styling into ha-badge component to reuse it #21864

piitaya · 2024-09-03T15:53:31Z

Proposed change

Extract badge style into ha-badge component to reuse it.

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

New Features
- Introduced the HaBadge component for creating customizable badges and buttons.
- Enhanced error handling by integrating the HaBadge component into existing badge structures.
Bug Fixes
- Improved rendering logic for badges, ensuring better error display and interaction.
Refactor
- Replaced previous badge implementations with the new HaBadge component for better modularity and maintainability.
- Streamlined the internal structure of badges to enhance code readability and functionality.
Style
- Updated styles to target the new HaBadge component, ensuring consistent visual behavior across badges.

coderabbitai · 2024-09-03T15:53:39Z

Walkthrough

The changes introduce a new custom web component, HaBadge, which extends LitElement and provides a reusable badge/button interface. This component is integrated into existing badge implementations (HuiEntityBadge and HuiErrorBadge), replacing previous HTML structures with the new component for improved modularity and maintainability. The updates streamline rendering logic, enhance accessibility, and centralize styling within the HaBadge component.

Changes

Files	Change Summary
`src/components/ha-badge.ts`	Introduced `HaBadge` component extending `LitElement`, with properties for type, label, and iconOnly. Added rendering logic and styles for the badge.
`src/panels/lovelace/badges/hui-entity-badge.ts`, `src/panels/lovelace/badges/hui-error-badge.ts`	Refactored `HuiEntityBadge` and `HuiErrorBadge` to use `<ha-badge>` instead of previous structures, simplifying rendering and enhancing modularity. Updated styles to target the new component.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HuiEntityBadge
    participant HaBadge

    User->>HuiEntityBadge: Interacts with badge
    HuiEntityBadge->>HaBadge: Render badge with properties
    HaBadge-->>HuiEntityBadge: Returns rendered badge
    HuiEntityBadge-->>User: Displays badge

sequenceDiagram
    participant User
    participant HuiErrorBadge
    participant HaBadge

    User->>HuiErrorBadge: Interacts with error badge
    HuiErrorBadge->>HaBadge: Render error badge with properties
    HaBadge-->>HuiErrorBadge: Returns rendered error badge
    HuiErrorBadge-->>User: Displays error badge

Tip

We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a527ff4 and 643b1a5.

Files selected for processing (1)

src/components/ha-badge.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

src/components/ha-badge.ts

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 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 or @coderabbitai title 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.

balloob · 2024-09-03T18:09:48Z

src/components/ha-badge.ts

+
+type BadgeType = "badge" | "button";
+
+@customElement("ha-badge")


So now we'll have hui-badge and ha-badge 😬 Feels a bit chaotic.

Should we rename hui-badge to something that represents it's creating one from config?

We created hui-card and hui-badge because we had hui-view 😅. I agree, it's super confusing.

src/components/ha-badge.ts

balloob

Nice! 👍

Co-authored-by: Paulus Schoutsen <balloob@gmail.com>

piitaya added 2 commits September 3, 2024 17:44

Move badge styling into ha-badge component to reuse it

8bd21fb

Fix error badge

a527ff4

home-assistant bot added the cla-signed label Sep 3, 2024

balloob reviewed Sep 3, 2024

View reviewed changes

src/components/ha-badge.ts Outdated Show resolved Hide resolved

balloob previously approved these changes Sep 3, 2024

View reviewed changes

Update src/components/ha-badge.ts

643b1a5

Co-authored-by: Paulus Schoutsen <balloob@gmail.com>

piitaya dismissed balloob’s stale review via 643b1a5 September 3, 2024 19:10

bramkragten approved these changes Sep 4, 2024

View reviewed changes

piitaya merged commit 7aa7019 into dev Sep 4, 2024
13 checks passed

piitaya deleted the ha-badge branch September 4, 2024 08:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move badge styling into ha-badge component to reuse it #21864

Move badge styling into ha-badge component to reuse it #21864

piitaya commented Sep 3, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 3, 2024 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

balloob Sep 3, 2024

piitaya Sep 3, 2024

balloob left a comment


		type BadgeType = "badge" \| "button";

		@customElement("ha-badge")

Move badge styling into ha-badge component to reuse it #21864

Move badge styling into ha-badge component to reuse it #21864

Conversation

piitaya commented Sep 3, 2024 • edited by coderabbitai bot Loading

Proposed change

Type of change

Example configuration

Additional information

Checklist

Summary by CodeRabbit

coderabbitai bot commented Sep 3, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

balloob Sep 3, 2024

Choose a reason for hiding this comment

piitaya Sep 3, 2024

Choose a reason for hiding this comment

balloob left a comment

Choose a reason for hiding this comment

piitaya commented Sep 3, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 3, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)