From bd40b34fb959fa5f9e50a5358551a2b078bf6ee2 Mon Sep 17 00:00:00 2001
From: LB Johnston <mail@lb.ee>
Date: Fri, 19 Apr 2024 07:22:10 +1000
Subject: [PATCH] Add missing examples for KeyboardController

Based on PR #11853
---
 client/src/controllers/KeyboardController.ts | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/client/src/controllers/KeyboardController.ts b/client/src/controllers/KeyboardController.ts
index 660244d78a..8ecf73a9b8 100644
--- a/client/src/controllers/KeyboardController.ts
+++ b/client/src/controllers/KeyboardController.ts
@@ -15,6 +15,16 @@ import 'mousetrap/plugins/global-bind/mousetrap-global-bind';
  * <button type="button" data-controller="w-kbd" data-w-kbd-key="[">Trigger me with the <kbd>[</kbd> key.</button>
  * ```
  *
+ * @example - use `mod` for `ctrl` on Windows and `cmd` on MacOS
+ * ```html
+ * <button type="button" data-controller="w-kbd" data-w-kbd-key="mod+s">Trigger me with <kbd>ctrl+p</kbd> on Windows or <kbd>cmd+p</kbd> on MacOS.</button>
+ * ```
+ *
+ * @example - use 'global' scope to allow the shortcut to work even when an input is focused
+ * ```html
+ * <button type="button" data-controller="w-kbd" data-w-kbd-key="mod+s" data-w-kbd-scope-value="global">Trigger me globally.</button>
+ * ```
+ *
  * @example - use aria-keyshortcuts (when the key string is compatible with Mousetrap's syntax)
  * @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-keyshortcuts
  * ```html