Files
element-web/src/hooks/useAnimation.ts
David Langley 69ee8fd96a Change License: AGPL + Element Commercial (#28856)
* Add commercial licence and update config files

* Update license in headers

* Revert "Update license in headers"

This reverts commit 7ed7949485.

* Update only spdx id

* Remove LicenseRef- from package.json

LicenseRef- no longer allowed in npm v3 package.json
This fixes the warning in the logs and failing build check.
2025-01-06 11:18:54 +00:00

48 lines
1.4 KiB
TypeScript

/*
Copyright 2024 New Vector Ltd.
Copyright 2022 The Matrix.org Foundation C.I.C.
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
Please see LICENSE files in the repository root for full details.
*/
import { logger } from "matrix-js-sdk/src/logger";
import { useCallback, useEffect, useRef } from "react";
import SettingsStore from "../settings/SettingsStore";
const debuglog = (...args: any[]): void => {
if (SettingsStore.getValue("debug_animation")) {
logger.log.call(console, "Animation debuglog:", ...args);
}
};
export function useAnimation(enabled: boolean, callback: (timestamp: DOMHighResTimeStamp) => boolean): void {
const handle = useRef<number | null>(null);
const handler = useCallback(
(timestamp: DOMHighResTimeStamp) => {
if (callback(timestamp)) {
handle.current = requestAnimationFrame(handler);
} else {
debuglog("Finished animation!");
}
},
[callback],
);
useEffect(() => {
debuglog("Started animation!");
if (enabled) {
handle.current = requestAnimationFrame(handler);
}
return () => {
if (handle.current) {
debuglog("Aborted animation!");
cancelAnimationFrame(handle.current);
handle.current = null;
}
};
}, [enabled, handler]);
}