Skip to content

fix: avoid dummy element stage animation #620

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

Closed
RahilAlam929 wants to merge 1 commit into from
Closed

fix: avoid dummy element stage animation #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/driver/src/highlight.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ function transferHighlight(ctx: Context, toElement: Element, toStep: DriveStep)
isPopoverRendered = true;
}

if (ctx.getConfig("animate") && elapsed < duration) {
if (ctx.getConfig("animate") && elapsed < duration && !(isFromDummyElement && isToDummyElement)) {
transitionStage(ctx, elapsed, duration, fromElement, toElement);
} else {
trackActiveElement(ctx, toElement);
Expand Down
49 changes: 45 additions & 4 deletions packages/driver/tests/animation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
import { describe, expect, it, vi } from "vitest";
import { createDriver, nextFrame, popoverTitle, SAMPLE_STEPS, useDriverHarness } from "./utils";
import {
createDriver,
nextFrame,
popoverTitle,
SAMPLE_STEPS,
useDriverHarness,
} from "./utils";

useDriverHarness();

// Advances the rAF loop until the predicate holds or the frame budget runs out.
// The animated stage transition settles over several frames, so polling beats a
// fixed wait.
async function flushFrames(predicate: () => boolean, maxFrames = 120): Promise<void> {
async function flushFrames(
predicate: () => boolean,
maxFrames = 120,
): Promise<void> {
for (let i = 0; i < maxFrames; i++) {
if (predicate()) {
return;
Expand All @@ -18,7 +27,8 @@ async function flushFrames(predicate: () => boolean, maxFrames = 120): Promise<v

// The library drives the CSS fade via a custom property on <body> so a single
// `duration` config controls both the JS stage slide and the CSS fade-in.
const cssDuration = () => document.body.style.getPropertyValue("--driver-animation-duration");
const cssDuration = () =>
document.body.style.getPropertyValue("--driver-animation-duration");

describe("animation duration", () => {
it("defaults to 400ms", () => {
Expand Down Expand Up @@ -59,7 +69,13 @@ describe("animation duration", () => {
describe("animated stage transition", () => {
it("runs the rAF stage transition and settles on the next step", async () => {
const onHighlighted = vi.fn();
const d = createDriver({ animate: true, duration: 30, steps: SAMPLE_STEPS, onHighlighted });
const d = createDriver({
animate: true,
duration: 30,
steps: SAMPLE_STEPS,
onHighlighted,
});

d.drive();

await flushFrames(() => onHighlighted.mock.calls.length >= 1);
Expand All @@ -74,4 +90,29 @@ describe("animated stage transition", () => {
expect(popoverTitle()).toBe("Step 2");
expect(d.getState("__activeStep")?.popover?.title).toBe("Step 2");
});

it("does not animate the stage between consecutive element-less steps", async () => {
const d = createDriver({
animate: true,
duration: 30,
steps: [
{ popover: { title: "Centered 1" } },
{ popover: { title: "Centered 2" } },
],
});

d.drive();

await flushFrames(() => popoverTitle() === "Centered 1");

expect(d.getActiveIndex()).toBe(0);
expect(popoverTitle()).toBe("Centered 1");

d.moveNext();

await flushFrames(() => popoverTitle() === "Centered 2");

expect(d.getActiveIndex()).toBe(1);
expect(popoverTitle()).toBe("Centered 2");
});
});