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.

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

fix(overlay): allow overlay to persist on hover #3706

Merged
merged 4 commits into from
Oct 10, 2023
Merged

fix(overlay): allow overlay to persist on hover #3706

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8ea6cd2
fix(overlay): allow overlay to persist on hover
Oct 6, 2023
d455fd3
test(overlay): edit overlay timing test
Oct 6, 2023
d46f854
chore: address comments
Oct 6, 2023
49ddacc
chore: update the right tests, remove unused code
Oct 9, 2023
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
37 changes: 36 additions & 1 deletion packages/overlay/src/Overlay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ import { PlacementController } from './PlacementController.js';
import styles from './overlay.css.js';

const LONGPRESS_DURATION = 300;
const HOVER_DELAY = 300;
Copy link
Collaborator

Choose a reason for hiding this comment

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

how did you arrive at the 300ms duration? what likelihood is this going to be a tunable value?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great question! And great catch! I actually just picked an arbitrary number. I think I started with 400 and subconsciously changed it to 300 when I put this variable next to the longpress one 😅 I'll circle back on this and put some rationale behind this number and change it if needed!


type LongpressEvent = {
source: 'pointer' | 'keyboard';
Expand Down Expand Up @@ -146,6 +147,7 @@ export class Overlay extends OverlayFeatures {
'null';

private longressTimeout!: ReturnType<typeof setTimeout>;
private hoverTimeout?: ReturnType<typeof setTimeout>;

/**
* The `offset` property accepts either a single number, to
Expand Down Expand Up @@ -561,6 +563,11 @@ export class Overlay extends OverlayFeatures {
this.handlePointerleave,
options
);
this.addEventListener(
'pointerenter',
this.handleOverlayPointerenter,
options
);
this.addEventListener(
'pointerleave',
this.handleOverlayPointerleave,
Expand Down Expand Up @@ -789,11 +796,35 @@ export class Overlay extends OverlayFeatures {
private pointerentered = false;

protected handlePointerenter = (): void => {
if (this.hoverTimeout) {
clearTimeout(this.hoverTimeout);
delete this.hoverTimeout;
}
if (this.disabled) return;
this.open = true;
this.pointerentered = true;
};

// set a timeout once the pointer enters and the overlay is shown
// give the user time to enter the overlay

protected handleOverlayPointerenter = (event: PointerEvent): void => {
if (
this.triggerElement === event.relatedTarget ||
(this.hasNonVirtualTrigger &&
(this.triggerElement as HTMLElement).contains(
event.relatedTarget as Node
))
) {
return;
}

if (this.hoverTimeout) {
clearTimeout(this.hoverTimeout);
delete this.hoverTimeout;
}
};

protected handlePointerleave = (event: PointerEvent): void => {
if (
this === event.relatedTarget ||
Expand All @@ -814,6 +845,7 @@ export class Overlay extends OverlayFeatures {
) {
return;
}

this.doPointerleave();
};

Expand All @@ -834,7 +866,10 @@ export class Overlay extends OverlayFeatures {
this.pointerentered = false;
const triggerElement = this.triggerElement as HTMLElement;
if (this.focusedin && triggerElement.matches(':focus-visible')) return;
this.open = false;

this.hoverTimeout = setTimeout(() => {
this.open = false;
}, HOVER_DELAY);
}

protected handleLongpress = (): void => {
Expand Down
11 changes: 7 additions & 4 deletions packages/overlay/test/overlay.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import {
} from '@spectrum-web-components/overlay';

import {
aTimeout,
elementUpdated,
expect,
html,
Expand Down Expand Up @@ -768,7 +769,7 @@ describe('Overlay - type="modal"', () => {
});
});
describe('Overlay - timing', () => {
it('manages multiple modals in a row without preventing them from closing', async () => {
it.only('manages multiple modals in a row without preventing them from closing', async () => {
najikahalsema marked this conversation as resolved.
Show resolved Hide resolved
const test = await fixture<HTMLDivElement>(html`
<div>
<overlay-trigger id="test-1" placement="right">
Expand Down Expand Up @@ -824,6 +825,7 @@ describe('Overlay - timing', () => {
});
await nextFrame();
await nextFrame();

// Move pointer out of "Trigger 1", should _start_ to close "hover" content.
await sendMouse({
steps: [
Expand All @@ -833,8 +835,9 @@ describe('Overlay - timing', () => {
},
],
});
await nextFrame();
await nextFrame();
// allow "hover" content to close by waiting for its timer to complete
await aTimeout(400);
Copy link
Contributor

Choose a reason for hiding this comment

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

If the tooltip should be “closed” at this point, could we leverage an sp-closed listener instead?

najikahalsema marked this conversation as resolved.
Show resolved Hide resolved

// Move pointer over "Trigger 2", should _start_ to open "hover" content.
await sendMouse({
steps: [
Expand Down Expand Up @@ -875,7 +878,7 @@ describe('Overlay - timing', () => {
],
});
await closed;

await aTimeout(200);
najikahalsema marked this conversation as resolved.
Show resolved Hide resolved
// Both overlays are closed.
// Neither trigger received "focus" because the pointer "clicked" away, redirecting focus to <body>
expect(overlayTrigger1.hasAttribute('open')).to.be.false;
Expand Down