diff --git a/docs/studio/index.mdx b/docs/studio/index.mdx index 5ba9c2cced..9362561c2c 100644 --- a/docs/studio/index.mdx +++ b/docs/studio/index.mdx @@ -70,6 +70,10 @@ share it. Shortcuts depend on the active area. The table below covers the shortcuts implemented by the browser editor's player, canvas, and timeline. +Press `?` (Shift + /) to open the shortcuts panel from the timeline toolbar, and +press it again or Esc to close it. It does nothing while you are typing in a text +field. + ### Playback | Shortcut | Action | diff --git a/packages/studio/src/player/components/ShortcutsPanel.test.tsx b/packages/studio/src/player/components/ShortcutsPanel.test.tsx index 9ac8b6f352..eb3378c830 100644 --- a/packages/studio/src/player/components/ShortcutsPanel.test.tsx +++ b/packages/studio/src/player/components/ShortcutsPanel.test.tsx @@ -58,6 +58,20 @@ function panelOf(trigger: HTMLButtonElement): HTMLElement { return document.getElementById(trigger.getAttribute("aria-controls")!)!; } +function pressQuestionMark(target: Element): KeyboardEvent { + const event = new KeyboardEvent("keydown", { + key: "?", + code: "Slash", + shiftKey: true, + bubbles: true, + cancelable: true, + }); + act(() => { + target.dispatchEvent(event); + }); + return event; +} + describe("ShortcutsPanel", () => { it.each(["page", "button", "panel"] as const)( "closes with Escape from the %s-focused position", @@ -93,6 +107,67 @@ describe("ShortcutsPanel", () => { }, ); + it("opens with ? and closes with ? again or Escape", () => { + const { trigger } = renderPanel(); + + pressQuestionMark(document.body); + expect(trigger.getAttribute("aria-expanded")).toBe("true"); + expect(panelOf(trigger).textContent).toContain("Show / hide this panel"); + + pressQuestionMark(document.activeElement ?? document.body); + expect(trigger.getAttribute("aria-expanded")).toBe("false"); + + pressQuestionMark(document.body); + expect(trigger.getAttribute("aria-expanded")).toBe("true"); + act(() => { + document.dispatchEvent(new KeyboardEvent("keydown", { key: "Escape", bubbles: true })); + }); + expect(trigger.getAttribute("aria-expanded")).toBe("false"); + }); + + it("does not show the button's tooltip when ? opens the panel", async () => { + const { trigger } = renderPanel(); + + pressQuestionMark(document.body); + await act(async () => { + await new Promise((resolve) => setTimeout(resolve, 0)); + }); + + expect(document.querySelector('[role="tooltip"]')).toBeNull(); + expect(trigger.getAttribute("aria-describedby")).toBeNull(); + }); + + it.each([ + ["an input", () => document.createElement("input")], + ["a textarea", () => document.createElement("textarea")], + [ + "a contenteditable", + () => { + const editable = document.createElement("div"); + editable.contentEditable = "true"; + return editable; + }, + ], + ])("leaves ? to %s", (_, createField) => { + const field = createField(); + document.body.append(field); + const { trigger } = renderPanel(); + + const event = pressQuestionMark(field); + + expect(trigger.getAttribute("aria-expanded")).toBe("false"); + expect(event.defaultPrevented).toBe(false); + }); + + it("leaves ? to the panel's own frame input while open", () => { + const { trigger } = renderPanel(); + openPanel(trigger); + + pressQuestionMark(document.querySelector('[aria-label="Jump to frame"]')!); + + expect(trigger.getAttribute("aria-expanded")).toBe("true"); + }); + it("closes on an outside press whose pointerdown a canvas gesture prevented", () => { const preventDefault = (event: Event) => event.preventDefault(); document.addEventListener("pointerdown", preventDefault, true); diff --git a/packages/studio/src/player/components/ShortcutsPanel.tsx b/packages/studio/src/player/components/ShortcutsPanel.tsx index e7b2bc3748..182a62c5ae 100644 --- a/packages/studio/src/player/components/ShortcutsPanel.tsx +++ b/packages/studio/src/player/components/ShortcutsPanel.tsx @@ -1,10 +1,11 @@ -import { useState, useCallback, useRef, memo } from "react"; +import { useState, useCallback, useEffect, useRef, memo } from "react"; import { formatTime, frameToSeconds } from "../lib/time"; import { Popover, Tooltip } from "../../components/ui"; import { flatActive, flatIdle } from "../../components/timelineToolbarStyles"; import { usePlayerStore } from "../store/playerStore"; import { useCompositionFps } from "../../utils/linkedClipPreferences"; -import { useShortcutSections, type ShortcutSection } from "./studioShortcuts"; +import { matchesKey, useShortcutSections, type ShortcutSection } from "./studioShortcuts"; +import { isTypingTarget } from "../../utils/typingTarget"; interface ShortcutsPanelProps { disabled: boolean; @@ -20,6 +21,21 @@ interface ShortcutsPanelProps { /** Stays above its button, shrinking to the room there, rather than flipping down over the timeline. */ const STAY_ABOVE = { side: "none", align: "shift", fallbackAxisSide: "none" } as const; +function useShortcutsOpen() { + const [open, setOpen] = useState(false); + useEffect(() => { + const onKeyDown = (e: KeyboardEvent) => { + if (e.defaultPrevented || e.repeat || isTypingTarget(e.target)) return; + if (!matchesKey(e, "shortcuts")) return; + e.preventDefault(); + setOpen((wasOpen) => !wasOpen); + }; + document.addEventListener("keydown", onKeyDown); + return () => document.removeEventListener("keydown", onKeyDown); + }, []); + return [open, setOpen] as const; +} + export const ShortcutsPanel = memo(function ShortcutsPanel({ disabled, duration, @@ -31,7 +47,7 @@ export const ShortcutsPanel = memo(function ShortcutsPanel({ sections: hostSections, }: ShortcutsPanelProps) { const sections = useShortcutSections(hostSections); - const [showShortcuts, setShowShortcuts] = useState(false); + const [showShortcuts, setShowShortcuts] = useShortcutsOpen(); const [jumpFrame, setJumpFrame] = useState(""); const compositionFps = useCompositionFps(); // Focus lands on the scrolling body, not the frame input, so keyboard users can scroll and read it. @@ -62,7 +78,7 @@ export const ShortcutsPanel = memo(function ShortcutsPanel({ ); return ( - +