fix(modal): [modal] click the close button to add a close event

[James-9696]

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: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• New Features

  • Introduced a hide event handler for modal components, providing user feedback when the modal is closed.
  • Enhanced modal interactivity with notifications upon hiding.

• Bug Fixes

  • Improved event handling logic to ensure the hide event is consistently emitted.

• Refactor

  • Consolidated modal closing and hiding functionalities into a single event handler for streamlined management.

[coderabbitai]

Walkthrough

The changes introduced in this pull request enhance the modal components by adding a hide event handler. This new handler is implemented across multiple files, allowing for improved user feedback when the modal is hidden. The modifications include updates to event handling logic, ensuring that the hide event is prioritized and properly emitted when the modal is closed.

Changes

Files	Change Summary
examples/sites/demos/pc/app/modal/.../message-closable-composition-api.vue	Added a hide event handler to the modal component, triggering a notification when hidden.
examples/sites/demos/pc/app/modal/.../message-closable.vue	Introduced a hide event handler that triggers a notification, enhancing user feedback.
packages/renderless/src/modal/index.ts	Modified the close function to prioritize emitting the hide event when defined.
packages/vue/src/modal/index.ts	Replaced the close event handler with a new hide event handler, streamlining event management.

Possibly related PRs

• fix(checkbox): [checkbox] modify smb theme #2096: This PR is unrelated to the main PR as it focuses on visual adjustments to a checkbox component, while the main PR deals with event handling in modal components.

Suggested labels

bug

Poem

🐇 In a modal bright and bold,
A hide event now unfolds.
With notifications clear and bright,
User feedback takes to flight.
Hopping through the code we cheer,
For better modals, loud and clear! 🌟

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e20f70a and 183b608.

Files selected for processing (4)

• examples/sites/demos/pc/app/modal/message-closable-composition-api.vue (1 hunks)
• examples/sites/demos/pc/app/modal/message-closable.vue (2 hunks)
• packages/renderless/src/modal/index.ts (1 hunks)
• packages/vue/src/modal/index.ts (1 hunks)

Additional context used

Biome

packages/vue/src/modal/index.ts

[error] 35-35: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

Additional comments not posted (5)

examples/sites/demos/pc/app/modal/message-closable-composition-api.vue (1)

16-22: LGTM!

The hide event callback is implemented correctly within the events object of the showModal function. It triggers a notification using the Notify function to provide user feedback when the modal is hidden. The notification type and position are appropriate for informing the user about the triggered event. The code segment aligns with the PR objective and follows the Vue composition API syntax consistently.

examples/sites/demos/pc/app/modal/message-closable.vue (2)

8-8: LGTM!

The import statement for the Notify component is correctly written and is necessary for the functionality introduced in this PR.

---

21-27: LGTM!

The hide event handler is correctly implemented and provides appropriate user feedback when the modal is hidden. The notification message, type, and position are all suitable for this event.

packages/vue/src/modal/index.ts (1)

34-40: LGTM! The changes streamline the modal event handling.

The new hide event handler consolidates the functionality of closing and hiding the modal, which aligns with the PR objective. The logic of calling any existing hide event handler, invoking the beforeUnmouted method, and resolving the promise with params.type is implemented correctly.

Regarding the static analysis hint about using an optional chain at line 35, it's a false positive because events.hide is guaranteed to be a function if it exists, based on the code at that line. Therefore, an optional chain is not necessary.

As indicated in the PR checklist, tests and documentation updates are still pending for these changes. Do you want me to assist with generating test cases or updating the documentation? I can also open a GitHub issue to track these tasks if you prefer.

Tools

Biome

[error] 35-35: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

packages/renderless/src/modal/index.ts (1)

374-379: LGTM!

The changes to the event emission logic in the close function look good. Prioritizing the hide event and providing flexibility through the events.hide handler enhances the modal's event handling mechanism. Emitting the update:modelValue event with a value of false before the hide event aligns with the expected behavior when the modal is closed.

---

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

• 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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.