gw-choice-counter.php: Fixed an issue with Choice Counter not working for Image Choice field.

[saifsultanc]

Context

⛑️ Ticket(s): https://secure.helpscout.net/conversation/2917523082/82535

Summary

The Choice Counter is not working with Image Choice Field. The count is 1 off; you select two, it shows 1. You select 3 it'll show 2.

This update addresses an off-by-one issue when counting selected options in Gravity Forms' Image Choice fields. The problem occurs because clicking on an image triggers a click on the associated label, which then toggles the underlying checkbox. However, the checkbox state wasn't immediately updated at the time of the event, so there was a slight delay before the DOM reflected the change.

Previously, the count was being calculated immediately on click, which sometimes captured the state before the checkbox had updated, leading to inaccurate totals.

BEFORE:

AFTER:

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The change updates the updateChoiceEventHandler method within the GWChoiceCount JavaScript class. Instead of calling updateChoiceCount immediately or using a setTimeout, the method now invokes updateChoiceCount inside a requestAnimationFrame callback. This defers the execution until the next browser repaint cycle, allowing the DOM to update before recalculating the choice count. No other logic or exported/public entity declarations are modified.

Changes

File(s)	Change Summary
gravity-forms/gw-choice-counter.php	Modified GWChoiceCount.updateChoiceEventHandler to call updateChoiceCount inside requestAnimationFrame to defer execution until the next repaint cycle.

Possibly related PRs

• gw-choice-counter.php: Fixed an issue with Choice Counter not working for Image Choice field. #1083: Both PRs modify the same event handler function updateChoiceEventHandler in the GWChoiceCount class to defer the execution of updateChoiceCount for accurate choice counting, differing only in the method of deferral (setTimeout vs requestAnimationFrame).
• gw-choice-counter.php: Fixed Choice Counter not triggering quantity updates. #1046: Both PRs address event handling in the choice counter, with this PR modifying the timing of recalculation and the related PR ensuring native change events are dispatched for quantity updates.

Suggested reviewers

• veryspry

---

📜 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 42b1f7d and eae9025.

📒 Files selected for processing (1)

• gravity-forms/gw-choice-counter.php (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in 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]

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

Generated by 🚫 dangerJS against 42b1f7d