Skip to content

A local-first personal finance app

Make InitialFocus component generic (#5008)

Joel Jeremy Marquezb5ece8e2215d
diff --git a/packages/component-library/src/InitialFocus.ts b/packages/component-library/src/InitialFocus.ts
index 81b01e8a23..d87c48ea5a 100644
--- a/packages/component-library/src/InitialFocus.ts
+++ b/packages/component-library/src/InitialFocus.ts
@@ -8,15 +8,11 @@ import {
useRef,
} from 'react';
-type FocusableElement = HTMLElement;
-
-type InitialFocusProps = {
+type InitialFocusProps<T extends HTMLElement> = {
/**
* The child element to focus when the component mounts. This can be either a single React element or a function that returns a React element.
*/
- children:
- | ReactElement<{ ref: Ref<HTMLElement> }>
- | ((node: Ref<HTMLElement>) => ReactElement);
+ children: ReactElement<{ ref: Ref<T> }> | ((ref: Ref<T>) => ReactElement);
};
/**
@@ -25,22 +21,24 @@ type InitialFocusProps = {
* @param {Object} props - The component props.
* @param {ReactElement | function} props.children - A single React element or a function that returns a React element.
*/
-export function InitialFocus({ children }: InitialFocusProps) {
- const node = useRef<FocusableElement>(null);
+export function InitialFocus<T extends HTMLElement = HTMLElement>({
+ children,
+}: InitialFocusProps<T>) {
+ const ref = useRef<T | null>(null);
useEffect(() => {
- if (node.current) {
+ if (ref.current) {
// This is needed to avoid a strange interaction with
// `ScopeTab`, which doesn't allow it to be focused at first for
// some reason. Need to look into it.
setTimeout(() => {
- if (node.current) {
- node.current.focus();
+ if (ref.current) {
+ ref.current.focus();
if (
- node.current instanceof HTMLInputElement ||
- node.current instanceof HTMLTextAreaElement
+ ref.current instanceof HTMLInputElement ||
+ ref.current instanceof HTMLTextAreaElement
) {
- node.current.setSelectionRange(0, 10000);
+ ref.current.setSelectionRange(0, 10000);
}
}
}, 0);
@@ -48,12 +46,12 @@ export function InitialFocus({ children }: InitialFocusProps) {
}, []);
if (typeof children === 'function') {
- return children(node);
+ return children(ref);
}
const child = Children.only(children);
if (isValidElement(child)) {
- return cloneElement(child, { ref: node });
+ return cloneElement(child, { ref });
}
throw new Error(
'InitialFocus expects a single valid React element as its child.',
diff --git a/packages/desktop-client/src/components/budget/envelope/CoverMenu.tsx b/packages/desktop-client/src/components/budget/envelope/CoverMenu.tsx
index ecdd82637e..b4c5cb5f30 100644
--- a/packages/desktop-client/src/components/budget/envelope/CoverMenu.tsx
+++ b/packages/desktop-client/src/components/budget/envelope/CoverMenu.tsx
@@ -1,4 +1,4 @@
-import React, { type Ref, useMemo, useState } from 'react';
+import React, { useMemo, useState } from 'react';
import { Trans, useTranslation } from 'react-i18next';
import { Button } from '@actual-app/components/button';
@@ -54,7 +54,7 @@ export function CoverMenu({
<Trans>Cover from a category:</Trans>
</View>
- <InitialFocus>
+ <InitialFocus<HTMLInputElement>>
{node => (
<CategoryAutocomplete
categoryGroups={filteredCategoryGroups}
@@ -62,7 +62,7 @@ export function CoverMenu({
openOnFocus={true}
onSelect={(id: string | undefined) => setFromCategoryId(id || null)}
inputProps={{
- inputRef: node as Ref<HTMLInputElement>,
+ inputRef: node,
onEnter: event => !event.defaultPrevented && submit(),
placeholder: t('(none)'),
}}
diff --git a/upcoming-release-notes/5008.md b/upcoming-release-notes/5008.md
new file mode 100644
index 0000000000..6f62d0cbb3
--- /dev/null
+++ b/upcoming-release-notes/5008.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [joel-jeremy]
+---
+
+Make InitialFocus component generic