Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

feat(web): wire the task copy shortcuts (#1897)

Andreja76f70a6bbaf
diff --git a/apps/web/src/components/task/task-actions.tsx b/apps/web/src/components/task/task-actions.tsx
index 0e2563e77..e825aabd9 100644
--- a/apps/web/src/components/task/task-actions.tsx
+++ b/apps/web/src/components/task/task-actions.tsx
@@ -9,6 +9,7 @@ import {
TooltipProvider,
TooltipTrigger,
} from "@/components/ui/tooltip";
+import { shortcuts } from "@/constants/shortcuts";
import type Task from "@/types/task";
import TaskDeleteButton from "./task-delete-button";
import TaskMovePopover from "./task-move-popover";
@@ -31,6 +32,7 @@ export default function TaskActions({
deleteHandle,
}: TaskActionsProps) {
const { t } = useTranslation();
+ const copyModifiers = shortcuts.copyTask.prefix.split("+");
return (
<div className="flex *:not-first:rounded-s-none *:not-first:before:rounded-s-none *:not-last:rounded-e-none *:not-last:border-e-0 *:not-last:before:rounded-e-none">
@@ -43,6 +45,7 @@ export default function TaskActions({
<Button
variant="outline"
size="sm"
+ aria-label={t("tasks:properties.copyTaskLink")}
className="text-foreground"
onClick={onCopyLink}
>
@@ -50,11 +53,13 @@ export default function TaskActions({
</Button>
</TooltipTrigger>
<TooltipContent>
- <KbdSequence
- keys={["Ctrl", "Shift", "C"]}
- description={t("tasks:properties.copyTaskLink")}
- separator=""
- />
+ <span className="flex items-center gap-2">
+ {t("tasks:properties.copyTaskLink")}
+ <KbdSequence
+ keys={[...copyModifiers, shortcuts.copyTask.link.toUpperCase()]}
+ separator=""
+ />
+ </span>
</TooltipContent>
</Tooltip>
<Tooltip>
@@ -62,6 +67,7 @@ export default function TaskActions({
<Button
variant="outline"
size="sm"
+ aria-label={t("tasks:properties.copyTaskBranch")}
className="text-foreground"
onClick={onCopyBranch}
>
@@ -69,11 +75,16 @@ export default function TaskActions({
</Button>
</TooltipTrigger>
<TooltipContent>
- <KbdSequence
- keys={["Ctrl", "Shift", "G"]}
- description={t("tasks:properties.copyTaskBranch")}
- separator=""
- />
+ <span className="flex items-center gap-2">
+ {t("tasks:properties.copyTaskBranch")}
+ <KbdSequence
+ keys={[
+ ...copyModifiers,
+ shortcuts.copyTask.branch.toUpperCase(),
+ ]}
+ separator=""
+ />
+ </span>
</TooltipContent>
</Tooltip>
{task && <TaskDeleteButton handle={deleteHandle} />}
diff --git a/apps/web/src/components/task/task-details-sheet.tsx b/apps/web/src/components/task/task-details-sheet.tsx
index 25a7f9611..41750bf1b 100644
--- a/apps/web/src/components/task/task-details-sheet.tsx
+++ b/apps/web/src/components/task/task-details-sheet.tsx
@@ -125,6 +125,7 @@ export default function TaskDetailsSheet({
className="w-full bg-sidebar border-b border-border flex flex-col gap-0 overflow-y-auto shrink-0"
compact={true}
deleteHandle={deleteHandle}
+ shortcutsEnabled={Boolean(taskId)}
/>
<div className="flex-1 overflow-y-auto min-h-0">
diff --git a/apps/web/src/components/task/task-properties-sidebar.tsx b/apps/web/src/components/task/task-properties-sidebar.tsx
index 0dc44fd74..85025f3b9 100644
--- a/apps/web/src/components/task/task-properties-sidebar.tsx
+++ b/apps/web/src/components/task/task-properties-sidebar.tsx
@@ -19,6 +19,7 @@ import useGetProject from "@/hooks/queries/project/use-get-project";
import useGetProjects from "@/hooks/queries/project/use-get-projects";
import useGetTask from "@/hooks/queries/task/use-get-task";
import { useGetActiveWorkspaceUsers } from "@/hooks/queries/workspace-users/use-get-active-workspace-users";
+import { useTaskCopyShortcuts } from "@/hooks/use-task-copy-shortcuts";
import { getColumnIcon } from "@/lib/column";
import {
dueDateStatusColors,
@@ -68,6 +69,7 @@ type TaskPropertiesSidebarProps = {
className?: string;
compact?: boolean;
deleteHandle: AlertDialogPrimitive.Handle<unknown>;
+ shortcutsEnabled?: boolean;
};
export default function TaskPropertiesSidebar({
@@ -77,6 +79,7 @@ export default function TaskPropertiesSidebar({
className,
compact = false,
deleteHandle,
+ shortcutsEnabled = true,
}: TaskPropertiesSidebarProps) {
const { t } = useTranslation();
const { data: task } = useGetTask(taskId ?? "");
@@ -135,6 +138,12 @@ export default function TaskPropertiesSidebar({
toast.message(t("tasks:properties.taskBranchCopied"));
};
+ useTaskCopyShortcuts({
+ enabled: Boolean(task) && shortcutsEnabled,
+ onCopyLink: handleCopyTaskLink,
+ onCopyBranch: handleCopyTaskBranch,
+ });
+
return (
<div className={className}>
<div className="flex min-h-0 min-w-0 flex-1 flex-col gap-2">
diff --git a/apps/web/src/constants/shortcuts.ts b/apps/web/src/constants/shortcuts.ts
index a5585016c..e5b7943b0 100644
--- a/apps/web/src/constants/shortcuts.ts
+++ b/apps/web/src/constants/shortcuts.ts
@@ -34,6 +34,11 @@ export const shortcuts = {
prefix: getModifierKeyText(),
key: "Backspace",
},
+ copyTask: {
+ prefix: "Ctrl+Shift",
+ link: "c",
+ branch: "g",
+ },
view: {
prefix: "v",
board: "b",
diff --git a/apps/web/src/hooks/use-keyboard-shortcuts.test.tsx b/apps/web/src/hooks/use-keyboard-shortcuts.test.tsx
index 056d73dc5..58d6cb288 100644
--- a/apps/web/src/hooks/use-keyboard-shortcuts.test.tsx
+++ b/apps/web/src/hooks/use-keyboard-shortcuts.test.tsx
@@ -52,3 +52,39 @@ describe("shortcut key normalization", () => {
expect(handler).not.toHaveBeenCalled();
});
});
+
+describe("modifier shortcuts", () => {
+ it("matches shortcuts that need several modifiers", () => {
+ const handler = vi.fn();
+ const { result } = renderHook(useKeyboardShortcuts, {
+ wrapper: KeyboardShortcutsProvider,
+ });
+ act(() =>
+ result.current.registerModifierShortcut("Ctrl+Shift", "c", handler),
+ );
+ fireEvent.keyDown(document.body, { key: "c", ctrlKey: true });
+ expect(handler).not.toHaveBeenCalled();
+ fireEvent.keyDown(document.body, {
+ key: "C",
+ ctrlKey: true,
+ shiftKey: true,
+ });
+ expect(handler).toHaveBeenCalledOnce();
+ });
+
+ it("ignores single-modifier shortcuts while extra modifiers are held", () => {
+ const handler = vi.fn();
+ const { result } = renderHook(useKeyboardShortcuts, {
+ wrapper: KeyboardShortcutsProvider,
+ });
+ act(() => result.current.registerModifierShortcut("Ctrl", "k", handler));
+ fireEvent.keyDown(document.body, {
+ key: "K",
+ ctrlKey: true,
+ shiftKey: true,
+ });
+ expect(handler).not.toHaveBeenCalled();
+ fireEvent.keyDown(document.body, { key: "k", ctrlKey: true });
+ expect(handler).toHaveBeenCalledOnce();
+ });
+});
diff --git a/apps/web/src/hooks/use-keyboard-shortcuts.ts b/apps/web/src/hooks/use-keyboard-shortcuts.ts
index 58789ea54..fc4163ac2 100644
--- a/apps/web/src/hooks/use-keyboard-shortcuts.ts
+++ b/apps/web/src/hooks/use-keyboard-shortcuts.ts
@@ -185,13 +185,14 @@ export function KeyboardShortcutsProvider({
}
if (event.ctrlKey || event.metaKey || event.altKey || event.shiftKey) {
- const modifierKey = event.metaKey
- ? "⌘"
- : event.ctrlKey
- ? "Ctrl"
- : event.altKey
- ? "Alt"
- : "Shift";
+ const modifierKey = [
+ event.metaKey && "⌘",
+ event.ctrlKey && "Ctrl",
+ event.altKey && "Alt",
+ event.shiftKey && "Shift",
+ ]
+ .filter(Boolean)
+ .join("+");
const shortcutKey = `${modifierKey}+${key}`;
if (modifierShortcuts.has(shortcutKey)) {
diff --git a/apps/web/src/hooks/use-task-copy-shortcuts.test.tsx b/apps/web/src/hooks/use-task-copy-shortcuts.test.tsx
new file mode 100644
index 000000000..7ba92e05d
--- /dev/null
+++ b/apps/web/src/hooks/use-task-copy-shortcuts.test.tsx
@@ -0,0 +1,87 @@
+import { cleanup, fireEvent, renderHook } from "@testing-library/react";
+import { afterEach, describe, expect, it, vi } from "vite-plus/test";
+import { KeyboardShortcutsProvider } from "./use-keyboard-shortcuts";
+import { useTaskCopyShortcuts } from "./use-task-copy-shortcuts";
+
+afterEach(cleanup);
+
+function renderCopyShortcuts(enabled: boolean) {
+ const onCopyLink = vi.fn();
+ const onCopyBranch = vi.fn();
+ const view = renderHook(
+ (props: { enabled: boolean }) =>
+ useTaskCopyShortcuts({ ...props, onCopyLink, onCopyBranch }),
+ { initialProps: { enabled }, wrapper: KeyboardShortcutsProvider },
+ );
+ return { ...view, onCopyLink, onCopyBranch };
+}
+
+describe("useTaskCopyShortcuts", () => {
+ it("copies the link and branch with Ctrl+Shift+C and Ctrl+Shift+G", () => {
+ const { onCopyLink, onCopyBranch } = renderCopyShortcuts(true);
+
+ fireEvent.keyDown(document.body, {
+ key: "C",
+ ctrlKey: true,
+ shiftKey: true,
+ });
+ fireEvent.keyDown(document.body, {
+ key: "G",
+ ctrlKey: true,
+ shiftKey: true,
+ });
+
+ expect(onCopyLink).toHaveBeenCalledOnce();
+ expect(onCopyBranch).toHaveBeenCalledOnce();
+ });
+
+ it("stops copying once the view disables its shortcuts", () => {
+ const { onCopyLink, onCopyBranch, rerender } = renderCopyShortcuts(true);
+
+ rerender({ enabled: false });
+ fireEvent.keyDown(document.body, {
+ key: "C",
+ ctrlKey: true,
+ shiftKey: true,
+ });
+ fireEvent.keyDown(document.body, {
+ key: "G",
+ ctrlKey: true,
+ shiftKey: true,
+ });
+
+ expect(onCopyLink).not.toHaveBeenCalled();
+ expect(onCopyBranch).not.toHaveBeenCalled();
+ });
+
+ it("settles and uses the latest handlers when callers pass new ones on every render", () => {
+ const firstLink = vi.fn();
+ const latestLink = vi.fn();
+ let renders = 0;
+ const { rerender } = renderHook(
+ (props: { onCopyLink: () => void }) => {
+ renders += 1;
+ useTaskCopyShortcuts({
+ enabled: true,
+ onCopyLink: () => props.onCopyLink(),
+ onCopyBranch: () => {},
+ });
+ },
+ {
+ initialProps: { onCopyLink: firstLink },
+ wrapper: KeyboardShortcutsProvider,
+ },
+ );
+
+ rerender({ onCopyLink: latestLink });
+ fireEvent.keyDown(document.body, {
+ key: "C",
+ ctrlKey: true,
+ shiftKey: true,
+ });
+
+ expect(renders).toBeLessThan(10);
+ expect(firstLink).not.toHaveBeenCalled();
+ expect(latestLink).toHaveBeenCalledOnce();
+ });
+});
diff --git a/apps/web/src/hooks/use-task-copy-shortcuts.ts b/apps/web/src/hooks/use-task-copy-shortcuts.ts
new file mode 100644
index 000000000..d6442e3ec
--- /dev/null
+++ b/apps/web/src/hooks/use-task-copy-shortcuts.ts
@@ -0,0 +1,37 @@
+import { useLayoutEffect, useMemo, useRef } from "react";
+import { shortcuts } from "@/constants/shortcuts";
+import { useRegisterShortcuts } from "@/hooks/use-keyboard-shortcuts";
+
+type TaskCopyShortcutsOptions = {
+ enabled: boolean;
+ onCopyLink: () => void;
+ onCopyBranch: () => void;
+};
+
+export function useTaskCopyShortcuts({
+ enabled,
+ onCopyLink,
+ onCopyBranch,
+}: TaskCopyShortcutsOptions) {
+ const handlers = useRef({ onCopyLink, onCopyBranch });
+ useLayoutEffect(() => {
+ handlers.current = { onCopyLink, onCopyBranch };
+ });
+
+ const copyShortcuts = useMemo(
+ () =>
+ enabled
+ ? {
+ modifierShortcuts: {
+ [shortcuts.copyTask.prefix]: {
+ [shortcuts.copyTask.link]: () => handlers.current.onCopyLink(),
+ [shortcuts.copyTask.branch]: () =>
+ handlers.current.onCopyBranch(),
+ },
+ },
+ }
+ : {},
+ [enabled],
+ );
+ useRegisterShortcuts(copyShortcuts);
+}