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: [button-group] fixed the bug that multiple clicks on the same button would trigger multiple events #2590

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

Conversation

zzcr
Copy link
Member

@zzcr zzcr commented Dec 2, 2024

…tton would trigger multiple events

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 the button group's click handling logic to prevent unnecessary state updates and event emissions when the selected value remains the same.

Copy link

coderabbitai bot commented Dec 2, 2024

Walkthrough

The changes in this pull request focus on modifying the handleClick function within the packages/renderless/src/button-group/index.ts file. The update enhances the conditional logic to ensure that the state.value is only updated and the update:modelValue event is emitted when the new node's value is different from the current state value, while also checking that both the current and new nodes are not disabled.

Changes

File Path Change Summary
packages/renderless/src/button-group/index.ts Modified handleClick function to improve conditional logic for updating state.value and emitting update:modelValue event.

Possibly related PRs

Suggested labels

bug

🐇 In the button group where we play,
A click now checks the value's sway.
If different, it updates with glee,
Ensuring all is as it should be!
So hop along, let’s celebrate,
For cleaner code, we elevate! 🎉


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 Dec 2, 2024
@zzcr zzcr changed the title fix: [button-group] fixed the bug that multiple clicks on the same bu… fix: [button-group] fixed the bug that multiple clicks on the same button would trigger multiple events Dec 2, 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 (2)
packages/renderless/src/button-group/index.ts (2)

25-28: Add test cases to verify the fix.

Please add test cases to verify:

  1. Multiple clicks on the same button trigger only one event
  2. Clicks on different buttons still work as expected
  3. Disabled state handling remains correct

Would you like me to help generate the test cases for these scenarios?


Line range hint 14-21: Consider applying similar protection to handleChange.

The handleChange function might benefit from similar value-change protection to maintain consistency with the click handler's behavior.

Here's a suggested improvement:

 export const handleChange =
   ({ emit, state }: Pick<IButtonGroupRenderlessParams, 'emit' | 'state'>) =>
   (): void => {
-    if (!state.disabled) {
+    if (!state.disabled && state.previousValue !== state.value) {
+      state.previousValue = state.value
       emit('change', state.value)
     }
   }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 74bfd1c and b01e609.

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

25-28: LGTM! The fix correctly prevents redundant events.

The additional condition state.value !== node[props.valueField] effectively prevents multiple events from being triggered when clicking the same button repeatedly.


25-28: Verify impact on existing usage patterns.

Let's verify that this change doesn't affect other components or existing usage patterns.

✅ Verification successful

Based on the extensive search results, I can now generate the final response:

The disabled state check is properly implemented and consistent with usage patterns

The code change adds a disabled state check before updating the value, which is consistent with:

  1. The component's usage patterns across the codebase, where button-group is used in forms and other components with disabled states
  2. The existing test files and examples that demonstrate disabled state handling
  3. The component's implementation in both PC and mobile versions

The change ensures that value updates don't occur when either:

  • The overall button-group is disabled (state.disabled)
  • The individual button node is disabled (node.disabled)

This is the correct behavior as it prevents value changes when the component or its items are in a disabled state.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other potential event handlers in button-group components
echo "Checking for other button-group event handlers:"
rg -t ts "emit\(" packages/renderless/src/button-group/

# Search for button-group usage patterns
echo "Checking button-group usage patterns:"
rg -t vue "@click" -A 5 -B 5 packages/vue/src/button-group/

Length of output: 597


Script:

#!/bin/bash
# Search for button-group usage patterns with a more generic approach
echo "Checking button-group usage patterns in all files:"
rg "button-group" -A 5 -B 5

# Check for any test files related to button-group
echo "Checking for button-group test files:"
fd "button.*test" -t f

# Look for component documentation or examples
echo "Checking for button-group documentation or examples:"
fd "button.*md" -t f

Length of output: 66744

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.

1 participant