Skip to content

[DevTools] Use Popover API for TraceUpdates highlighting #32614

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

Merged
merged 9 commits into from
May 7, 2025
Merged

[DevTools] Use Popover API for TraceUpdates highlighting #32614

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ecb403f
[DevTools] Use Popover API for TraceUpdates highlighting
yongsk0066 Mar 14, 2025
a83589c
[DevTools] Improve TraceUpdates popover behavior
yongsk0066 Mar 17, 2025
9215664
[DevTools] Fix Flow type errors for TraceUpdates popover implementation
yongsk0066 Mar 17, 2025
f7eb1c6
[DevTools] Raise minimum Chrome version to 114 for Popover API support
yongsk0066 Mar 17, 2025
938ad0e
[DevTools] Add explanatory comments to $FlowFixMe annotations for Pop…
yongsk0066 Mar 17, 2025
9c21b1e
[DevTools] Removed unnecessary try-catch blocks around Popover API me…
yongsk0066 Mar 20, 2025
6893d25
[DevTools] Improve TraceUpdates popover layering behavior
yongsk0066 Mar 21, 2025
862826b
[DevTools] Add TraceUpdatesTest component for manual testing
yongsk0066 Mar 21, 2025
c950b0d
[DevTools] Add Flow annotations for TraceUpdates implementation
yongsk0066 Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
[DevTools] Use Popover API for TraceUpdates highlighting 
  This change ensures that component highlighting in React DevTools appears above toplayer elements by using
   the Popover API. This fixes an issue where highlights would appear behind elements that use the browser's
   toplayer (such as dialogs, popovers, etc).

  The implementation gracefully falls back to the previous behavior in browsers that don't support the
  Popover API.
  • Loading branch information
@yongsk0066
yongsk0066 committed Mar 14, 2025
commit ecb403ff4cd59991cefde3e754cb76f6dd1d680a
18 changes: 18 additions & 0 deletions packages/react-devtools-shared/src/backend/views/TraceUpdates/canvas.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ function drawNative(nodeToData: Map<HostInstance, Data>, agent: Agent) {
function drawWeb(nodeToData: Map<HostInstance, Data>) {
if (canvas === null) {
initialize();
} else {
try {
Copy link
Contributor

@hoxyq hoxyq Mar 20, 2025

Choose a reason for hiding this comment

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

Same as above, you don't need it to wrap it in try / catch, since we bumped minimum versions for the extension

Please also check other calls below

Copy link
Contributor Author

@yongsk0066 yongsk0066 Mar 20, 2025

Choose a reason for hiding this comment

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

Thanks for pointing this out! I've removed all try/catch blocks around Popover API calls.

if (canvas.hasAttribute('popover') && !canvas.matches(':popover-open')) {
canvas.showPopover();
}
Copy link
Contributor

@hoxyq hoxyq Mar 17, 2025

Choose a reason for hiding this comment

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

Are you gating it with try/catch because for feature checking?

We might bump the minimum required version for Chrome / other browsers here:
https://github.com/facebook/react/blob/main/packages/react-devtools-extensions/chrome/manifest.json#L7

So you won't need to worry about if its supported or not

Copy link
Contributor Author

@yongsk0066 yongsk0066 Mar 17, 2025

Choose a reason for hiding this comment

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

Yes, that's right. I've handled it in case popover isn't supported. Would it be okay to raise the minimum version? If we do raise it, I plan to increase it to version 114 (https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/showPopover#browser_compatibility) which supports the popover API.

Copy link
Contributor

@hoxyq hoxyq Mar 17, 2025

Choose a reason for hiding this comment

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

Please do it for Edge browser as well. I believe Firefox should already list version that is higher than needed.

Copy link
Contributor Author

@yongsk0066 yongsk0066 Mar 17, 2025

Choose a reason for hiding this comment

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

I've added Edge as well! Yes, Firefox requires 125 or higher, but it's already set to 128, so we're good.

} catch (e) {}
}

const dpr = window.devicePixelRatio || 1;
Expand Down Expand Up @@ -191,6 +197,12 @@ function destroyNative(agent: Agent) {

function destroyWeb() {
if (canvas !== null) {
try {
if (canvas.hasAttribute('popover')) {
canvas.hidePopover();
}
} catch (e) {}

if (canvas.parentNode != null) {
canvas.parentNode.removeChild(canvas);
}
Expand All @@ -204,6 +216,7 @@ export function destroy(agent: Agent): void {

function initialize(): void {
canvas = window.document.createElement('canvas');
canvas.setAttribute('popover', 'auto');
canvas.style.cssText = `
xx-background-color: red;
xx-opacity: 0.5;
Expand All @@ -214,8 +227,13 @@ function initialize(): void {
right: 0;
top: 0;
z-index: 1000000000;
background-color: transparent;
`;

const root = window.document.documentElement;
root.insertBefore(canvas, root.firstChild);

try {
canvas.showPopover();
} catch (e) {}
}
Loading