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

Migrate dialog restart to ha-md-dialog #22032

Merged
merged 7 commits into from
Sep 23, 2024
Merged

Migrate dialog restart to ha-md-dialog #22032

merged 7 commits into from
Sep 23, 2024

Conversation

wendevlin
Copy link
Contributor

@wendevlin wendevlin commented Sep 19, 2024

Breaking change

Proposed change

For the restart dialog use the material/web based ha-md-dialog instead of the ha-dialog.

  • Add workaround for ha-md-dialog to open a dialog inside a dialog
  • Add chevrons to restart actions

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

    • Enhanced dialog functionality allowing multiple dialogs to overlay.
    • Transitioned to a Material Design dialog for improved visual consistency.
    • Added close button with an icon in the dialog header for better accessibility.
    • Updated list items for streamlined interactivity and context.
    • Improved layout consistency with new padding for slotted content.
  • Bug Fixes

    • Improved state management when closing dialogs.
  • Chores

    • Simplified internal methods for cleaner code and maintainability.

@wendevlin wendevlin self-assigned this Sep 19, 2024
Copy link
Contributor

coderabbitai bot commented Sep 19, 2024

Walkthrough

Walkthrough

The changes enhance the MdDialog component to allow multiple dialogs to overlay by modifying scrim properties and animations. The dialog-restart.ts file transitions from ha-dialog to ha-md-dialog, updating the internal structure for improved usability and interactivity. New methods are introduced to manage dialog state effectively, and existing methods are simplified for cleaner code. These modifications align with Material Design principles and improve the overall functionality of the dialog components.

Changes

Files Change Summary
src/components/ha-md-dialog.ts Introduced a workaround for overlaying dialogs by modifying initialization, adjusting scrim properties, and overriding animation methods. Added CSS for padding in slotted content.
src/dialogs/restart/dialog-restart.ts Transitioned from ha-dialog to ha-md-dialog, added a close button in the header, and updated internal structure to use ha-md-list components. Encapsulated dialog closing logic in a new method and simplified existing methods.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DialogRestart
    participant HaMdDialog

    User->>DialogRestart: Open Dialog
    DialogRestart->>HaMdDialog: Initialize Dialog
    HaMdDialog-->>DialogRestart: Dialog Opened
    User->>HaMdDialog: Interact with Dialog
    HaMdDialog->>DialogRestart: Close Request
    DialogRestart->>HaMdDialog: Close Dialog
    HaMdDialog-->>DialogRestart: Dialog Closed
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 67beaf8 and 816e2ca.

Files selected for processing (2)
  • src/components/ha-md-dialog.ts (4 hunks)
  • src/dialogs/restart/dialog-restart.ts (8 hunks)
Files skipped from review as they are similar to previous changes (2)
  • src/components/ha-md-dialog.ts
  • src/dialogs/restart/dialog-restart.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>, 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 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.

bramkragten
bramkragten previously approved these changes Sep 23, 2024
@bramkragten bramkragten enabled auto-merge (squash) September 23, 2024 15:06
@bramkragten bramkragten merged commit 3a9f09c into dev Sep 23, 2024
9 checks passed
@bramkragten bramkragten deleted the dialog-restart-md branch September 23, 2024 15:18
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