A local-first personal finance app
[AI] feat(transactions): auto-widen amount columns to fit content (#8645)
Stephen Brown II3290ebee7348
diff --git a/packages/desktop-client/e2e/accounts.test.ts b/packages/desktop-client/e2e/accounts.test.tsindex 08d4740acc..0b08d402df 100644--- a/packages/desktop-client/e2e/accounts.test.ts+++ b/packages/desktop-client/e2e/accounts.test.ts@@ -42,6 +42,22 @@ test.describe('Accounts', () => {await expect(page).toMatchThemeScreenshots();});+ test('account register widens amount columns for large balances', async () => {+ accountPage = await navigation.createAccount({+ name: 'Large Balance Account',+ offBudget: false,+ balance: 12345678.9,+ });++ const transaction = accountPage.getNthTransaction(0);+ await expect(transaction.credit).toHaveText('12,345,678.90');++ const creditBox = await transaction.credit.boundingBox();+ expect(creditBox?.width).toBeGreaterThan(100); // default width is 100px++ await expect(page).toMatchThemeScreenshots();+ });+test('closes an account', async () => {accountPage = await navigation.goToAccountPage('Roth IRA');diff --git a/packages/desktop-client/e2e/accounts.test.ts-snapshots/Accounts-account-register-widens-amount-columns-for-large-balances-1-chromium-linux.png b/packages/desktop-client/e2e/accounts.test.ts-snapshots/Accounts-account-register-widens-amount-columns-for-large-balances-1-chromium-linux.pngnew file mode 100644index 0000000000..8f31b0c31eBinary files /dev/null and b/packages/desktop-client/e2e/accounts.test.ts-snapshots/Accounts-account-register-widens-amount-columns-for-large-balances-1-chromium-linux.png differdiff --git a/packages/desktop-client/e2e/accounts.test.ts-snapshots/Accounts-account-register-widens-amount-columns-for-large-balances-2-chromium-linux.png b/packages/desktop-client/e2e/accounts.test.ts-snapshots/Accounts-account-register-widens-amount-columns-for-large-balances-2-chromium-linux.pngnew file mode 100644index 0000000000..32f1982abdBinary files /dev/null and b/packages/desktop-client/e2e/accounts.test.ts-snapshots/Accounts-account-register-widens-amount-columns-for-large-balances-2-chromium-linux.png differdiff --git a/packages/desktop-client/e2e/accounts.test.ts-snapshots/Accounts-account-register-widens-amount-columns-for-large-balances-3-chromium-linux.png b/packages/desktop-client/e2e/accounts.test.ts-snapshots/Accounts-account-register-widens-amount-columns-for-large-balances-3-chromium-linux.pngnew file mode 100644index 0000000000..d255778a6eBinary files /dev/null and b/packages/desktop-client/e2e/accounts.test.ts-snapshots/Accounts-account-register-widens-amount-columns-for-large-balances-3-chromium-linux.png differdiff --git a/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx b/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsxindex e62d9b5098..ac8414aea2 100644--- a/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx+++ b/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx@@ -22,7 +22,13 @@ import type {TagEntity,TransactionEntity,} from '@actual-app/core/types/models';-import { fireEvent, render, screen, waitFor } from '@testing-library/react';+import {+ fireEvent,+ render,+ renderHook,+ screen,+ waitFor,+} from '@testing-library/react';import userEvent from '@testing-library/user-event';import { format as formatDate, parse as parseDate } from 'date-fns';import { v4 as uuidv4 } from 'uuid';@@ -36,7 +42,11 @@ import { createTestQueryClient, TestProviders } from '#mocks';import { payeeQueries } from '#payees';import { tagQueries } from '#tags/queries';-import { TransactionTable } from './TransactionsTable';+import {+ DEFAULT_AMOUNT_COLUMN_WIDTHS,+ TransactionTable,+ useAmountColumnWidths,+} from './TransactionsTable';const queryClient = createTestQueryClient();@@ -1534,3 +1544,37 @@ describe('Transactions', () => {});});});++describe('useAmountColumnWidths', () => {+ function transaction(amount: number) {+ return generateTransaction({ account: accounts[0].id, amount })[0];+ }++ it('does not narrow below the default minimum for short-value accounts', () => {+ const { result } = renderHook(() =>+ useAmountColumnWidths([transaction(150), transaction(-200)], null),+ );++ expect(result.current).toEqual(DEFAULT_AMOUNT_COLUMN_WIDTHS);+ });++ it('widens the balance column for a long formatted balance value', () => {+ const { result } = renderHook(() =>+ useAmountColumnWidths([transaction(150)], { 'tx-1': 123456789012345 }),+ );++ expect(result.current.balance).toBeGreaterThan(+ DEFAULT_AMOUNT_COLUMN_WIDTHS.balance,+ );+ });++ it('widens the amount column for a long formatted amount', () => {+ const { result } = renderHook(() =>+ useAmountColumnWidths([transaction(123456789012)], null),+ );++ expect(result.current.amount).toBeGreaterThan(+ DEFAULT_AMOUNT_COLUMN_WIDTHS.amount,+ );+ });+});diff --git a/packages/desktop-client/src/components/transactions/TransactionsTable.tsx b/packages/desktop-client/src/components/transactions/TransactionsTable.tsxindex 78a5918c92..746577dce1 100644--- a/packages/desktop-client/src/components/transactions/TransactionsTable.tsx+++ b/packages/desktop-client/src/components/transactions/TransactionsTable.tsx@@ -160,6 +160,58 @@ import type {} from './table/utils';import { useTransactionRowContextActions } from './useTransactionRowContextActions';+type AmountColumnWidths = {+ amount: number; // Applies to both debit and credit columns+ balance: number;+};++export const DEFAULT_AMOUNT_COLUMN_WIDTHS: AmountColumnWidths = {+ amount: 100,+ balance: 103,+};++// Tabular numerals (styles.tnum) make every digit glyph the same width, so a+// per-character estimate is a good enough proxy for the pixel width for a+// formatted amount. This would need to be adjusted with the font size.+const AMOUNT_COLUMN_CHAR_WIDTH = 7;+const AMOUNT_COLUMN_PADDING = 16;++function measureAmountColumnWidth(values: string[], minWidth: number) {+ const maxChars = values.reduce(+ (max, value) => Math.max(max, value.length),+ 0,+ );+ return Math.max(+ minWidth,+ maxChars * AMOUNT_COLUMN_CHAR_WIDTH + AMOUNT_COLUMN_PADDING,+ );+}++// Widths are computed from every transaction currently loaded so the+// column doesn't jump width while scrolling.+export function useAmountColumnWidths(+ transactions: TransactionEntity[],+ balances: Record<TransactionEntity['id'], IntegerAmount> | null,+): AmountColumnWidths {+ const debitCreditValues = transactions.map(t =>+ integerToCurrency(Math.abs(t.amount ?? 0)),+ );+ const balanceValues = balances+ ? Object.values(balances).map(balance => integerToCurrency(balance))+ : [];++ return {+ amount: measureAmountColumnWidth(+ debitCreditValues,+ DEFAULT_AMOUNT_COLUMN_WIDTHS.amount,+ ),+ balance: measureAmountColumnWidth(+ balanceValues,+ DEFAULT_AMOUNT_COLUMN_WIDTHS.balance,+ ),+ };+}+type TransactionHeaderProps = {hasSelected: boolean;columns: TransactionTableColumnId[];@@ -168,6 +220,7 @@ type TransactionHeaderProps = {onSort: (field: string, ascDesc: 'asc' | 'desc') => void;ascDesc: 'asc' | 'desc';field: string;+ amountColumnWidths: AmountColumnWidths;};const TransactionHeader = memo(@@ -179,6 +232,7 @@ const TransactionHeader = memo(ascDesc,field,showSelection,+ amountColumnWidths,}: TransactionHeaderProps) => {const dispatchSelected = useSelectedDispatch();const { t } = useTranslation();@@ -245,21 +299,21 @@ const TransactionHeader = memo(},payment: {value: columnLabels.payment,- width: 100,+ width: amountColumnWidths.amount,alignItems: 'flex-end',marginRight: -5,sortDirection: 'asc',},deposit: {value: columnLabels.deposit,- width: 100,+ width: amountColumnWidths.amount,alignItems: 'flex-end',marginRight: -5,sortDirection: 'desc',},balance: {value: t('Balance'),- width: 103,+ width: amountColumnWidths.balance,alignItems: 'flex-end',marginRight: -5,},@@ -977,6 +1031,7 @@ type TransactionProps = {onDragChange?: OnDragChangeCallback<TransactionEntity>;onDrop?: OnDropCallback;index: number;+ amountColumnWidths: AmountColumnWidths;};const Transaction = memo(function Transaction({@@ -1035,6 +1090,7 @@ const Transaction = memo(function Transaction({onDragChange,onDrop,index,+ amountColumnWidths,}: TransactionProps) {const { t } = useTranslation();@@ -1905,7 +1961,7 @@ const Transaction = memo(function Transaction({key={columnId}/* Debit field for all transactions */type="input"- width={100}+ width={amountColumnWidths.amount}name="debit"exposed={focusedField === 'debit'}focused={focusedField === 'debit'}@@ -1940,7 +1996,7 @@ const Transaction = memo(function Transaction({key={columnId}/* Credit field for all transactions */type="input"- width={100}+ width={amountColumnWidths.amount}name="credit"exposed={focusedField === 'credit'}focused={focusedField === 'credit'}@@ -1986,7 +2042,7 @@ const Transaction = memo(function Transaction({: theme.numberPositive,}}style={{ ...styles.tnum, ...amountStyle }}- width={103}+ width={amountColumnWidths.balance}textAlign="right"privacyFilter/>@@ -2312,6 +2368,7 @@ type NewTransactionProps = {columns: TransactionTableColumnId[];balance?: number | null;transactions: TransactionEntity[];+ amountColumnWidths: AmountColumnWidths;transferAccountsByTransaction: {[id: TransactionEntity['id']]: AccountEntity | null;};@@ -2319,6 +2376,7 @@ type NewTransactionProps = {};function NewTransaction({transactions,+ amountColumnWidths,accounts,categoryGroups,payees,@@ -2384,6 +2442,7 @@ function NewTransaction({<Transactionkey={transaction.id}index={index}+ amountColumnWidths={amountColumnWidths}editing={editingTransaction === transaction.id}transaction={transaction}subtransactions={transaction.is_parent ? childTransactions : null}@@ -2605,6 +2664,11 @@ function TransactionTableInner({[props.transactions, props.showReconciled],);+ const amountColumnWidths = useAmountColumnWidths(+ transactionsToRender,+ props.balances,+ );+const renderRow: TableProps<TransactionEntity>['renderItem'] = ({item,index,@@ -2702,6 +2766,7 @@ function TransactionTableInner({matched={isMatched?.(trans.id)}showZeroInDeposit={isChildDeposit}balance={balances?.[trans.id] ?? 0}+ amountColumnWidths={amountColumnWidths}focusedField={editing ? tableNavigator.focusedField : undefined}accounts={accounts}categoryGroups={categoryGroups}@@ -2776,6 +2841,7 @@ function TransactionTableInner({ascDesc={props.ascDesc}field={props.sortField}showSelection={props.showSelection}+ amountColumnWidths={amountColumnWidths}/>{props.isAdding && (@@ -2786,6 +2852,7 @@ function TransactionTableInner({><NewTransactiontransactions={props.newTransactions}+ amountColumnWidths={amountColumnWidths}transferAccountsByTransaction={props.transferAccountsByTransaction}diff --git a/upcoming-release-notes/transactions-table-column-autowidth.md b/upcoming-release-notes/transactions-table-column-autowidth.mdnew file mode 100644index 0000000000..87a429e437--- /dev/null+++ b/upcoming-release-notes/transactions-table-column-autowidth.md@@ -0,0 +1,6 @@+---+category: Enhancements+authors: [StephenBrown2]+---++Payment, Deposit, and Balance columns in the account register now widen automatically to fit the longest amount