summaryrefslogtreecommitdiffstats
path: root/src/utils
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2022-05-24 17:54:23 +0200
committerArmand Philippot <git@armandphilippot.com>2022-05-24 17:54:23 +0200
commit691646c97b09f9150ac823670d6c661358c81c1c (patch)
treecc2115a23d9dae87b7cdfab9223f1366aa629c69 /src/utils
parent041fb0974f624368a45316c296c2a3e3c229dae2 (diff)
chore: give autofocus to the toolbar search form
Diffstat (limited to 'src/utils')
-rw-r--r--src/utils/hooks/use-input-autofocus.tsx39
1 files changed, 39 insertions, 0 deletions
diff --git a/src/utils/hooks/use-input-autofocus.tsx b/src/utils/hooks/use-input-autofocus.tsx
new file mode 100644
index 0000000..c7700e9
--- /dev/null
+++ b/src/utils/hooks/use-input-autofocus.tsx
@@ -0,0 +1,39 @@
+import { RefObject, useEffect } from 'react';
+
+export type UseInputAutofocusProps = {
+ /**
+ * The focus condition. True give focus to the input.
+ */
+ condition: boolean;
+ /**
+ * An optional delay. Default: 0.
+ */
+ delay?: number;
+ /**
+ * A reference to the input element.
+ */
+ ref: RefObject<HTMLInputElement>;
+};
+
+/**
+ * Set focus on an input with an optional delay.
+ */
+const useInputAutofocus = ({
+ condition,
+ delay = 0,
+ ref,
+}: UseInputAutofocusProps) => {
+ useEffect(() => {
+ const timer = setTimeout(() => {
+ if (ref.current && condition) {
+ ref.current.focus();
+ }
+ }, delay);
+
+ return () => {
+ clearTimeout(timer);
+ };
+ }, [condition, delay, ref]);
+};
+
+export default useInputAutofocus;