feat: expose theme APIs, closes #3903 (#3937)

lucasfernog · web-flow · commit 4cebcf6da7ca · 2022-04-21T15:03:29.000-03:00
diff --git a/.changes/api-theme-getter.md b/.changes/api-theme-getter.md
@@ -0,0 +1,5 @@
+---
+"api": patch
+---
+
+Added `theme` getter to `WebviewWindow`.
diff --git a/.changes/api-theme-window-option.md b/.changes/api-theme-window-option.md
@@ -0,0 +1,5 @@
+---
+"api": patch
+---
+
+Added `theme` field to `WindowOptions`.
diff --git a/.changes/tauri-event-api.md b/.changes/tauri-event-api.md
@@ -0,0 +1,5 @@
+---
+"api": patch
+---
+
+Added the `tauri://theme-changed` event.
diff --git a/.changes/theme-event.md b/.changes/theme-event.md
@@ -0,0 +1,7 @@
+---
+"tauri": patch
+"tauri-runtime": patch
+"tauri-runtime-wry": patch
+---
+
+Added `WindowEvent::ThemeChanged(theme)`.
diff --git a/.changes/theme-getter.md b/.changes/theme-getter.md
@@ -0,0 +1,7 @@
+---
+"tauri": patch
+"tauri-runtime": patch
+"tauri-runtime-wry": patch
+---
+
+Added `theme` getter on `Window`.
diff --git a/.changes/window-builder-theme.md b/.changes/window-builder-theme.md
@@ -0,0 +1,7 @@
+---
+"tauri": patch
+"tauri-runtime": patch
+"tauri-runtime-wry": patch
+---
+
+Added `theme` setter to the WindowBuilder.
diff --git a/core/tauri-runtime-wry/src/lib.rs b/core/tauri-runtime-wry/src/lib.rs
@@ -40,7 +40,7 @@ use wry::application::platform::windows::{WindowBuilderExtWindows, WindowExtWind
 #[cfg(feature = "system-tray")]
 use wry::application::system_tray::{SystemTray as WrySystemTray, SystemTrayBuilder};
 
-use tauri_utils::config::WindowConfig;
+use tauri_utils::{config::WindowConfig, Theme};
 use uuid::Uuid;
 use wry::{
   application::{
@@ -62,7 +62,10 @@ use wry::{
       MenuType,
     },
     monitor::MonitorHandle,
-    window::{Fullscreen, Icon as WryWindowIcon, UserAttentionType as WryUserAttentionType},
+    window::{
+      Fullscreen, Icon as WryWindowIcon, Theme as WryTheme,
+      UserAttentionType as WryUserAttentionType,
+    },
   },
   http::{
     Request as WryHttpRequest, RequestParts as WryRequestParts, Response as WryHttpResponse,
@@ -607,6 +610,14 @@ impl WindowEventWrapper {
   }
 }
 
+fn map_theme(theme: &WryTheme) -> Theme {
+  match theme {
+    WryTheme::Light => Theme::Light,
+    WryTheme::Dark => Theme::Dark,
+    _ => Theme::Light,
+  }
+}
+
 impl<'a> From<&WryWindowEvent<'a>> for WindowEventWrapper {
   fn from(event: &WryWindowEvent<'a>) -> Self {
     let event = match event {
@@ -624,6 +635,7 @@ impl<'a> From<&WryWindowEvent<'a>> for WindowEventWrapper {
       },
       #[cfg(any(target_os = "linux", target_os = "macos"))]
       WryWindowEvent::Focused(focused) => WindowEvent::Focused(*focused),
+      WryWindowEvent::ThemeChanged(theme) => WindowEvent::ThemeChanged(map_theme(theme)),
       _ => return Self(None),
     };
     Self(Some(event))
@@ -776,7 +788,8 @@ impl WindowBuilder for WindowBuilderWrapper {
       .decorations(config.decorations)
       .maximized(config.maximized)
       .always_on_top(config.always_on_top)
-      .skip_taskbar(config.skip_taskbar);
+      .skip_taskbar(config.skip_taskbar)
+      .theme(config.theme);
 
     #[cfg(any(not(target_os = "macos"), feature = "macos-private-api"))]
     {
@@ -936,6 +949,22 @@ impl WindowBuilder for WindowBuilderWrapper {
     self
   }
 
+  #[allow(unused_variables, unused_mut)]
+  fn theme(mut self, theme: Option<Theme>) -> Self {
+    #[cfg(windows)]
+    {
+      self.inner = self.inner.with_theme(if let Some(t) = theme {
+        match t {
+          Theme::Dark => Some(WryTheme::Dark),
+          _ => Some(WryTheme::Light),
+        }
+      } else {
+        None
+      });
+    }
+    self
+  }
+
   fn has_icon(&self) -> bool {
     self.inner.window.window_icon.is_some()
   }
@@ -1025,6 +1054,7 @@ pub enum WindowMessage {
     target_os = "openbsd"
   ))]
   GtkWindow(Sender<GtkWindow>),
+  Theme(Sender<Theme>),
   // Setters
   Center(Sender<Result<()>>),
   RequestUserAttention(Option<UserAttentionTypeWrapper>),
@@ -1275,6 +1305,10 @@ impl<T: UserEvent> Dispatch<T> for WryDispatcher<T> {
     window_getter!(self, WindowMessage::Hwnd).map(|w| w.0)
   }
 
+  fn theme(&self) -> Result<Theme> {
+    window_getter!(self, WindowMessage::Theme)
+  }
+
   /// Returns the `ApplicatonWindow` from gtk crate that is used by this window.
   #[cfg(any(
     target_os = "linux",
@@ -2090,6 +2124,12 @@ fn handle_user_message<T: UserEvent>(
             target_os = "openbsd"
           ))]
           WindowMessage::GtkWindow(tx) => tx.send(GtkWindow(window.gtk_window().clone())).unwrap(),
+          WindowMessage::Theme(tx) => {
+            #[cfg(windows)]
+            tx.send(map_theme(&window.theme())).unwrap();
+            #[cfg(not(windows))]
+            tx.send(Theme::Light).unwrap();
+          }
           // Setters
           WindowMessage::Center(tx) => {
             tx.send(center_window(window, window_handle.inner_size()))
diff --git a/core/tauri-runtime/src/lib.rs b/core/tauri-runtime/src/lib.rs
@@ -8,6 +8,7 @@
 
 use serde::Deserialize;
 use std::{fmt::Debug, path::PathBuf, sync::mpsc::Sender};
+use tauri_utils::Theme;
 use uuid::Uuid;
 
 #[cfg(windows)]
@@ -465,6 +466,9 @@ pub trait Dispatch<T: UserEvent>: Debug + Clone + Send + Sync + Sized + 'static
   #[cfg(windows)]
   fn hwnd(&self) -> Result<HWND>;
 
+  /// Returns the current window theme.
+  fn theme(&self) -> Result<Theme>;
+
   /// Returns the native handle that is used by this window.
   #[cfg(target_os = "macos")]
   fn ns_window(&self) -> Result<*mut std::ffi::c_void>;
diff --git a/core/tauri-runtime/src/webview.rs b/core/tauri-runtime/src/webview.rs
@@ -6,7 +6,10 @@
 
 use crate::{menu::Menu, window::DetachedWindow, WindowIcon};
 
-use tauri_utils::config::{WindowConfig, WindowUrl};
+use tauri_utils::{
+  config::{WindowConfig, WindowUrl},
+  Theme,
+};
 
 #[cfg(windows)]
 use windows::Win32::Foundation::HWND;
@@ -186,6 +189,9 @@ pub trait WindowBuilder: WindowBuilderBase {
   #[must_use]
   fn owner_window(self, owner: HWND) -> Self;
 
+  /// Forces a theme or uses the system settings if None was provided.
+  fn theme(self, theme: Option<Theme>) -> Self;
+
   /// Whether the icon was set or not.
   fn has_icon(&self) -> bool;
 
diff --git a/core/tauri-runtime/src/window.rs b/core/tauri-runtime/src/window.rs
@@ -11,7 +11,7 @@ use crate::{
   Dispatch, Runtime, UserEvent, WindowBuilder,
 };
 use serde::Serialize;
-use tauri_utils::config::WindowConfig;
+use tauri_utils::{config::WindowConfig, Theme};
 
 use std::{
   collections::{HashMap, HashSet},
@@ -59,6 +59,12 @@ pub enum WindowEvent {
   },
   /// An event associated with the file drop action.
   FileDrop(FileDropEvent),
+  /// The system window theme has changed.
+  ///
+  /// Applications might wish to react to this to change the theme of the content of the window when the system changes the window theme.
+  ///
+  /// At the moment this is only supported on Windows.
+  ThemeChanged(Theme),
 }
 
 /// The file drop event payload.
diff --git a/core/tauri-utils/src/config.rs b/core/tauri-utils/src/config.rs
@@ -572,6 +572,8 @@ pub struct WindowConfig {
   /// Whether or not the window icon should be added to the taskbar.
   #[serde(default)]
   pub skip_taskbar: bool,
+  /// The initial window theme. Defaults to the system theme. Only implemented on Windows.
+  pub theme: Option<crate::Theme>,
 }
 
 impl Default for WindowConfig {
@@ -599,6 +601,7 @@ impl Default for WindowConfig {
       decorations: default_decorations(),
       always_on_top: false,
       skip_taskbar: false,
+      theme: None,
     }
   }
 }
@@ -2302,6 +2305,17 @@ mod build {
     }
   }
 
+  impl ToTokens for crate::Theme {
+    fn to_tokens(&self, tokens: &mut TokenStream) {
+      let prefix = quote! { ::tauri::utils::Theme };
+
+      tokens.append_all(match self {
+        Self::Light => quote! { #prefix::Light },
+        Self::Dark => quote! { #prefix::Dark },
+      })
+    }
+  }
+
   impl ToTokens for WindowConfig {
     fn to_tokens(&self, tokens: &mut TokenStream) {
       let label = str_lit(&self.label);
@@ -2326,6 +2340,7 @@ mod build {
       let decorations = self.decorations;
       let always_on_top = self.always_on_top;
       let skip_taskbar = self.skip_taskbar;
+      let theme = opt_lit(self.theme.as_ref());
 
       literal_struct!(
         tokens,
@@ -2351,7 +2366,8 @@ mod build {
         visible,
         decorations,
         always_on_top,
-        skip_taskbar
+        skip_taskbar,
+        theme
       );
     }
   }
diff --git a/core/tauri-utils/src/lib.rs b/core/tauri-utils/src/lib.rs
@@ -5,6 +5,10 @@
 //! Tauri utility helpers
 #![warn(missing_docs, rust_2018_idioms)]
 
+use std::fmt::Display;
+
+use serde::{Deserialize, Deserializer, Serialize, Serializer};
+
 pub mod assets;
 pub mod config;
 pub mod html;
@@ -43,6 +47,52 @@ impl PackageInfo {
   }
 }
 
+/// System theme.
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
+#[non_exhaustive]
+pub enum Theme {
+  /// Light theme.
+  Light,
+  /// Dark theme.
+  Dark,
+}
+
+impl Serialize for Theme {
+  fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
+  where
+    S: Serializer,
+  {
+    serializer.serialize_str(self.to_string().as_ref())
+  }
+}
+
+impl<'de> Deserialize<'de> for Theme {
+  fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
+  where
+    D: Deserializer<'de>,
+  {
+    let s = String::deserialize(deserializer)?;
+    Ok(match s.to_lowercase().as_str() {
+      "dark" => Self::Dark,
+      _ => Self::Light,
+    })
+  }
+}
+
+impl Display for Theme {
+  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+    write!(
+      f,
+      "{}",
+      match self {
+        Self::Light => "light",
+        Self::Dark => "dark",
+      }
+    )
+  }
+}
+
 /// Information about environment variables.
 #[derive(Debug, Clone)]
 #[non_exhaustive]
diff --git a/core/tauri/scripts/bundle.js b/core/tauri/scripts/bundle.js
diff --git a/core/tauri/src/app.rs b/core/tauri/src/app.rs
@@ -24,7 +24,7 @@ use crate::{
   utils::config::Config,
   utils::{assets::Assets, Env},
   Context, EventLoopMessage, Invoke, InvokeError, InvokeResponse, Manager, Runtime, Scopes,
-  StateManager, Window,
+  StateManager, Theme, Window,
 };
 
 #[cfg(shell_scope)]
@@ -118,6 +118,15 @@ pub enum WindowEvent {
   },
   /// An event associated with the file drop action.
   FileDrop(FileDropEvent),
+  /// The system window theme has changed.
+  ///
+  /// Applications might wish to react to this to change the theme of the content of the window when the system changes the window theme.
+  ///
+  /// ## Platform-specific
+  ///
+  /// - **macOS / Linux**: Not supported.
+  /// - **Windows**: Only delivered if the window [`theme`](`crate::window::WindowBuilder#method.theme`) is `None`.
+  ThemeChanged(Theme),
 }
 
 impl From<RuntimeWindowEvent> for WindowEvent {
@@ -138,6 +147,7 @@ impl From<RuntimeWindowEvent> for WindowEvent {
         new_inner_size,
       },
       RuntimeWindowEvent::FileDrop(event) => Self::FileDrop(event),
+      RuntimeWindowEvent::ThemeChanged(theme) => Self::ThemeChanged(theme),
     }
   }
 }
diff --git a/core/tauri/src/endpoints/window.rs b/core/tauri/src/endpoints/window.rs
@@ -68,6 +68,7 @@ pub enum WindowManagerCmd {
   CurrentMonitor,
   PrimaryMonitor,
   AvailableMonitors,
+  Theme,
   // Setters
   Center,
   RequestUserAttention(Option<UserAttentionType>),
@@ -218,6 +219,7 @@ impl Cmd {
       WindowManagerCmd::CurrentMonitor => return Ok(window.current_monitor()?.into()),
       WindowManagerCmd::PrimaryMonitor => return Ok(window.primary_monitor()?.into()),
       WindowManagerCmd::AvailableMonitors => return Ok(window.available_monitors()?.into()),
+      WindowManagerCmd::Theme => return Ok(window.theme()?.into()),
       // Setters
       #[cfg(window_center)]
       WindowManagerCmd::Center => window.center()?,
diff --git a/core/tauri/src/lib.rs b/core/tauri/src/lib.rs
@@ -222,7 +222,7 @@ pub use {
   self::utils::{
     assets::Assets,
     config::{Config, WindowUrl},
-    Env, PackageInfo,
+    Env, PackageInfo, Theme,
   },
   self::window::{Monitor, Window, WindowBuilder},
   scope::*,
diff --git a/core/tauri/src/manager.rs b/core/tauri/src/manager.rs
diff --git a/core/tauri/src/test/mock_runtime.rs b/core/tauri/src/test/mock_runtime.rs
diff --git a/core/tauri/src/window.rs b/core/tauri/src/window.rs
diff --git a/tooling/api/src/helpers/event.ts b/tooling/api/src/helpers/event.ts
diff --git a/tooling/api/src/window.ts b/tooling/api/src/window.ts
diff --git a/tooling/cli/schema.json b/tooling/cli/schema.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"api": patch
 +---
++
 +Added `theme` getter to `WebviewWindow`.