@plannotator/ui 0.53.0 → 0.54.0

package/shortcuts/runtime.ts

@@ -5,6 +5,7 @@ import {
   matchesShortcutBinding,
   matchesShortcutBindingGroup,
   parseDoubleTapBinding,
+  resolveShortcutBindings,
 } from './core';
 
 type ShortcutActionId<TScope extends ShortcutScopeDefinition<any>> = keyof TScope['shortcuts'] & string;
@@ -27,6 +28,12 @@ export interface UseShortcutScopeOptions<TScope extends ShortcutScopeDefinition<
   handlers: ShortcutHandlers<TScope>;
   target?: ShortcutEventTarget;
   stopOnMatch?: boolean;
+  /**
+   * Listen in the capture phase: the scope sees a key before the focused
+   * element does (a guard that must run before a component's own handler).
+   * Default false (bubble), so a component that used the key first can say so.
+   */
+  capture?: boolean;
 }
 
 interface ShortcutSequenceCandidate {
@@ -80,7 +87,7 @@ export function dispatchShortcutEvent<TScope extends ShortcutScopeDefinition<any
   for (const [actionId, shortcut] of getShortcutEntries(scope)) {
     const handler = handlers[actionId];
     if (!handler) continue;
-    if (!shortcut.bindings.some(binding => matchesShortcutBinding(event, binding))) continue;
+    if (!resolveShortcutBindings(shortcut).some(binding => matchesShortcutBinding(event, binding))) continue;
 
     const { when, handle } = normalizeShortcutHandler(handler);
     if (when && !when(event)) continue;
@@ -123,6 +130,7 @@ export function useShortcutScope<TScope extends ShortcutScopeDefinition<any>>({
   handlers,
   target = 'window',
   stopOnMatch = true,
+  capture = false,
 }: UseShortcutScopeOptions<TScope>) {
   const handlersRef = useRef(handlers);
   const sequenceRef = useRef<ShortcutSequenceState | null>(null);
@@ -182,7 +190,7 @@ export function useShortcutScope<TScope extends ShortcutScopeDefinition<any>>({
         const { when } = normalizeShortcutHandler(handler);
         if (when && !when(keyboardEvent)) continue;
 
-        for (const binding of shortcut.bindings) {
+        for (const binding of resolveShortcutBindings(shortcut)) {
           const groups = binding.trim().split(/\s+/).filter(Boolean);
           const doubleTapKey = parseDoubleTapBinding(binding);
           if (
@@ -206,11 +214,11 @@ export function useShortcutScope<TScope extends ShortcutScopeDefinition<any>>({
       if (started.length > 0) keyboardEvent.preventDefault();
     };
 
-    eventTarget.addEventListener('keydown', handleKeyDown);
+    eventTarget.addEventListener('keydown', handleKeyDown, capture);
     return () => {
-      eventTarget.removeEventListener('keydown', handleKeyDown);
+      eventTarget.removeEventListener('keydown', handleKeyDown, capture);
     };
-  }, [scope, stopOnMatch, target]);
+  }, [scope, stopOnMatch, target, capture]);
 }
 
 export function createShortcutScopeHook<TScope extends ShortcutScopeDefinition<any>>(scope: TScope) {
@@ -268,7 +276,7 @@ export function useDoubleTapShortcuts<TScope extends ShortcutScopeDefinition<any
     // Pre-parse which actions have double-tap bindings
     const doubleTapActions: Array<{ actionId: ShortcutActionId<TScope>; keyName: string; preventDefault: boolean }> = [];
     for (const [actionId, shortcut] of getShortcutEntries(scope)) {
-      for (const binding of shortcut.bindings) {
+      for (const binding of resolveShortcutBindings(shortcut)) {
         const keyName = parseDoubleTapBinding(binding);
         if (keyName) {
           doubleTapActions.push({ actionId, keyName, preventDefault: shortcut.preventDefault === true });