fix(modal): [modal] modifying the modal component and clicking the confirm button accidentally triggered the close event

[James-9696]

…cidentally triggered the close event

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

• Bug Fixes
  • Improved modal event handling by removing conditional event emission restrictions
  • Ensured consistent event emission when closing modal, regardless of closure type

[coderabbitai]

Walkthrough

The pull request introduces modifications to the modal component's event handling in the packages/renderless/src/modal/index.ts file. The changes primarily focus on simplifying the event emission logic in the handleEvent and close functions. The key modification involves removing conditional checks that previously prevented or conditionally emitted events, resulting in unconditional event emission for both 'close' and other event types.

Changes

File	Change Summary
packages/renderless/src/modal/index.ts	Simplified event handling in handleEvent and close functions by removing type-based conditional checks, ensuring unconditional event emission

Suggested labels

bug

Suggested reviewers

• zzcr

Possibly related PRs

• fix(modal): [modal] click the close button to add a close event #2106: Modifies close event handling in the modal component
• fix(modal): [modal] repeatedly dispatch the close event #2573: Addresses handleEvent function's event emission logic

Poem

🐰 A Modal's Tale of Freedom 🎭

Events once bound by type's tight reign,
Now flow freely, breaking every chain
Unconditional emission takes the stage
Modal's logic turns a brand new page
Hop, hop, hooray for simpler code! 🎉

---

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>, 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. (Beta)
• @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.

[petercat-assistant]

Walkthrough

This pull request addresses a bug in the modal component where clicking the confirm button inadvertently triggered the close event. The changes ensure that the close event is not emitted when it is not intended, thus fixing the unintended behavior.

Changes

File	Summary
packages/renderless/src/modal/index.ts	Removed the condition that prevented the 'close' event from being emitted, and stopped emitting 'close' in a specific timeout block.

[petercat-assistant]

Ensure that removing the condition for emitting 'close' does not lead to unintended side effects, such as triggering the 'close' event in scenarios where it should not be triggered.

[github-actions]

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

210-212: Consider making the modal closure optional on certain events.

Currently, this logic emits the event (e.g., 'confirm') and then immediately calls api.close(type) unconditionally. While this may be suitable for many use cases, it might be too restrictive in scenarios where confirming an action should not automatically close the modal. To improve flexibility, consider introducing an optional parameter, or using an after-confirm callback, to decide whether to close the modal.

🧰 Tools

🪛 Biome (1.9.4)

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

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5579681 and 1a4038c.

📒 Files selected for processing (1)

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