Files
element-web/src/hooks/useTimeoutToggle.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

43 lines
1.1 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 { useEffect, useRef, useState } from "react";
/**
* Hook that allows toggling a boolean value and resets it after a timeout.
*
* @param {boolean} defaultValue Default value
* @param {number} timeoutMs Time after that the value will be reset
*/
export const useTimeoutToggle = (
defaultValue: boolean,
timeoutMs: number,
): {
value: boolean;
toggle(): void;
} => {
const timeoutId = useRef<number | undefined>();
const [value, setValue] = useState<boolean>(defaultValue);
const toggle = (): void => {
setValue(!defaultValue);
timeoutId.current = window.setTimeout(() => setValue(defaultValue), timeoutMs);
};
useEffect(() => {
return () => {
clearTimeout(timeoutId.current);
};
});
return {
toggle,
value,
};
};