Delegate tao key events to tauri

Author: stijnfrishert

.changes/expose-keyboard-inputs.md

@@ -0,0 +1,5 @@
+---
+tauri: 'minor:feat'
+---
+
+Expose window keyboard events from `tao`, as `WindowEvent::KeyboardInput`.

Cargo.lock

@@ -125,6 +125,7 @@ use std::{
 pub type WebviewId = u32;
 type IpcHandler = dyn Fn(Request<String>) + 'static;
 
+mod keyboard;
 #[cfg(any(
   windows,
   target_os = "linux",
@@ -532,6 +533,11 @@ impl<'a> From<&TaoWindowEvent<'a>> for WindowEventWrapper {
       },
       #[cfg(any(target_os = "linux", target_os = "macos"))]
       TaoWindowEvent::Focused(focused) => WindowEvent::Focused(*focused),
+      TaoWindowEvent::KeyboardInput { event, .. } => {
+        let event = keyboard::convert_key_event(event);
+
+        WindowEvent::KeyboardInput { event }
+      }
       TaoWindowEvent::ThemeChanged(theme) => WindowEvent::ThemeChanged(map_theme(theme)),
       _ => return Self(None),
     };

crates/tauri-runtime-wry/src/keyboard.rs

@@ -34,6 +34,7 @@ http = "1"
 raw-window-handle = "0.6"
 url = { version = "2" }
 dpi = { version = "0.1", features = ["serde"] }
+keyboard-types = "0.7.0"
 
 [target."cfg(windows)".dependencies.windows]
 version = "0.58"

crates/tauri-runtime-wry/src/lib.rs

@@ -0,0 +1,28 @@
+use serde::{Deserialize, Serialize};
+
+pub use keyboard_types::{Code, Key, KeyState, Location, Modifiers};
+
+/// Keyboard events are issued for all pressed and released keys.
+#[derive(Clone, Debug, Default, Eq, Hash, PartialEq, Serialize, Deserialize)]
+pub struct KeyboardEvent {
+  /// Whether the key is pressed or released.
+  pub state: KeyState,
+  /// Logical key value.
+  pub key: Key,
+  /// Physical key position.
+  pub code: Code,
+  /// Location for keys with multiple instances on common keyboards.
+  pub location: Location,
+  /// True if the key is currently auto-repeated.
+  pub repeat: bool,
+}
+
+impl KeyboardEvent {
+  pub fn is_down(&self) -> bool {
+    self.state == KeyState::Down
+  }
+
+  pub fn is_up(&self) -> bool {
+    self.state == KeyState::Up
+  }
+}

crates/tauri-runtime/Cargo.toml

@@ -21,6 +21,7 @@ use tauri_utils::Theme;
 use url::Url;
 use webview::{DetachedWebview, PendingWebview};
 
+pub mod keyboard;
 /// Types useful for interacting with a user's monitors.
 pub mod monitor;
 pub mod webview;

crates/tauri-runtime/src/keyboard.rs

@@ -5,6 +5,7 @@
 //! A layer between raw [`Runtime`] windows and Tauri.
 
 use crate::{
+  keyboard::KeyboardEvent,
   webview::{DetachedWebview, PendingWebview},
   Icon, Runtime, UserEvent, WindowDispatch,
 };
@@ -43,6 +44,10 @@ pub enum WindowEvent {
   ///
   /// The parameter is true if the window has gained focus, and false if it has lost focus.
   Focused(bool),
+
+  /// An event from the keyboard has been received.
+  KeyboardInput { event: KeyboardEvent },
+
   /// The window's scale factor has changed.
   ///
   /// The following user actions can cause DPI changes:

crates/tauri-runtime/src/lib.rs

@@ -8,6 +8,7 @@ use crate::{
     channel::ChannelDataIpcQueue, CallbackFn, CommandArg, CommandItem, Invoke, InvokeError,
     InvokeHandler, InvokeResponseBody,
   },
+  keyboard::KeyboardEvent,
   manager::{webview::UriSchemeProtocol, AppManager, Asset},
   plugin::{Plugin, PluginStore},
   resources::ResourceTable,
@@ -115,6 +116,8 @@ pub enum WindowEvent {
   ///
   /// The parameter is true if the window has gained focus, and false if it has lost focus.
   Focused(bool),
+  /// An event from the keyboard has been received.
+  KeyboardInput(KeyboardEvent),
   /// The window's scale factor has changed.
   ///
   /// The following user actions can cause DPI changes:
@@ -151,6 +154,7 @@ impl From<RuntimeWindowEvent> for WindowEvent {
       },
       RuntimeWindowEvent::Destroyed => Self::Destroyed,
       RuntimeWindowEvent::Focused(flag) => Self::Focused(flag),
+      RuntimeWindowEvent::KeyboardInput { event } => Self::KeyboardInput(event),
       RuntimeWindowEvent::ScaleFactorChanged {
         scale_factor,
         new_inner_size,

crates/tauri-runtime/src/window.rs

@@ -0,0 +1,5 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+pub use tauri_runtime::keyboard::{Code, Key, KeyState, KeyboardEvent, Location, Modifiers};

crates/tauri/src/app.rs

@@ -82,6 +82,7 @@ pub mod async_runtime;
 mod error;
 mod event;
 pub mod ipc;
+pub mod keyboard;
 mod manager;
 mod pattern;
 pub mod plugin;

crates/tauri/src/keyboard/mod.rs

@@ -28,6 +28,7 @@ const WINDOW_MOVED_EVENT: EventName<&str> = EventName::from_str("tauri://move");
 const WINDOW_CLOSE_REQUESTED_EVENT: EventName<&str> =
   EventName::from_str("tauri://close-requested");
 const WINDOW_DESTROYED_EVENT: EventName<&str> = EventName::from_str("tauri://destroyed");
+const WINDOW_KEYBOARD_INPUT_EVENT: EventName<&str> = EventName::from_str("tauri://keyboard-input");
 const WINDOW_FOCUS_EVENT: EventName<&str> = EventName::from_str("tauri://focus");
 const WINDOW_BLUR_EVENT: EventName<&str> = EventName::from_str("tauri://blur");
 const WINDOW_SCALE_FACTOR_CHANGED_EVENT: EventName<&str> =
@@ -180,6 +181,9 @@ fn on_window_event<R: Runtime>(window: &Window<R>, event: &WindowEvent) -> crate
       },
       &(),
     )?,
+    WindowEvent::KeyboardInput(event) => {
+      window.emit_to_window(WINDOW_KEYBOARD_INPUT_EVENT, event)?;
+    }
     WindowEvent::ScaleFactorChanged {
       scale_factor,
       new_inner_size,