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(dialog-box): [dialog-box] destoryOnClose transition #2074

Closed
wants to merge 6 commits into from

Conversation

GaoNeng-wWw
Copy link
Collaborator

@GaoNeng-wWw GaoNeng-wWw commented Sep 7, 2024

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: #2045

What is the new behavior?

2

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Enhanced dialog box component with improved rendering control based on user interactions.
    • Conditional rendering of dialog content for better performance.
    • Flexible animation handling for dialog visibility.
  • Bug Fixes

    • Improved state management during dialog closure, ensuring proper rendering behavior.
  • Style

    • Updated CSS for better layout responsiveness and maintainability of dialog box components.
    • Reformatted padding declarations for improved readability and consistency.

Copy link

coderabbitai bot commented Sep 7, 2024

Walkthrough

The changes refine the dialog box component by simplifying state management and enhancing rendering logic. Key updates include the removal of logic that resets the internal state key upon closing the dialog, the introduction of a render property to manage visibility, and modifications to lifecycle functions to control rendering conditions. Additionally, the CSS has been adjusted for improved layout clarity and consistency.

Changes

Files Change Summary
packages/renderless/src/dialog-box/index.ts, packages/renderless/src/dialog-box/vue.ts Updated afterLeave function to accept state and props parameters; removed state key increment logic; added render property to manage dialog visibility.
packages/renderless/types/dialog-box.type.ts Introduced a new optional render property in the IDialogBoxState interface for enhanced state management.
packages/theme/src/dialog-box/index.less Reformatted padding properties for clarity; adjusted text alignment and modified animation classes for better styling consistency.

Possibly related PRs

Poem

🐰 In the meadow, changes bloom,
A dialog box sheds its gloom.
With a render state, it hops with glee,
Responsive now, as it ought to be!
Padding neat, and transitions bright,
A joyful dance in the soft moonlight! 🌙✨


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

Copy link

github-actions bot commented Sep 7, 2024

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

Copy link

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d3be75b and 988d54e.

Files selected for processing (5)
  • packages/renderless/src/dialog-box/index.ts (3 hunks)
  • packages/renderless/src/dialog-box/vue.ts (2 hunks)
  • packages/renderless/types/dialog-box.type.ts (1 hunks)
  • packages/theme/src/dialog-box/index.less (9 hunks)
  • packages/vue/src/dialog-box/src/pc.vue (2 hunks)
Files skipped from review due to trivial changes (1)
  • packages/theme/src/dialog-box/index.less
Additional comments not posted (6)
packages/renderless/types/dialog-box.type.ts (1)

64-64: Approved: Addition of render property to IDialogBoxState.

The addition of the optional render property enhances state management by potentially allowing more granular control over the dialog box's rendering behavior. Ensure that this new property is utilized appropriately in the component's logic.

Run the following script to verify the usage of the render property:

packages/vue/src/dialog-box/src/pc.vue (2)

37-37: Approved: Conditional rendering based on state.render.

The introduction of v-if="state.render" in the dialog box content section is a good use of the new render state property, enhancing control over rendering based on the component's internal state.


22-22: Approved: Flexible transition naming.

The update to allow dialogTransition || state.animationname provides flexibility in managing animations, enhancing the component's responsiveness to different animation requirements.

packages/renderless/src/dialog-box/vue.ts (2)

86-86: Approved: Setting render based on props.destroyOnClose.

The initialization of the render property in the initState function based on props.destroyOnClose is a logical use of the new property, aligning with the component's lifecycle requirements.


148-148: Approved: Enhanced lifecycle management in afterLeave.

The inclusion of state and props in the afterLeave function call enhances lifecycle management by allowing more nuanced behavior during the component's exit animation.

packages/renderless/src/dialog-box/index.ts (1)

91-91: Approved: Explicit management of rendering state.

The addition of state.render = true when the dialog is opened is a clear and effective way to manage the component's visibility. Ensure that this change integrates well with other parts of the system, particularly with state management and event handling.

Run the following script to verify the integration with other parts of the system:

Verification successful

Integration of state.render = true is consistent with existing patterns.

The use of state.render = true in the dialog-box component aligns with the existing pattern of managing rendering states across the codebase. No conflicts or improper handling were found in other parts of the system.

  • Ensure that this change continues to align with the overall state management strategy.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the integration of `state.render = true` with other parts of the system.

# Test: Search for the usage of `state.render` in other parts of the system. Expect: Proper handling and no conflicts.
rg --type typescript -A 5 $'state.render'

Length of output: 75


Script:

#!/bin/bash
# Description: Verify the integration of `state.render = true` with other parts of the system.

# Test: Search for the usage of `state.render` in other parts of the system. Expect: Proper handling and no conflicts.
rg --type ts -A 5 $'state.render'

Length of output: 11417

packages/renderless/src/dialog-box/index.ts Outdated Show resolved Hide resolved
@GaoNeng-wWw GaoNeng-wWw added the bug Something isn't working label Sep 9, 2024
Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 988d54e and f229b14.

Files selected for processing (1)
  • packages/renderless/src/dialog-box/index.ts (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/renderless/src/dialog-box/index.ts

@GaoNeng-wWw GaoNeng-wWw changed the title fix(dialog-box): destoryOnClose transition fix(dialog-box): [dialog-box] destoryOnClose transition Sep 10, 2024
@@ -107,10 +107,6 @@ export const watchVisible =
emit('close')
}

if (props.destroyOnClose) {
Copy link
Member

Choose a reason for hiding this comment

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

这段逻辑删除,可能会影响destroyOnClose属性的功能

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

我重新开一个PR吧,这个PR有些太久远了

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants