Skip to content

A local-first personal finance app

Optimize usage of useScrollListener and useTransactionsSearch (#5690)

Joel Jeremy Marquez58bc14e1b3ab
diff --git a/packages/desktop-client/src/components/ScrollProvider.tsx b/packages/desktop-client/src/components/ScrollProvider.tsx
index 1921681e2a..83865c6903 100644
--- a/packages/desktop-client/src/components/ScrollProvider.tsx
+++ b/packages/desktop-client/src/components/ScrollProvider.tsx
@@ -190,6 +190,12 @@ export function ScrollProvider<T extends Element>({
);
}
+/**
+ * A hook to register a listener when the user scrolls within a ScrollProvider.
+ *
+ * @param listener The scroll listener to register. It is important to wrap this function
+ * in useCallback to avoid unnecessary unregistering and reregistering on each render.
+ */
export function useScrollListener(listener: ScrollListener) {
const context = useContext(ScrollContext);
if (!context) {
diff --git a/packages/desktop-client/src/components/mobile/MobileNavTabs.tsx b/packages/desktop-client/src/components/mobile/MobileNavTabs.tsx
index c6a69ca3a7..7268e33798 100644
--- a/packages/desktop-client/src/components/mobile/MobileNavTabs.tsx
+++ b/packages/desktop-client/src/components/mobile/MobileNavTabs.tsx
@@ -149,13 +149,18 @@ export function MobileNavTabs() {
<div key={idx} style={navTabStyle} />
));
- useScrollListener(({ isScrolling, hasScrolledToEnd }) => {
- if (isScrolling('down') && !hasScrolledToEnd('up')) {
- hide();
- } else if (isScrolling('up') && !hasScrolledToEnd('down')) {
- openDefault();
- }
- });
+ useScrollListener(
+ useCallback(
+ ({ isScrolling, hasScrolledToEnd }) => {
+ if (isScrolling('down') && !hasScrolledToEnd('up')) {
+ hide();
+ } else if (isScrolling('up') && !hasScrolledToEnd('down')) {
+ openDefault();
+ }
+ },
+ [hide, openDefault],
+ ),
+ );
const bind = useDrag(
({
diff --git a/packages/desktop-client/src/components/mobile/transactions/TransactionList.tsx b/packages/desktop-client/src/components/mobile/transactions/TransactionList.tsx
index 557728f827..eeff42afbc 100644
--- a/packages/desktop-client/src/components/mobile/transactions/TransactionList.tsx
+++ b/packages/desktop-client/src/components/mobile/transactions/TransactionList.tsx
@@ -139,11 +139,16 @@ export function TransactionList({
[dispatchSelected, onOpenTransaction, selectedTransactions],
);
- useScrollListener(({ hasScrolledToEnd }) => {
- if (hasScrolledToEnd('down', 100)) {
- onLoadMore?.();
- }
- });
+ useScrollListener(
+ useCallback(
+ ({ hasScrolledToEnd }) => {
+ if (hasScrolledToEnd('down', 100)) {
+ onLoadMore?.();
+ }
+ },
+ [onLoadMore],
+ ),
+ );
return (
<>
diff --git a/packages/desktop-client/src/hooks/useTransactionsSearch.ts b/packages/desktop-client/src/hooks/useTransactionsSearch.ts
index 77b6a25827..29a01c3748 100644
--- a/packages/desktop-client/src/hooks/useTransactionsSearch.ts
+++ b/packages/desktop-client/src/hooks/useTransactionsSearch.ts
@@ -1,4 +1,4 @@
-import { useState, useMemo, useEffect } from 'react';
+import { useState, useMemo, useEffect, useRef } from 'react';
import { debounce } from 'lodash';
@@ -25,21 +25,27 @@ export function useTransactionsSearch({
}: UseTransactionsSearchProps): UseTransactionsSearchResult {
const [isSearching, setIsSearching] = useState(false);
+ const updateQueryRef = useRef(updateQuery);
+ updateQueryRef.current = updateQuery;
+
+ const resetQueryRef = useRef(resetQuery);
+ resetQueryRef.current = resetQuery;
+
const updateSearchQuery = useMemo(
() =>
debounce((searchText: string) => {
if (searchText === '') {
- resetQuery();
+ resetQueryRef.current?.();
setIsSearching(false);
} else if (searchText) {
- resetQuery();
- updateQuery(previousQuery =>
+ resetQueryRef.current?.();
+ updateQueryRef.current(previousQuery =>
queries.transactionsSearch(previousQuery, searchText, dateFormat),
);
setIsSearching(true);
}
}, delayMs),
- [dateFormat, delayMs, resetQuery, updateQuery],
+ [dateFormat, delayMs],
);
useEffect(() => {
diff --git a/upcoming-release-notes/5690.md b/upcoming-release-notes/5690.md
new file mode 100644
index 0000000000..51fd87ef91
--- /dev/null
+++ b/upcoming-release-notes/5690.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [joel-jeremy]
+---
+
+Optimize usage of useScrollListener and useTransactionsSearch