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

Tooltip2: Prevent closing other overlays when tooltip has the focus and ESC is hit #4471

Merged
merged 4 commits into from
Apr 11, 2024

Conversation

broccolinisoup
Copy link
Member

@broccolinisoup broccolinisoup commented Apr 5, 2024

Due to handling escape events in tooltip via browser (popover api), this causes an issue where tooltip is used on an element on an overlay, hitting esc key closes all overlays. Expected behaviour is that, when tooltip has the focus, hitting escape only close the tooltip.

Video previews describe the current behaviours as before and behaviour after the fix as after.

Before

tooltip-before.mp4

After

tooltip-after.mp4

Changelog

New

  • Added the escape hook to take the responsibility of handling the escape events in the component rather than leaving it to the browser so that we can intercept with it and prevent escape event bubbling up.

Changed

Removed

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

Copy link

changeset-bot bot commented Apr 5, 2024

🦋 Changeset detected

Latest commit: 797b188

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@broccolinisoup broccolinisoup changed the title prevent closing other overlays when tooltip has the focus Tooltip2: Prevent closing other overlays when tooltip has the focus and ESC is hit Apr 5, 2024
Copy link
Contributor

github-actions bot commented Apr 5, 2024

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 87.82 KB (-0.06% 🔽)
packages/react/dist/browser.umd.js 88.21 KB (+0.1% 🔺)

@broccolinisoup broccolinisoup marked this pull request as ready for review April 5, 2024 05:36
@broccolinisoup broccolinisoup requested a review from a team as a code owner April 5, 2024 05:36
Copy link
Member

@siddharthkp siddharthkp left a comment

Choose a reason for hiding this comment

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

Makes sense to me!

It's a little unfortunate but only because we have both portals and popovers together. I think we'll be able to remove this code once all Overlays are also dialog or popover 👍

@broccolinisoup broccolinisoup added this pull request to the merge queue Apr 11, 2024
Merged via the queue into main with commit aa8b6d8 Apr 11, 2024
30 checks passed
@broccolinisoup broccolinisoup deleted the tooltip-esc branch April 11, 2024 04:27
@primer primer bot mentioned this pull request Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants