Skip to content

fix(Tasks): implement hotkeysEnabled state to control keyboard shortcuts #426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShivaGupta-14 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(Tasks): implement hotkeysEnabled state to control keyboard shortcuts #426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 128 additions & 73 deletions frontend/src/components/HomeComponents/Tasks/Tasks.tsx
View file
Open in desktop
Copy link
Contributor Author

@ShivaGupta-14 ShivaGupta-14 Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

implement checking of hotkeysEnabled state before executing

Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,9 @@ export const Tasks = (
new Set()
);
const tableRef = useRef<HTMLDivElement>(null);
const [hotkeysEnabled, setHotkeysEnabled] = useState(false);
const [isMouseOver, setIsMouseOver] = useState(false);
const [activeContext, setActiveContext] = useState<string | null>(null);
const hotkeysEnabled = activeContext === 'TASKS' || isMouseOver;
const [selectedIndex, setSelectedIndex] = useState(0);
const {
state: editState,
Expand Down Expand Up @@ -150,8 +152,27 @@ export const Tasks = (
const paginate = (pageNumber: number) => setCurrentPage(pageNumber);
const totalPages = Math.ceil(tempTasks.length / tasksPerPage) || 1;

useEffect(() => {
const handleGlobalPointerDown = (e: PointerEvent) => {
if (tableRef.current && !tableRef.current.contains(e.target as Node)) {
setActiveContext(null);
}
};

document.addEventListener('pointerdown', handleGlobalPointerDown, true);
return () => {
document.removeEventListener(
'pointerdown',
handleGlobalPointerDown,
true
);
};
}, []);

useEffect(() => {
const handler = (e: KeyboardEvent) => {
if (!hotkeysEnabled) return;

const target = e.target as HTMLElement;
if (
target instanceof HTMLInputElement ||
Expand Down Expand Up @@ -991,83 +1012,115 @@ export const Tasks = (
}
};

useHotkeys(['f'], () => {
if (!showReports) {
document.getElementById('search')?.focus();
}
});
useHotkeys(['a'], () => {
if (!showReports) {
document.getElementById('add-new-task')?.click();
}
});
useHotkeys(['r'], () => {
if (!showReports) {
document.getElementById('sync-task')?.click();
}
});
useHotkeys(['p'], () => {
if (!showReports) {
document.getElementById('projects')?.click();
}
});
useHotkeys(['s'], () => {
if (!showReports) {
document.getElementById('status')?.click();
}
});
useHotkeys(['t'], () => {
if (!showReports) {
document.getElementById('tags')?.click();
}
});
useHotkeys(['c'], () => {
if (!showReports && !_isDialogOpen) {
const task = currentTasks[selectedIndex];
if (!task) return;
const openBtn = document.getElementById(`task-row-${task.id}`);
openBtn?.click();
setTimeout(() => {
const confirmBtn = document.getElementById(
`mark-task-complete-${task.id}`
);
confirmBtn?.click();
}, 200);
} else {
if (_isDialogOpen) {
useHotkeys(
['f'],
() => {
if (!showReports) {
document.getElementById('search')?.focus();
}
},
hotkeysEnabled
);
useHotkeys(
['a'],
() => {
if (!showReports) {
document.getElementById('add-new-task')?.click();
}
},
hotkeysEnabled
);
useHotkeys(
['r'],
() => {
if (!showReports) {
document.getElementById('sync-task')?.click();
}
},
hotkeysEnabled
);
useHotkeys(
['p'],
() => {
if (!showReports) {
document.getElementById('projects')?.click();
}
},
hotkeysEnabled
);
useHotkeys(
['s'],
() => {
if (!showReports) {
document.getElementById('status')?.click();
}
},
hotkeysEnabled
);
useHotkeys(
['t'],
() => {
if (!showReports) {
document.getElementById('tags')?.click();
}
},
hotkeysEnabled
);
useHotkeys(
['c'],
() => {
if (!showReports && !_isDialogOpen) {
const task = currentTasks[selectedIndex];
if (!task) return;
const confirmBtn = document.getElementById(
`mark-task-complete-${task.id}`
);
confirmBtn?.click();
const openBtn = document.getElementById(`task-row-${task.id}`);
openBtn?.click();
setTimeout(() => {
const confirmBtn = document.getElementById(
`mark-task-complete-${task.id}`
);
confirmBtn?.click();
}, 200);
} else {
if (_isDialogOpen) {
const task = currentTasks[selectedIndex];
if (!task) return;
const confirmBtn = document.getElementById(
`mark-task-complete-${task.id}`
);
confirmBtn?.click();
}
}
}
});
},
hotkeysEnabled
);

useHotkeys(['d'], () => {
if (!showReports && !_isDialogOpen) {
const task = currentTasks[selectedIndex];
if (!task) return;
const openBtn = document.getElementById(`task-row-${task.id}`);
openBtn?.click();
setTimeout(() => {
const confirmBtn = document.getElementById(
`mark-task-as-deleted-${task.id}`
);
confirmBtn?.click();
}, 200);
} else {
if (_isDialogOpen) {
useHotkeys(
['d'],
() => {
if (!showReports && !_isDialogOpen) {
const task = currentTasks[selectedIndex];
if (!task) return;
const confirmBtn = document.getElementById(
`mark-task-as-deleted-${task.id}`
);
confirmBtn?.click();
const openBtn = document.getElementById(`task-row-${task.id}`);
openBtn?.click();
setTimeout(() => {
const confirmBtn = document.getElementById(
`mark-task-as-deleted-${task.id}`
);
confirmBtn?.click();
}, 200);
} else {
if (_isDialogOpen) {
const task = currentTasks[selectedIndex];
if (!task) return;
const confirmBtn = document.getElementById(
`mark-task-as-deleted-${task.id}`
);
confirmBtn?.click();
}
}
}
});
},
hotkeysEnabled
);

return (
<section
Expand Down Expand Up @@ -1128,8 +1181,10 @@ export const Tasks = (
) : (
<div
ref={tableRef}
onMouseEnter={() => setHotkeysEnabled(true)}
onMouseLeave={() => setHotkeysEnabled(false)}
data-testid="tasks-table-container"
Copy link
Contributor Author

@ShivaGupta-14 ShivaGupta-14 Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added data-testid for testing hover behavior

onPointerDown={() => setActiveContext('TASKS')}
onMouseEnter={() => setIsMouseOver(true)}
onMouseLeave={() => setIsMouseOver(false)}
>
{tasks.length != 0 ? (
<>
Expand Down
84 changes: 84 additions & 0 deletions frontend/src/components/HomeComponents/Tasks/__tests__/Tasks.test.tsx
View file
Open in desktop
Copy link
Contributor Author

@ShivaGupta-14 ShivaGupta-14 Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added tests for hotkeysEnabled behavior

Original file line number Diff line number Diff line change
Expand Up @@ -1737,4 +1737,88 @@ describe('Tasks Component', () => {
expect(task1Row).toBeInTheDocument();
});
});

describe('Hotkeys Enable/Disable on Hover and Active Context', () => {
test('hotkeys are disabled by default (mouse not over task table)', async () => {
render(<Tasks {...mockProps} />);
await screen.findByText('Task 1');

fireEvent.keyDown(window, { key: 'f' });

const searchInput = screen.getByPlaceholderText('Search tasks...');
expect(document.activeElement).not.toBe(searchInput);
});

test('hotkeys are enabled when mouse enters task table', async () => {
render(<Tasks {...mockProps} />);
await screen.findByText('Task 1');

const taskContainer = screen.getByTestId('tasks-table-container');
fireEvent.mouseEnter(taskContainer);

fireEvent.keyDown(window, { key: 'f' });

const searchInput = screen.getByPlaceholderText('Search tasks...');
expect(document.activeElement).toBe(searchInput);
});

test('hotkeys are disabled when mouse leaves task table', async () => {
render(<Tasks {...mockProps} />);
await screen.findByText('Task 1');

const taskContainer = screen.getByTestId('tasks-table-container');

fireEvent.mouseEnter(taskContainer);
fireEvent.mouseLeave(taskContainer);

fireEvent.keyDown(window, { key: 'f' });

const searchInput = screen.getByPlaceholderText('Search tasks...');
expect(document.activeElement).not.toBe(searchInput);
});

test('hotkeys are enabled when user clicks/taps on task table', async () => {
render(<Tasks {...mockProps} />);
await screen.findByText('Task 1');

const taskContainer = screen.getByTestId('tasks-table-container');

fireEvent.pointerDown(taskContainer);
fireEvent.keyDown(window, { key: 'f' });

const searchInput = screen.getByPlaceholderText('Search tasks...');

expect(document.activeElement).toBe(searchInput);
});

test('hotkeys remain enabled after mouse leaves if user clicked on task table', async () => {
render(<Tasks {...mockProps} />);
await screen.findByText('Task 1');

const taskContainer = screen.getByTestId('tasks-table-container');

fireEvent.pointerDown(taskContainer);
fireEvent.mouseLeave(taskContainer);
fireEvent.keyDown(window, { key: 'f' });

const searchInput = screen.getByPlaceholderText('Search tasks...');

expect(document.activeElement).toBe(searchInput);
});

test('hotkeys are disabled when user clicks outside task table', async () => {
render(<Tasks {...mockProps} />);
await screen.findByText('Task 1');

const taskContainer = screen.getByTestId('tasks-table-container');

fireEvent.pointerDown(taskContainer);
fireEvent.pointerDown(document.body);
fireEvent.keyDown(window, { key: 'f' });

const searchInput = screen.getByPlaceholderText('Search tasks...');

expect(document.activeElement).not.toBe(searchInput);
});
});
});
39 changes: 39 additions & 0 deletions frontend/src/components/utils/__tests__/use-hotkeys.test.ts
View file
Open in desktop
Copy link
Contributor Author

@ShivaGupta-14 ShivaGupta-14 Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added tests for enabled

Original file line number Diff line number Diff line change
Expand Up @@ -216,4 +216,43 @@ describe('useHotkeys', () => {

removeEventListenerSpy.mockRestore();
});

it('should call callback when enabled is true', () => {
renderHook(() => useHotkeys(['s'], callback, true));

const event = new KeyboardEvent('keydown', {
key: 's',
bubbles: true,
});

window.dispatchEvent(event);

expect(callback).toHaveBeenCalledTimes(1);
});

it('should not call callback when enabled is false', () => {
renderHook(() => useHotkeys(['s'], callback, false));

const event = new KeyboardEvent('keydown', {
key: 's',
bubbles: true,
});

window.dispatchEvent(event);

expect(callback).not.toHaveBeenCalled();
});

it('should default enabled to true when not provided', () => {
renderHook(() => useHotkeys(['s'], callback));

const event = new KeyboardEvent('keydown', {
key: 's',
bubbles: true,
});

window.dispatchEvent(event);

expect(callback).toHaveBeenCalledTimes(1);
});
});
10 changes: 8 additions & 2 deletions frontend/src/components/utils/use-hotkeys.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
import { useEffect } from 'react';

export function useHotkeys(keys: string[], callback: () => void) {
export function useHotkeys(
keys: string[],
callback: () => void,
enabled: boolean = true
Copy link
Contributor Author

@ShivaGupta-14 ShivaGupta-14 Jan 21, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

enabled with default true and when it false, hook will return early without adding any event listeners

) {
useEffect(() => {
if (!enabled) return;

const handler = (e: KeyboardEvent) => {
const target = e.target as HTMLElement;
if (
Expand Down Expand Up @@ -29,5 +35,5 @@ export function useHotkeys(keys: string[], callback: () => void) {

window.addEventListener('keydown', handler);
return () => window.removeEventListener('keydown', handler);
}, [keys, callback]);
}, [keys, callback, enabled]);
}
Loading