From d6c3c9c179eba0c9536a1beaaeb0525a63e752f3 Mon Sep 17 00:00:00 2001
From: Aylur <k.demeter@protonmail.com>
Date: Wed, 1 Jan 2025 19:48:13 +0100
Subject: docs(faq): how to register keybindings

close #223
---
 docs/guide/typescript/faq.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

(limited to 'docs/guide/typescript/faq.md')

diff --git a/docs/guide/typescript/faq.md b/docs/guide/typescript/faq.md
index 1d08824..132900a 100644
--- a/docs/guide/typescript/faq.md
+++ b/docs/guide/typescript/faq.md
@@ -269,3 +269,33 @@ class MyWidget extends Widget.Box {
     }
 }
 ```
+
+## How do I register keybindings?
+
+If you want global keybindings use your compositor.
+Only **focused** windows can capture events. To make a window
+focusable set its keymode.
+
+::: code-group
+```tsx [gtk3]
+<window
+    keymode={Astal.Keymode.ON_DEMAND}
+    onKeyPressEvent={(self, event: Gdk.Event) => {
+        if (event.get_keyval()[1] === Gdk.KEY_Escape) {
+            self.hide()
+        }
+    }}
+/>
+```
+
+```tsx [gtk4]
+<window
+    keymode={Astal.Keymode.ON_DEMAND}
+    onKeyPressed={(self, keyval) => {
+        if (keyval === Gdk.KEY_Escape) {
+            self.hide()
+        }
+    }}
+/>
+```
+:::
-- 
cgit v1.2.3