[FIX] rename useRequestIdleCallback hook to useIdle

Author: nDriaDev

…tIdleCallback/UseRequestIdleCallback.tsx …src/components/hooks/useIdle/UseIdle.tsxapps/react-tools-demo/src/components/hooks/useRequestIdleCallback/UseRequestIdleCallback.tsx renamed to apps/react-tools-demo/src/components/hooks/useIdle/UseIdle.tsx apps/react-tools-demo/src/components/hooks/useRequestIdleCallback/UseRequestIdleCallback.tsx renamed to apps/react-tools-demo/src/components/hooks/useIdle/UseIdle.tsx

@@ -1,18 +1,18 @@
 import { useState } from "react"
-import { useRequestIdleCallback } from "../../../../../../packages/react-tools/src";
+import { useIdle } from "../../../../../../packages/react-tools/src";
 
 
 /**
 The component has:
 - a __iterations__ variable of type string.
 - a __log__ variable of type string.
-- a function __invoke__ returned from _useRequestIdleCallback_ hook, initialized with a cb that update __log__ variable with message _"RequestIdleCallback executed"_.
+- a function __invoke__ returned from _useIdle_ hook, initialized with a cb that update __log__ variable with message _"RequestIdleCallback executed"_.
 - a button start that when clicked executes __start__ function that executes __invoke__ function and updates __iterations__ variable inside a loop with iteration index.
  */
-export const UseRequestIdleCallback = () => {
+export const UseIdle = () => {
 	const [iterations, setIterations] = useState(0);
 	const [log, setLog] = useState("");
-	const [invoke] = useRequestIdleCallback(() => setLog("RequestIdleCallback executed"));
+	const [invoke] = useIdle(() => setLog("RequestIdleCallback executed"));
 
 	const start = async() => {
 		invoke();

apps/react-tools-demo/src/constants/components.ts

@@ -70,7 +70,7 @@ export const COMPONENTS = [
 			"useMediaQuery",
 			"useColorScheme",
 			"useTitle",
-			"useRequestIdleCallback"
+			"useIdle"
 		]
 	],
 	//UTILS

packages/react-tools/README.md

@@ -82,7 +82,7 @@
 	- [x] useMediaQuery
 	- [x] useColorScheme
 	- [x] useTitle (change document.title but also document.head.title nodeElement)
-	- [x] useRequestIdleCallback
+	- [x] useIdle
 	- [ ] useFullscreen (check browser compatibility)
 	- [ ] useLanguage (?)
 	- [ ] useScreenShare

packages/react-tools/src/hooks/index.ts

@@ -51,4 +51,4 @@ export { useIsOnline } from './useIsOnline';
 export { useResizeObserver } from './useResizeObserver';
 export { useIntersectionObserver } from './useIntersectionObserver';
 export { useMutationObserver } from './useMutationObserver';
-export { useRequestIdleCallback } from './useRequestIdleCallback';
+export { useIdle } from './useIdle';

…ools/src/hooks/useRequestIdleCallback.ts packages/react-tools/src/hooks/useIdle.tspackages/react-tools/src/hooks/useRequestIdleCallback.ts renamed to packages/react-tools/src/hooks/useIdle.ts packages/react-tools/src/hooks/useRequestIdleCallback.ts renamed to packages/react-tools/src/hooks/useIdle.ts

@@ -1,12 +1,12 @@
 import { useCallback, useRef } from "react"
 
 /**
- * **`useRequestIdleCallback`**: Hook to use [requestIdleCallback](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback) in React. The __options__ parameter differs from _IdleRequestOptions_ type: it adds the possibility to pass another property __unsupportedBehavior__ to specify what do if requestIdleCallback is not supported.
+ * **`useIdle`**: Hook to invoke a callback when the browser is idle. Refer to [requestIdleCallback](https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback) in React. The __options__ parameter differs from _IdleRequestOptions_ type: it adds the possibility to pass another property __unsupportedBehavior__ to specify what do if requestIdleCallback is not supported.
  * @param {(deadline?: IdleDeadline | DOMHighResTimeStamp | void)=> void} cb -callback that should be called in the near future.
  * @param {IdleRequestOptions & { unsupportedBehavior: "animationFrame"|"timeout"|"immediatly" }} [opts] - Contains optional configuration parameters.
  * @returns {[()=>void, ()=>void]} result - array where functions to invoke and cancel execution.
  */
-export const useRequestIdleCallback = (cb: (deadline?: IdleDeadline | DOMHighResTimeStamp | void) => void, opts?: {timeout: number , unsupportedBehavior?: "animationFrame" | "timeout" | "immediatly" }): [() => void, () => void] => {
+export const useIdle = (cb: (deadline?: IdleDeadline | DOMHighResTimeStamp | void) => void, opts?: {timeout: number , unsupportedBehavior?: "animationFrame" | "timeout" | "immediatly" }): [() => void, () => void] => {
 	const {timeout, unsupportedBehavior} = opts || {};
 	const idRequest = useRef<number|null>();
 

packages/react-tools/src/index.ts

@@ -65,7 +65,7 @@ export {
 	useResizeObserver,
 	useIntersectionObserver,
 	useMutationObserver,
-	useRequestIdleCallback
+	useIdle
 } from './hooks'
 
 export {