Skip to content

gw-choice-counter.php: Fixed Choice Counter not triggering quantity updates. #1046

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 12, 2025
Merged

gw-choice-counter.php: Fixed Choice Counter not triggering quantity updates. #1046

merged 1 commit into from
Mar 12, 2025

Conversation

@saifsultanc
Copy link
Contributor

@saifsultanc saifsultanc commented Mar 11, 2025

Context

⛑️ Ticket(s): https://secure.helpscout.net/conversation/2866195352/78865

Summary

The snippet above is used to get the number of selected choices in a multi-choice field. It works, but it appears it doesn't properly trigger the change event, which also doesn't update the form total.

Fix to ensure the change event triggers properly. This would include native event listeners and Gravity Forms logic.

BEFORE:
https://www.loom.com/share/53434d41b639452f8162cb6f1c33fe4e

AFTER:
https://www.loom.com/share/3ff480ee39254a3f895d785945b79cef

@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2025 •
edited
Loading

Walkthrough

The changes add a new line of code inside the output_script function of the GW_Choice_Count class within the Gravity Forms plugin. After updating the value of the count field and triggering a jQuery .change() event, the code now dispatches a native change event with bubbling enabled. This ensures that any native event listeners attached to the element will be activated. No modifications were made to public or exported entities.

Changes

File Change Summary
gravity-forms/gw-choice-counter.php Added a native change event dispatch (countField[0].dispatchEvent( new Event( 'change', { bubbles: true } ) )) in the output_script function for proper event propagation.

Sequence Diagram(s)

sequenceDiagram
    participant Script as output_script
    participant CountField as Count Field
    participant Listener as Native Event Listener

    Script->>CountField: Update value and trigger jQuery .change()
    Script->>CountField: Dispatch native change event (bubbles: true)
    CountField->>Listener: Native event captured and propagated
Loading
📜 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 5f35dd9 and 89a4e2e.

📒 Files selected for processing (1)
  • gravity-forms/gw-choice-counter.php (1 hunks)
🔇 Additional comments (1)
gravity-forms/gw-choice-counter.php (1)

144-147: Great fix - properly triggers both jQuery and native change events!

This change ensures both jQuery event handlers and native DOM event listeners are triggered when the count field value changes. The original code only used jQuery's .change() method, which might not activate all event listeners in the Gravity Forms ecosystem, especially those using native DOM event listeners.

The added line correctly:

  1. Accesses the native DOM element with countField[0]
  2. Dispatches a native change event
  3. Sets bubbles: true to ensure the event propagates up the DOM tree, which is crucial for event delegation patterns

This implementation aligns perfectly with the PR objective of fixing the choice counter not triggering quantity updates.

✨ Finishing Touches
  • 📝 Generate Docstrings
🪧 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.
  • @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
Copy link

github-actions bot commented Mar 11, 2025

Warnings
⚠️ When ready, don't forget to request reviews on this pull request from your fellow wizards.

Generated by 🚫 dangerJS against 89a4e2e

veryspry
veryspry approved these changes Mar 11, 2025
View reviewed changes
Copy link
Contributor

@veryspry veryspry left a comment

Choose a reason for hiding this comment

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

Untested on my part but the code looks good to me :)

Thanks for confirming that this works with the GF listener stuff too!

@saifsultanc saifsultanc merged commit 26c1b40 into master Mar 12, 2025
3 of 4 checks passed
@saifsultanc saifsultanc deleted the saif/fix/78865-fix-choice-count branch March 12, 2025 06:25
This was referenced Mar 15, 2025
Closed
Merged
@coderabbitai coderabbitai bot mentioned this pull request Apr 24, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Jun 28, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Aug 7, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@veryspry veryspry veryspry approved these changes

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@saifsultanc @veryspry