Skip to content

refactor: use requestAnimationFrame to replace readTask #10432

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
jcfranco merged 2 commits into from
Oct 1, 2024
Merged

refactor: use requestAnimationFrame to replace readTask #10432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6802fb
refactor: use `requestAnimationFrame` to replace `readTask`
jcfranco Sep 28, 2024
6c5986d
tidy up
jcfranco Oct 1, 2024
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
3 changes: 1 addition & 2 deletions packages/calcite-components/src/components/stepper/stepper.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import {
State,
VNode,
Watch,
readTask,
} from "@stencil/core";
import { focusElementInGroup, slotChangeGetAssignedElements } from "../../utils/dom";
import { Position, Scale } from "../interfaces";
Expand Down Expand Up @@ -356,7 +355,7 @@ export class Stepper implements LocalizedComponent, T9nComponent {

@Watch("currentActivePosition")
handlePositionChange(): void {
readTask((): void => {
requestAnimationFrame((): void => {
this.determineActiveStepper();
});
}
Expand Down
5 changes: 2 additions & 3 deletions packages/calcite-components/src/components/tab-nav/tab-nav.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import {
Host,
Listen,
Prop,
readTask,
State,
VNode,
Watch,
Expand Down Expand Up @@ -262,7 +261,7 @@ export class TabNav implements LocalizedComponent, T9nComponent {
return;
}

readTask(() => {
requestAnimationFrame(() => {
const isLTR = this.effectiveDir === "ltr";
const tabTitleContainer = this.tabTitleContainerEl;
const containerBounds = tabTitleContainer.getBoundingClientRect();
Expand Down Expand Up @@ -487,7 +486,7 @@ export class TabNav implements LocalizedComponent, T9nComponent {
}

private scrollToTabTitles = (direction: "forward" | "backward"): void => {
readTask(() => {
requestAnimationFrame(() => {
const tabTitleContainer = this.tabTitleContainerEl;
const containerBounds = tabTitleContainer.getBoundingClientRect();
const tabTitles = Array.from(this.el.querySelectorAll("calcite-tab-title"));
Expand Down
5 changes: 4 additions & 1 deletion packages/calcite-components/src/utils/openCloseComponent.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ describe("openCloseComponent", () => {
let dispatchTransitionEvent: TransitionEventDispatcher;

beforeEach(() => {
jest.spyOn(openCloseComponent, "internalReadTask").mockImplementation((task) => task(1337));
jest.spyOn(global, "requestAnimationFrame").mockImplementation((cb) => {
cb(0);
return 0;
});
dispatchTransitionEvent = createTransitionEventDispatcher();
});

Expand Down
8 changes: 1 addition & 7 deletions packages/calcite-components/src/utils/openCloseComponent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
import { readTask } from "@stencil/core";
import { whenTransitionDone } from "./dom";

/**
* Exported for testing purposes only
*/
export const internalReadTask = readTask;

/**
* Defines interface for components with open/close public emitter.
* All implementations of this interface must handle the following events: `beforeOpen`, `open`, `beforeClose`, `close`.
Expand Down Expand Up @@ -86,7 +80,7 @@ function isOpen(component: OpenCloseComponent): boolean {
* @param component - OpenCloseComponent uses `open` prop to emit (before)open/close.
*/
export function onToggleOpenCloseComponent(component: OpenCloseComponent): void {
internalReadTask((): void => {
requestAnimationFrame((): void => {
if (!component.transitionEl) {
return;
}
Expand Down