fix: destroyOnClose incorrect default value, fixed #6092

[mynetfan]

修复destroyOnClose的默认值与文档描述不一致的问题。
fixed: #6092

Summary by CodeRabbit

• New Features

  • Updated the default behavior of drawers and modals so that their content is no longer destroyed when closed, unless explicitly specified.

• Documentation

  • Clarified the description of the destroyOnClose property in the drawer documentation to better reflect its current behavior.

[changeset-bot]

⚠️ No Changeset found

Latest commit: ab15cfc

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

The changes update the default behavior of the destroyOnClose property in both drawer and modal components, setting its default value from true to false. This affects whether the components are destroyed upon closing by default. The documentation for the drawer's destroyOnClose property is also revised for clarity, removing references to connected components. The internal constants that previously set destroyOnClose to true are now empty objects, aligning with the new default behavior. No changes were made to the public APIs beyond default values and documentation.

Changes

Files/Group	Change Summary
packages/@core/ui-kit/popup-ui/src/drawer/drawer.vue, .../modal/modal.vue	Changed default value of destroyOnClose prop from true to false.
packages/@core/ui-kit/popup-ui/src/drawer/use-drawer.ts, .../modal/use-modal.ts	Updated DEFAULT_DRAWER_PROPS and DEFAULT_MODAL_PROPS to empty objects (removed destroyOnClose: true).
docs/src/components/common-ui/vben-drawer.md	Updated documentation for destroyOnClose to clarify its function and remove mention of connected components.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Drawer/Modal Component

    User->>Drawer/Modal Component: Close drawer/modal
    alt destroyOnClose = true
        Drawer/Modal Component-->>User: Destroy component/content on close
    else destroyOnClose = false
        Drawer/Modal Component-->>User: Keep component/content mounted on close
    end

Loading

Possibly related PRs

• vbenjs/vue-vben-admin#5960: Addresses modal animation issues when destroyOnClose is false, directly related to the default value change.
• vbenjs/vue-vben-admin#6051: Adds the destroyOnClose prop to the drawer component with default true, which this PR now changes to false.
• vbenjs/vue-vben-admin#5964: Modifies modal rendering logic based on destroyOnClose, related to the default behavior update in this PR.

Suggested reviewers

• anncwb
• jinmao88
• vince292007

Poem

A drawer and modal, side by side,
Once closed, they'd run and hide.
But now they linger, calm and still,
Awaiting your next open-will.
No more vanishing in haste—
Rabbits like a gentle pace!
🐇✨

---

📜 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 5de954b and ab15cfc.

📒 Files selected for processing (5)

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

🧰 Additional context used

🧬 Code Graph Analysis (2)

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

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

• ModalProps (7-138)

packages/@core/ui-kit/popup-ui/src/drawer/use-drawer.ts (1)

packages/@core/ui-kit/popup-ui/src/drawer/drawer.ts (1)

• DrawerProps (11-128)

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

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

🔇 Additional comments (5)

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

20-20: Default value change for destroyOnClose property

The change updates DEFAULT_MODAL_PROPS to an empty object, removing the previous destroyOnClose: true default. This aligns with the changes in modal.vue where destroyOnClose default is set to false directly in the component.

packages/@core/ui-kit/popup-ui/src/modal/modal.vue (1)

37-37: Updated default value for destroyOnClose

Changed the default value of destroyOnClose from true to false, which affects whether the modal content is destroyed when closed. This aligns with the PR objective to fix the mismatch between the default behavior and documentation.

packages/@core/ui-kit/popup-ui/src/drawer/use-drawer.ts (1)

24-24: Default value change for destroyOnClose property

The change updates DEFAULT_DRAWER_PROPS to an empty object, removing the previous destroyOnClose: true default. This aligns with the changes in drawer.vue where destroyOnClose default is set to false directly in the component.

packages/@core/ui-kit/popup-ui/src/drawer/drawer.vue (1)

38-38: Updated default value for destroyOnClose

Changed the default value of destroyOnClose from true to false, which affects whether the drawer content is destroyed when closed. This change maintains consistency with the modal component behavior and aligns with the PR objective to fix the default value.

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

81-81: Updated Default Value for destroyOnClose
The default value has been changed to false, which now correctly reflects the updated component 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.