perf: improve destroyOnClose for VbenModal

[ming4762]

影响范围（重要）：destroyOnClose默认为true，这会导致所有的modal都会默认渲染到body
radix-vue Dialog组件默认会销毁挂载的组件，所以即使destroyOnClose=false，Modal依旧会被销毁
对于一些复杂组件例如大表单重复渲染导致卡顿，ApiComponent也会频繁的从后台加载数据

Description

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

  • Introduced an option that lets modals be fully reset upon closing, enhancing control over modal behavior.

• Refactor

  • Streamlined modal lifecycle management by removing redundant logic for smoother transitions and performance improvements.

• Documentation

  • Revised property descriptions in the modal configuration guide for clearer and more concise instructions.
  • Updated modal content to clarify behavior regarding destruction upon closure and adjusted binding syntax to align with Vue 3 conventions.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 71e6331

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 pull request simplifies property descriptions in the Vben modal documentation and updates the modal's lifecycle behavior. The destroyOnClose property is moved from API options to the modal properties, with an added computed property to manage forced mounting. Additionally, the modal readiness and lifecycle management logic in the custom hook (use-modal.ts) is removed, streamlining the rendering process and control flow for connected components.

Changes

File(s)	Change Summary
docs/src/components/common-ui/vben-modal.md	Simplified descriptions for destroyOnClose (removed detailed context) and connectedComponent (removed explicit connection details).
packages/@core/ui-kit/popup-ui/src/modal/(modal.ts, modal.vue, use-modal.ts)	modal.ts: Added optional destroyOnClose?: boolean to ModalProps and removed it from ModalApiOptions. modal.vue: Introduced computed property getForceMount (using unref) and updated DialogContent with a new :force-mount binding and adjusted class binding. use-modal.ts: Removed modal readiness state (isModalReady) and its associated lifecycle logic, simplifying connected component rendering.
packages/@core/ui-kit/popup-ui/src/modal/modal-api.ts	Added destroyOnClose: true to defaultState in ModalApi class.
playground/src/views/examples/modal/(auto-height-demo.vue, in-content-demo.vue, index.vue)	auto-height-demo.vue: Updated handleUpdate function to make len optional and adjusted calls. in-content-demo.vue: Clarified modal content behavior in text and updated <Input> binding syntax to v-model:value. index.vue: Changed <Card> title to include "关闭后不销毁".

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant M as Modal Component
    participant C as getForceMount Computed Prop
    participant D as DialogContent

    U->>M: Trigger modal close
    M->>C: Evaluate 'destroyOnClose'
    C-->>M: Return force mount flag
    M->>D: Update :force-mount binding & class visibility
    D-->>U: Render updated modal lifecycle

Loading

Poem

I’m a hopping rabbit in the codewood bright,
Skipping through modals with newfound light.
Property tweaks and lifecycle flows,
Unref magic where the force mount grows.
With each change I dance and play—
Hoppy improvements lead the way!
🥕🐇

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 1188723 and 71e6331.

📒 Files selected for processing (5)

• packages/@core/ui-kit/popup-ui/src/modal/modal-api.ts (1 hunks)
• packages/@core/ui-kit/popup-ui/src/modal/modal.vue (7 hunks)
• playground/src/views/examples/modal/auto-height-demo.vue (2 hunks)
• playground/src/views/examples/modal/in-content-demo.vue (1 hunks)
• playground/src/views/examples/modal/index.vue (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• playground/src/views/examples/modal/index.vue

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

• packages/@core/ui-kit/popup-ui/src/modal/modal.vue

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

• GitHub Check: Semantic Pull Request
• 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: post-update (windows-latest)
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: post-update (ubuntu-latest)

🔇 Additional comments (5)

playground/src/views/examples/modal/in-content-demo.vue (1)

27-28: Modal text and binding syntax updated correctly

The changes in this section correctly update the modal's description to reflect that content won't be destroyed after closing (aligning with the destroyOnClose: false setting in the component options). Additionally, the v-model syntax has been updated from v-model="value" to v-model:value="value", which follows Vue 3's more explicit binding syntax.

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

47-47: Added destroyOnClose property to defaultState

Adding destroyOnClose: true to the defaultState correctly implements the default behavior where modals are destroyed when closed. This change moves the property management from API options to the modal's internal state, which properly addresses the PR's objective of fixing modal destruction behavior.

playground/src/views/examples/modal/auto-height-demo.vue (3)

19-19: Function call updated to use optional parameter

The call to handleUpdate() without arguments aligns with the updated function signature. This change simplifies the implementation by utilizing the function's default behavior.

---

24-30: Made parameter optional and added fallback logic

The function signature has been updated to make the len parameter optional, and fallback logic has been added to generate a random length when no value is provided. This change improves the function's flexibility and makes the code more robust.

-function handleUpdate(len: number) {
+function handleUpdate(len?: number) {
   modalApi.setState({ confirmDisabled: true, loading: true });
   setTimeout(() => {
-    list.value = Array.from({ length: len }, (_v, k) => k + 1);
+    list.value = Array.from(
+      { length: len ?? Math.floor(Math.random() * 10) + 1 },
+      (_v, k) => k + 1,
+    );
     modalApi.setState({ confirmDisabled: false, loading: false });
   }, 2000);
 }

---

46-46: Button click handler updated for consistency

The click handler has been updated to call handleUpdate() without arguments, maintaining consistency with the function's updated optional parameter.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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 plan to trigger planning for file edits and PR creation.
• @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.

[mynetfan]

尚有问题没有解决：Modal会失去关闭动画