fix: when keepAlive is enabled, returning directly through browser bu…

[imdap]

…ttons/gestures will not close pop ups

Description

在开启keepAlive时 通过浏览器返回按钮/手势等 modal/drawer不会关闭

复现流程:

• 开启keepAlive

• 从首页进入到部门管理 点击弹窗 再点击浏览器返回 此时弹窗依旧存在

fix

使用keepAlive的hook onDeactivated 在未激活页面情况进行手动关闭

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

• Bug Fixes
  • Ensured that drawers and modals are automatically closed when navigating away from a component (such as when using browser navigation or gestures), improving the user experience with components kept alive in the background.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 9cb5c11

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

Lifecycle management has been enhanced for both drawer and modal UI components. The onDeactivated Vue lifecycle hook is now used within the useVbenDrawer and useVbenModal functions to automatically close these UI elements when their connected component is deactivated, such as during navigation events.

Changes

File(s)	Change Summary
packages/@core/ui-kit/popup-ui/src/drawer/use-drawer.ts	Added onDeactivated lifecycle hook to close the drawer when the connected component is deactivated.
packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts	Added onDeactivated lifecycle hook to close the modal when the connected component is deactivated.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VueComponent
    participant DrawerOrModal
    participant ExtendedApi

    User->>VueComponent: Navigates away (e.g., via browser back)
    VueComponent->>Vue: Triggers onDeactivated
    Vue->>DrawerOrModal: Calls onDeactivated callback
    DrawerOrModal->>ExtendedApi: extendedApi.close()

Loading

Suggested reviewers

• mynetfan
• anncwb
• jinmao88
• vince292007

Poem

When drawers and modals linger on,
And users click or swipe and gone,
Now with a hook, they close with grace,
No UI ghosts left in their place.
A hop, a close, a tidy view—
Thanks to the code, and thanks to you! 🐇✨

---

📜 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 3b3f8e4 and 9cb5c11.

📒 Files selected for processing (2)

• packages/@core/ui-kit/popup-ui/src/drawer/use-drawer.ts (2 hunks)
• packages/@core/ui-kit/popup-ui/src/modal/use-modal.ts (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

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

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

• ExtendedDrawerApi (139-143)

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

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

• ExtendedModalApi (149-153)

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

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

🔇 Additional comments (4)

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

12-12: Good addition of the required Vue lifecycle hook.

The onDeactivated hook import is necessary for the implementation of the popup closing behavior when a component is deactivated.

---

74-81: Excellent fix for the browser back navigation issue.

This implementation correctly uses the Vue onDeactivated lifecycle hook to close the drawer when the component is deactivated (such as when navigating away using browser back buttons). The optional chaining in extendedApi?.close?.() provides a safe way to call the method only if it exists.

The detailed comment also helps explain the purpose of this code, making maintenance easier for future developers.

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

8-8: Good addition of the required Vue lifecycle hook.

The onDeactivated hook import is necessary for the implementation of the popup closing behavior when a component is deactivated.

---

73-80: Perfect parallel implementation for the modal component.

This implementation correctly matches the approach used in the drawer component, ensuring consistency across the codebase. The onDeactivated lifecycle hook appropriately closes the modal when a user navigates away via browser back buttons or gestures.

The optional chaining pattern in extendedApi?.close?.() is a good defensive programming practice, preventing errors if the API or method doesn't exist.

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