51 lines
1.4 KiB
TypeScript
51 lines
1.4 KiB
TypeScript
/*
|
|
Copyright 2022 The Matrix.org Foundation C.I.C.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
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,
|
|
};
|
|
};
|