fix: destroyOnClose works within connectedComponent

[mynetfan]

Description

修复destroyOnClose未能使connectedComponent在关闭后完全销毁的问题

fix: #5979

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features

  • Enhanced modal behavior to fully destroy and recreate connected modals and their child components when closed, if the destroy-on-close option is enabled.

• Documentation

  • Updated documentation to clarify the effect of the destroy-on-close property for connected modals.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 45b37c7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

This change updates the documentation and implementation of the VbenModal component to address the behavior of the destroyOnClose property, especially when used with connected components. The documentation now explicitly states that enabling destroyOnClose will fully destroy the internal modal and its children upon closure. In the code, a new reactive state and method (isModalReady and reCreateModal) are introduced to control the destruction and recreation of the modal component. The modal rendering logic and lifecycle callbacks are modified to ensure that when destroyOnClose is set, the modal and its internal state are properly reset after closing.

Changes

File(s)	Change Summary
docs/src/components/common-ui/vben-modal.md	Updated documentation to clarify the effect of destroyOnClose with connected components, stating that internal modals and their children are fully destroyed when closed.
packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts	Added isModalReady state and reCreateModal method to manage destruction and recreation of connected modal components; updated rendering logic and lifecycle callbacks to support proper cleanup when destroyOnClose is enabled.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant useVbenModal
    participant ModalComponent

    Caller->>useVbenModal: Open Modal (with connectedComponent, destroyOnClose=true)
    useVbenModal->>ModalComponent: Render connectedComponent
    Caller->>useVbenModal: Close Modal
    useVbenModal->>ModalComponent: Trigger onClosed
    ModalComponent->>useVbenModal: onClosed callback
    alt destroyOnClose is true
        useVbenModal->>useVbenModal: Call reCreateModal (set isModalReady false, then true)
        useVbenModal-->>ModalComponent: Unmount and remount connectedComponent
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Ensure that when destroyOnClose=true is set on a connected modal, the internal component is fully destroyed and its state reset upon closing (#5979)	✅

Possibly related PRs

• vbenjs/vue-vben-admin#5964: Both PRs modify the behavior of the destroyOnClose option in the VbenModal component, focusing on content destruction and remounting logic.
• vbenjs/vue-vben-admin#5935: Related to optimizing and refining the destroyOnClose behavior in modal components, though with a different implementation approach.

Suggested reviewers

• anncwb
• jinmao88
• vince292007

Poem

In the warren where modals hop and close,
A new trick ensures their state now goes.
With destroyOnClose, we clear the slate,
No lingering forms, no tabs that wait.
Modal rebirth on every show—
That’s how the bunnies like it, you know!
🐇✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f269e0 and 45b37c7.

📒 Files selected for processing (2)

• docs/src/components/common-ui/vben-modal.md (1 hunks)
• packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts (5 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: post-update (ubuntu-latest)
• GitHub Check: post-update (windows-latest)
• GitHub Check: Check (ubuntu-latest)
• GitHub Check: Check (windows-latest)
• GitHub Check: Test (windows-latest)
• GitHub Check: Lint (windows-latest)
• GitHub Check: Lint (ubuntu-latest)
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (6)

packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts (5)

3-11: LGTM, correctly added necessary imports for the new functionality.

The additional imports of nextTick and reorganization of the import statements are correct for the new functionality that will be implemented.

---

35-35: Good addition of reactive state to control modal rendering.

The isModalReady ref is essential for the new destroy-and-recreate mechanism that will fix the destroyOnClose functionality for connected components.

---

45-49: Well-implemented recreation mechanism.

The reCreateModal method effectively forces the connected component to be destroyed and recreated by toggling the isModalReady ref with a nextTick delay. This is a clean approach to ensure the component is fully destroyed and recreated.

---

58-58: LGTM - Conditionally renders the component based on ready state.

The rendering logic correctly uses the isModalReady value to determine whether to render the actual connected component or a placeholder div, enabling the destroy/recreate cycle.

---

87-92: Properly implemented destruction logic on modal close.

This implementation correctly handles the destroyOnClose functionality by triggering the reCreateModal method when the modal is closed and the destroyOnClose option is enabled. This ensures the connected component is fully destroyed upon closing.

docs/src/components/common-ui/vben-modal.md (1)

62-62: Documentation updated to reflect the implementation change.

The documentation now clearly states that when destroyOnClose is enabled with a connected component, the internal modal and its child components will be completely destroyed upon closing. This aligns with the implementation changes and helps users understand the behavior.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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 generate docstrings to generate docstrings for this 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.