@pantheon-systems/pds-toolkit-react 2.0.0-alpha.52 → 2.0.0-alpha.53

package/dist/index.source.d.ts

@@ -127,6 +127,7 @@ export * from './utilities/hooks/useBreakpoint/useBreakpoint';
 export * from './utilities/hooks/useClipboard/useClipboard';
 export * from './utilities/hooks/useDropdown';
 export * from './utilities/hooks/useIsMobile/useIsMobile';
+export * from './utilities/hooks/useKeyboardShortcut/useKeyboardShortcut';
 export * from './utilities/hooks/useKeyPress/useKeyPress';
 export * from './utilities/hooks/useMediaQuery/useMediaQuery';
 export * from './utilities/hooks/useWindowWidth/useWindowWidth';

package/dist/utilities/hooks/useKeyPress/useKeyPress.d.ts

@@ -20,4 +20,10 @@ export interface UseKeyPressOptions {
      */
     shiftKey?: boolean;
 }
+/**
+ * @deprecated Use `useKeyboardShortcut` instead. `useKeyPress` fires even while
+ * the user is typing in a form field and requires callers to manually disable
+ * shortcuts when an overlay is open; `useKeyboardShortcut` handles both by
+ * default. This hook will be removed before the v2 stable release.
+ */
 export declare const useKeyPress: (targetKey: string, callback?: (event: KeyboardEvent) => void, options?: UseKeyPressOptions) => boolean;

package/dist/utilities/hooks/useKeyboardShortcut/useKeyboardShortcut.d.ts

@@ -0,0 +1,29 @@
+import { HotkeyCallback, Keys, Options } from 'react-hotkeys-hook';
+export type UseKeyboardShortcutOptions = Options;
+/**
+ * Registers a keyboard shortcut, applying the PDS defaults on top of
+ * `react-hotkeys-hook`:
+ *
+ * - **Ignores form fields by default.** Shortcuts do not fire while focus is in
+ *   an `input`, `textarea`, `select`, or `contentEditable` element, so typing a
+ *   shortcut character (e.g. `/`) into a field never hijacks it. Opt in per
+ *   shortcut with `enableOnFormTags` / `enableOnContentEditable` when a shortcut
+ *   genuinely needs to fire inside a field.
+ * - **Overlay-aware.** Shortcuts auto-suppress while any PDS overlay (modal,
+ *   drawer, mobile menu, etc.) is open, so callers never have to thread
+ *   `hasOpenOverlay` through their own `enabled` flag.
+ *
+ * The full `react-hotkeys-hook` option surface (scopes, key sequences,
+ * `description`, cross-platform `mod`, etc.) is available via `options`.
+ *
+ * @param keys - The key or combination to listen for, e.g. `'/'`, `'mod+k'`,
+ *   `'shift+['`. Uses `react-hotkeys-hook` key syntax.
+ * @param callback - Invoked when the shortcut fires. Receives the
+ *   `KeyboardEvent` and the parsed hotkey event.
+ * @param options - `react-hotkeys-hook` options. `enabled` is combined with the
+ *   overlay state so a shortcut is active only when enabled *and* no overlay is
+ *   open.
+ * @param dependencies - Optional dependency array for the callback, forwarded to
+ *   `react-hotkeys-hook`.
+ */
+export declare const useKeyboardShortcut: (keys: Keys, callback: HotkeyCallback, options?: UseKeyboardShortcutOptions, dependencies?: unknown[]) => (instance: HTMLElement) => void;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@pantheon-systems/pds-toolkit-react",
 	"technology": "React",
-	"version": "2.0.0-alpha.52",
+	"version": "2.0.0-alpha.53",
 	"description": "PDS toolkit built using the React framework",
 	"publishConfig": {
 		"access": "public",
@@ -163,7 +163,6 @@
 		"prettier-plugin-css-order": "^2.2.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
-		"react-router-dom": "^7.0.0",
 		"storybook": "^10.4.0",
 		"tsc-alias": "^1.8.17",
 		"typescript": "^5.4.5",
@@ -205,7 +204,14 @@
 		"@babel/plugin-transform-modules-systemjs": "^7.29.4",
 		"fast-uri": "^3.1.4",
 		"hono": "^4.12.18",
-		"ip-address": "^10.1.1"
+		"ip-address": "^10.1.1",
+		"micromatch": "^4.0.8",
+		"minimatch": "^10.0.0",
+		"postcss-insert": {
+			"postcss": "^8.4.31"
+		},
+		"valibot": "^1.4.2",
+		"yaml": "^2.8.3"
 	},
 	"lint-staged": {
 		"*": "prettier --write --ignore-unknown",