Fix handling of click events when anchor has nested elements

[gabrieljablonski]

Closes #1220

Reproducible here: https://stackblitz.com/edit/stackblitz-starters-ggwyjh

Clicking E2 opens the tooltip, but clicking again does not close it.

Fixed here (with beta version): https://stackblitz.com/edit/stackblitz-starters-9thax4ga

Summary by CodeRabbit

• Refactor
  • Improved tooltip click interactions for a more intuitive experience. Tooltip behavior is now more robust, ensuring that clicks on nested or contained elements do not inadvertently dismiss the tooltip.

[coderabbitai]

Walkthrough

This pull request modifies the Tooltip component’s event handling logic. A new helper function, activeAnchorContainsTarget, has been introduced to determine if the active anchor contains a given event target. Both the handleClickOpenTooltipAnchor and handleClickCloseTooltipAnchor functions now use this helper function to decide whether to ignore or process click events. The change aims to standardize the condition checks in scenarios involving nested DOM elements.

Changes

File(s)	Change Summary
src/components/Tooltip/Tooltip.tsx	Added the helper function activeAnchorContainsTarget to check if the active anchor contains the event target; updated handleClickOpenTooltipAnchor and handleClickCloseTooltipAnchor to use this helper for determining event handling behavior.

Sequence Diagram(s)

Sequence Diagram - Open Tooltip

sequenceDiagram
  participant U as User
  participant T as Tooltip Component
  participant H as activeAnchorContainsTarget
  U->>T: Click event (open)
  T->>H: Check if active anchor contains event target
  H-->>T: Return true/false
  alt Event target is within active anchor
    T->>U: Ignore click (tooltip remains unchanged)
  else Event target is not within active anchor
    T->>U: Open tooltip
  end

Loading

Sequence Diagram - Close Tooltip

sequenceDiagram
  participant U as User
  participant T as Tooltip Component
  participant H as activeAnchorContainsTarget
  U->>T: Click event (close)
  T->>H: Check if active anchor contains event target
  H-->>T: Return true/false
  alt Event target is within active anchor
    T->>U: Ignore click (tooltip remains open)
  else Event target is not within active anchor
    T->>U: Close tooltip
  end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Ensure tooltip event handlers correctly process clicks from nested DOM elements [#1220]	✅

Possibly related PRs

• Add mouseover and mouseout as default events #1194: Adjusts event handling logic in the Tooltip component similar to the changes introduced here.

Suggested reviewers

• danielbarion

Poem

I'm hopping through the code with glee,
Tweaking tooltips thoughtfully, you see.
Nested clicks now know their part,
Guided by a helper—a work of art!
With every hop, I cheer in style,
Celebrating changes in true rabbit style!
🐇✨

---

📜 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 9cc0685 and b41ecc9.

📒 Files selected for processing (1)

• src/components/Tooltip/Tooltip.tsx (2 hunks)

🔇 Additional comments (3)

src/components/Tooltip/Tooltip.tsx (3)

518-519: Good addition of helper function for improved code DRY

This new helper function elegantly extracts the common logic for checking if the active anchor contains the event target, making the code more maintainable and consistent.

---

520-522: Fix for the nested elements click issue

This change correctly addresses the issue described in PR #1246 where clicking on nested elements within an anchor wasn't properly closing the tooltip. By using the new activeAnchorContainsTarget helper, the component now correctly identifies clicks on any element within the anchor hierarchy.

---

530-531: Symmetrical fix for click handling consistency

This change ensures consistent handling between opening and closing the tooltip. Now both click handlers use the same logic for determining if a click occurred within the anchor's hierarchy, properly handling nested elements.

✨ 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[Copilot]

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

[github-actions]

Beta version released with the last commit 🚀

yarn add react-tooltip@5.28.0-beta.1246.rc.0

or

npm install react-tooltip@5.28.0-beta.1246.rc.0