Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(modal): [modal] repeatedly dispatch the close event #2573

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

betavs
Copy link
Contributor

@betavs betavs commented Nov 28, 2024

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: #2512

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features

    • Enhanced event handling for modal interactions, ensuring that 'close' events are not emitted unnecessarily.
    • Improved zoom functionality with consistent event emissions following zoom actions.
  • Bug Fixes

    • Refined logic to prevent unwanted event emissions, enhancing the overall user experience.

Copy link

coderabbitai bot commented Nov 28, 2024

Walkthrough

The changes in this pull request focus on refining the event handling logic within the modal component. Specifically, the handleEvent function has been modified to prevent the emission of the 'close' event when the event type is 'close'. Additionally, the toggleZoomEvent function now includes a call to emitZoom after executing the zoom action, ensuring that zoom events are consistently emitted. These adjustments enhance the clarity and reliability of event emissions in the modal.

Changes

File Path Change Summary
packages/renderless/src/modal/index.ts - Modified handleEvent to prevent 'close' event emission for 'close' type events.
- Updated toggleZoomEvent to include emitZoom call after zoom actions.

Possibly related PRs

Suggested labels

bug

Suggested reviewers

  • zzcr

🐇 In the modal, we hop and play,
No 'close' event will come our way.
With zoom events that now will chime,
Our actions clear, in perfect time!
So let’s embrace this change with cheer,
A smoother flow, for all to hear! 🎉


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

@github-actions github-actions bot added the bug Something isn't working label Nov 28, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
packages/renderless/src/modal/index.ts (1)

210-212: Consider adding documentation for event handling flow.

The event handling logic is complex with multiple event types and emission points. Consider adding documentation that describes:

  • The different event types and their purposes
  • The event emission flow and order
  • Why certain events are handled differently (e.g., close vs other events)

This would help future maintainers understand the event handling logic better.

🧰 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

📥 Commits

Reviewing files that changed from the base of the PR and between d3fcc60 and 786a94a.

📒 Files selected for processing (1)
  • packages/renderless/src/modal/index.ts (1 hunks)
🔇 Additional comments (2)
packages/renderless/src/modal/index.ts (2)

210-210: LGTM! Fix for duplicate close event emission.

The condition type !== 'close' correctly prevents double emission of the close event. Previously, the close event was being emitted both in handleEvent and in the close function. Now, only the close function handles the emission, maintaining a single source of truth.


210-210: LGTM! Consistent zoom event emission.

The addition of emitZoom after the zoom action ensures that the zoom event is consistently emitted and that the zoom state is updated before the event is emitted.

@betavs betavs changed the title fix(component): [modal] repeatedly dispatch the close event fix(modal): [modal] repeatedly dispatch the close event Nov 28, 2024
@@ -207,7 +207,7 @@ export const handleEvent =
params.options = options
}

emit(type, params, event)
type !== 'close' && emit(type, params, event)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hello你好,这个代码改了会导致有其他bug,排查了下你可以将377行代码:emit('close', params) 去掉,改掉目前这个问题。

Copy link
Contributor Author

@betavs betavs Nov 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

将377行代码:emit('close', params) 去掉

标签式调用时,当点击 确定 | 取消 按钮时,会触发 confirm | cancel 事件,并不再触发 close 事件

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

点击 confirm 和 cancel 按钮,不需要触发close 事件,触发hide 事件。当点击close 按钮时触发close 事件即可

@James-9696
Copy link
Collaborator

James-9696 commented Nov 29, 2024 via email

@betavs
Copy link
Contributor Author

betavs commented Nov 29, 2024

点击 confirm 和 cancel 按钮,不需要触发close 事件,触发hide 事件。当点击close 按钮时触发close 事件即可

@James-9696 https://opentiny.design/tiny-vue/zh-CN/smb-theme/components/modal#modal-event

@betavs betavs closed this Nov 29, 2024
@betavs betavs reopened this Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants