Skip to content

A local-first personal finance app

add CTRL/CMD + Enter as keyboard shortcut to only add single transaction (#6037)

Matt Fiddaman32bd929ed5ac
diff --git a/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-1-chromium-linux.png b/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-1-chromium-linux.png
index f9490ced67..fed0beb93a 100644
Binary files a/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-1-chromium-linux.png and b/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-1-chromium-linux.png differ
diff --git a/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-2-chromium-linux.png b/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-2-chromium-linux.png
index 338b947c6e..208b4986f6 100644
Binary files a/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-2-chromium-linux.png and b/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-2-chromium-linux.png differ
diff --git a/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-3-chromium-linux.png b/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-3-chromium-linux.png
index 8b41d87657..aef1d6b040 100644
Binary files a/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-3-chromium-linux.png and b/packages/desktop-client/e2e/help-menu.test.ts-snapshots/Help-menu-Check-the-keyboard-shortcuts-modal-visuals-3-chromium-linux.png differ
diff --git a/packages/desktop-client/src/components/modals/KeyboardShortcutModal.tsx b/packages/desktop-client/src/components/modals/KeyboardShortcutModal.tsx
index b93c079778..dc7c6609d6 100644
--- a/packages/desktop-client/src/components/modals/KeyboardShortcutModal.tsx
+++ b/packages/desktop-client/src/components/modals/KeyboardShortcutModal.tsx
@@ -316,6 +316,12 @@ export function KeyboardShortcutModal() {
shortcut: 'T',
description: t('Add a new transaction'),
},
+ {
+ id: 'add-transaction-and-close',
+ shortcut: 'Enter',
+ meta: ctrl,
+ description: t('Add transaction and close form'),
+ },
{
id: 'filter-transactions',
shortcut: 'F',
diff --git a/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx b/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx
index 7c55081062..555f4ed013 100644
--- a/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx
+++ b/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx
@@ -952,6 +952,72 @@ describe('Transactions', () => {
);
});
+ test('ctrl/cmd+enter adds transaction and closes form', async () => {
+ const { container, getTransactions, updateProps } = renderTransactions({
+ onCloseAddTransaction: () => {
+ updateProps({ isAdding: false });
+ },
+ });
+
+ expect(getTransactions().length).toBe(5);
+ updateProps({ isAdding: true });
+ expect(
+ container.querySelector('[data-testid="new-transaction"]'),
+ ).toBeTruthy();
+
+ let input = await editNewField(container, 'notes');
+ await userEvent.clear(input);
+ await userEvent.type(input, 'test transaction');
+
+ input = await editNewField(container, 'debit');
+ await userEvent.clear(input);
+ await userEvent.type(input, '50.00');
+
+ await userEvent.keyboard('{Control>}{Enter}{/Control}');
+
+ expect(getTransactions().length).toBe(6);
+ expect(getTransactions()[0].amount).toBe(-5000);
+ expect(getTransactions()[0].notes).toBe('test transaction');
+
+ expect(container.querySelector('[data-testid="new-transaction"]')).toBe(
+ null,
+ );
+ });
+
+ test('ctrl/cmd+click on add button adds transaction and closes form', async () => {
+ const { container, getTransactions, updateProps } = renderTransactions({
+ onCloseAddTransaction: () => {
+ updateProps({ isAdding: false });
+ },
+ });
+
+ expect(getTransactions().length).toBe(5);
+ updateProps({ isAdding: true });
+ expect(
+ container.querySelector('[data-testid="new-transaction"]'),
+ ).toBeTruthy();
+
+ let input = await editNewField(container, 'notes');
+ await userEvent.clear(input);
+ await userEvent.type(input, 'test transaction');
+
+ input = await editNewField(container, 'debit');
+ await userEvent.clear(input);
+ await userEvent.type(input, '50.00');
+ await userEvent.tab();
+
+ const addButton = container.querySelector('[data-testid="add-button"]')!;
+ fireEvent.click(addButton, { ctrlKey: true });
+
+ expect(getTransactions().length).toBe(6);
+ expect(getTransactions()[0].amount).toBe(-5000);
+ expect(getTransactions()[0].notes).toBe('test transaction');
+
+ expect(container.querySelector('[data-testid="new-transaction"]')).toBe(
+ null,
+ );
+ });
+
test('transaction can be selected', async () => {
const { container } = renderTransactions();
diff --git a/packages/desktop-client/src/components/transactions/TransactionsTable.tsx b/packages/desktop-client/src/components/transactions/TransactionsTable.tsx
index 11c529d18d..14cb8fe99d 100644
--- a/packages/desktop-client/src/components/transactions/TransactionsTable.tsx
+++ b/packages/desktop-client/src/components/transactions/TransactionsTable.tsx
@@ -1768,6 +1768,7 @@ type NewTransactionProps = {
focusedField: string;
hideFraction: boolean;
onAdd: () => void;
+ onAddAndClose: () => void;
onAddSplit: (id: TransactionEntity['id']) => void;
onToggleSplit: (id: TransactionEntity['id']) => void;
onClose: () => void;
@@ -1816,6 +1817,7 @@ function NewTransaction({
onDelete,
onSave,
onAdd,
+ onAddAndClose,
onAddSplit,
onDistributeRemainder,
onManagePayees,
@@ -1839,6 +1841,14 @@ function NewTransaction({
const cancelButtonRef = useRef(null);
useProperFocus(cancelButtonRef, focusedField === 'cancel');
+ const handleAddClick = (e: { ctrlKey?: boolean; metaKey?: boolean }) => {
+ if (e.ctrlKey || e.metaKey) {
+ onAddAndClose();
+ } else {
+ onAdd();
+ }
+ };
+
return (
<View
style={{
@@ -1921,7 +1931,7 @@ function NewTransaction({
<Button
variant="primary"
style={{ padding: '4px 10px' }}
- onPress={onAdd}
+ onPress={handleAddClick}
data-testid="add-button"
ref={addButtonRef}
>
@@ -2001,6 +2011,7 @@ type TransactionTableInnerProps = {
onCheckNewEnter: (e: KeyboardEvent) => void;
onCheckEnter: (e: KeyboardEvent) => void;
onAddTemporary: (id?: TransactionEntity['id']) => void;
+ onAddAndCloseTemporary: () => void;
onDistributeRemainder: (id: TransactionEntity['id']) => void;
onToggleSplit: (id: TransactionEntity['id']) => void;
onManagePayees: (id?: PayeeEntity['id']) => void;
@@ -2232,6 +2243,7 @@ function TransactionTableInner({
hideFraction={props.hideFraction}
onClose={props.onCloseAddTransaction}
onAdd={props.onAddTemporary}
+ onAddAndClose={props.onAddAndCloseTemporary}
onAddSplit={props.onAddSplit}
onToggleSplit={props.onToggleSplit}
onSplit={props.onSplit}
@@ -2470,6 +2482,7 @@ export const TransactionTable = forwardRef(
getFieldsTableTransaction,
);
const shouldAdd = useRef(false);
+ const shouldAddAndClose = useRef(false);
const latestState = useRef<TableState>({
newTransactions: newTransactions ?? [],
newNavigator,
@@ -2501,7 +2514,7 @@ export const TransactionTable = forwardRef(
setPrevIsAdding(props.isAdding);
}
- if (shouldAdd.current) {
+ if (shouldAdd.current || shouldAddAndClose.current) {
if (newTransactions?.[0] && newTransactions[0].account == null) {
dispatch(
addNotification({
@@ -2514,18 +2527,26 @@ export const TransactionTable = forwardRef(
newNavigator.onEdit('temp', 'account');
} else {
const transactions = latestState.current.newTransactions;
- const lastDate = transactions.length > 0 ? transactions[0].date : null;
- setNewTransactions(
- makeTemporaryTransactions(
- props.currentAccountId,
- props.currentCategoryId,
- lastDate,
- ),
- );
- newNavigator.onEdit('temp', 'date');
- props.onAdd(transactions);
+
+ if (shouldAddAndClose.current) {
+ props.onAdd(transactions);
+ props.onCloseAddTransaction();
+ } else {
+ const lastDate =
+ transactions.length > 0 ? transactions[0].date : null;
+ setNewTransactions(
+ makeTemporaryTransactions(
+ props.currentAccountId,
+ props.currentCategoryId,
+ lastDate,
+ ),
+ );
+ newNavigator.onEdit('temp', 'date');
+ props.onAdd(transactions);
+ }
}
shouldAdd.current = false;
+ shouldAddAndClose.current = false;
}
useEffect(() => {
@@ -2602,9 +2623,11 @@ export const TransactionTable = forwardRef(
function onCheckNewEnter(e: KeyboardEvent) {
if (e.key === 'Enter') {
- if (e.metaKey) {
+ if (e.metaKey || e.ctrlKey) {
+ e.preventDefault();
e.stopPropagation();
- onAddTemporary();
+ shouldAddAndClose.current = true;
+ forceRerender({});
} else if (!e.shiftKey) {
function getLastTransaction(state: RefObject<TableState>) {
const { newTransactions } = state.current;
@@ -2674,6 +2697,11 @@ export const TransactionTable = forwardRef(
forceRerender({});
}, []);
+ const onAddAndCloseTemporary = useCallback(() => {
+ shouldAddAndClose.current = true;
+ forceRerender({});
+ }, []);
+
const {
onSave: onSaveProp,
onApplyRules: onApplyRulesProp,
@@ -2970,6 +2998,7 @@ export const TransactionTable = forwardRef(
onCheckNewEnter={onCheckNewEnter}
onCheckEnter={onCheckEnter}
onAddTemporary={onAddTemporary}
+ onAddAndCloseTemporary={onAddAndCloseTemporary}
onAddSplit={onAddSplit}
onDistributeRemainder={onDistributeRemainder}
onCloseAddTransaction={onCloseAddTransaction}
diff --git a/upcoming-release-notes/6037.md b/upcoming-release-notes/6037.md
new file mode 100644
index 0000000000..f23cece04f
--- /dev/null
+++ b/upcoming-release-notes/6037.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [matt-fidd]
+---
+
+Add CTRL/CMD + Enter as keyboard shortcut to only add single transaction