feat: add setAccentColor on Windows

codebytere · codebytere · commit 41e722ca85d2 · 2025-07-14T12:56:47.000+02:00
diff --git a/docs/api/base-window.md b/docs/api/base-window.md
@@ -1260,6 +1260,19 @@ Sets the properties for the window's taskbar button.
 > `relaunchCommand` and `relaunchDisplayName` must always be set
 > together. If one of those properties is not set, then neither will be used.
 
+#### `win.setAccentColor(accentColor)` _Windows_
+
+* `accentColor` boolean | string - The accent color for the window. By default, follows user preference in System Settings. Set to `false` to explicitly disable, or set the color in Hex, RGB, RGBA, HSL, HSLA or named CSS color format. Alpha values will be ignored.
+
+Sets the system accent color and highlighting of active window border.
+
+#### `win.getAccentColor()` _Windows_
+
+Returns `string | null` - the system accent color and highlighting of active window border in RGB format.
+
+If a color has been set for the window that differs from the system accent color, the window accent color will
+be returned. Otherwise, the system accent color will be returned, if one is enabled.
+
 #### `win.setIcon(icon)` _Windows_ _Linux_
 
 * `icon` [NativeImage](native-image.md) | string
diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md
@@ -1440,6 +1440,19 @@ Sets the properties for the window's taskbar button.
 > `relaunchCommand` and `relaunchDisplayName` must always be set
 > together. If one of those properties is not set, then neither will be used.
 
+#### `win.setAccentColor(accentColor)` _Windows_
+
+* `accentColor` boolean | string - The accent color for the window. By default, follows user preference in System Settings. Set to `false` to explicitly disable, or set the color in Hex, RGB, RGBA, HSL, HSLA or named CSS color format. Alpha values will be ignored.
+
+Sets the system accent color and highlighting of active window border.
+
+#### `win.getAccentColor()` _Windows_
+
+Returns `string | null` - the system accent color and highlighting of active window border in RGB format.
+
+If a color has been set for the window that differs from the system accent color, the window accent color will
+be returned. Otherwise, the system accent color will be returned, if one is enabled.
+
 #### `win.showDefinitionForSelection()` _macOS_
 
 Same as `webContents.showDefinitionForSelection()`.
diff --git a/shell/browser/api/electron_api_base_window.cc b/shell/browser/api/electron_api_base_window.cc
@@ -1089,6 +1089,32 @@ void BaseWindow::SetAppDetails(const gin_helper::Dictionary& options) {
 bool BaseWindow::IsSnapped() const {
   return window_->IsSnapped();
 }
+
+void BaseWindow::SetAccentColor(gin_helper::Arguments* args) {
+  bool accent_color = false;
+  std::string accent_color_string;
+  if (args->GetNext(&accent_color_string)) {
+    window_->SetAccentColor(accent_color_string);
+  } else if (args->GetNext(&accent_color)) {
+    window_->SetAccentColor(accent_color);
+  } else {
+    args->ThrowError(
+        "Invalid accent color value - must be a string or boolean");
+  }
+}
+
+v8::Local<v8::Value> BaseWindow::GetAccentColor() const {
+  v8::Isolate* isolate = v8::Isolate::GetCurrent();
+  auto accent_color = window_->GetAccentColor();
+
+  if (std::holds_alternative<bool>(accent_color)) {
+    return v8::Boolean::New(isolate, std::get<bool>(accent_color));
+  } else if (std::holds_alternative<std::string>(accent_color)) {
+    return gin::StringToV8(isolate, std::get<std::string>(accent_color));
+  }
+
+  return v8::Null(isolate);
+}
 #endif
 
 #if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_LINUX)
@@ -1277,6 +1303,8 @@ void BaseWindow::BuildPrototype(v8::Isolate* isolate,
 #if BUILDFLAG(IS_WIN)
       .SetMethod("isSnapped", &BaseWindow::IsSnapped)
       .SetProperty("snapped", &BaseWindow::IsSnapped)
+      .SetMethod("setAccentColor", &BaseWindow::SetAccentColor)
+      .SetMethod("getAccentColor", &BaseWindow::GetAccentColor)
       .SetMethod("hookWindowMessage", &BaseWindow::HookWindowMessage)
       .SetMethod("isWindowMessageHooked", &BaseWindow::IsWindowMessageHooked)
       .SetMethod("unhookWindowMessage", &BaseWindow::UnhookWindowMessage)
diff --git a/shell/browser/api/electron_api_base_window.h b/shell/browser/api/electron_api_base_window.h
@@ -255,6 +255,8 @@ class BaseWindow : public gin_helper::TrackableObject<BaseWindow>,
   bool SetThumbnailToolTip(const std::string& tooltip);
   void SetAppDetails(const gin_helper::Dictionary& options);
   bool IsSnapped() const;
+  void SetAccentColor(gin_helper::Arguments* args);
+  v8::Local<v8::Value> GetAccentColor() const;
 #endif
 
 #if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_LINUX)
diff --git a/shell/browser/api/electron_api_system_preferences.h b/shell/browser/api/electron_api_system_preferences.h
@@ -56,7 +56,7 @@ class SystemPreferences final
   const char* GetTypeName() override;
 
 #if BUILDFLAG(IS_WIN) || BUILDFLAG(IS_MAC)
-  std::string GetAccentColor();
+  static std::string GetAccentColor();
   std::string GetColor(gin_helper::ErrorThrower thrower,
                        const std::string& color);
   std::string GetMediaAccessStatus(gin_helper::ErrorThrower thrower,
diff --git a/shell/browser/native_window.h b/shell/browser/native_window.h
@@ -343,6 +343,8 @@ class NativeWindow : public base::SupportsUserData,
 
 #if BUILDFLAG(IS_WIN)
   void NotifyWindowMessage(UINT message, WPARAM w_param, LPARAM l_param);
+  virtual void SetAccentColor(std::variant<bool, std::string> accent_color) = 0;
+  virtual std::variant<bool, std::string> GetAccentColor() const = 0;
 #endif
 
   void AddObserver(NativeWindowObserver* obs) { observers_.AddObserver(obs); }
diff --git a/shell/browser/native_window_views.cc b/shell/browser/native_window_views.cc
@@ -26,6 +26,7 @@
 #include "base/strings/utf_string_conversions.h"
 #include "content/public/browser/desktop_media_id.h"
 #include "content/public/common/color_parser.h"
+#include "shell/browser/api/electron_api_system_preferences.h"
 #include "shell/browser/api/electron_api_web_contents.h"
 #include "shell/browser/ui/inspectable_web_contents_view.h"
 #include "shell/browser/ui/views/root_view.h"
@@ -1705,6 +1706,34 @@ void NativeWindowViews::SetIcon(const gfx::ImageSkia& icon) {
 #endif
 
 #if BUILDFLAG(IS_WIN)
+void NativeWindowViews::SetAccentColor(
+    std::variant<bool, std::string> accent_color) {
+  if (std::holds_alternative<std::string>(accent_color)) {
+    std::optional<SkColor> maybe_color =
+        ParseCSSColor(std::get<std::string>(accent_color));
+    if (maybe_color.has_value())
+      accent_color_ = maybe_color.value();
+  } else if (std::holds_alternative<bool>(accent_color)) {
+    accent_color_ = std::get<bool>(accent_color);
+  }
+
+  UpdateWindowAccentColor();
+}
+
+std::variant<bool, std::string> NativeWindowViews::GetAccentColor() const {
+  if (std::holds_alternative<SkColor>(accent_color_)) {
+    return ToRGBAHex(std::get<SkColor>(accent_color_));
+  } else if (std::holds_alternative<bool>(accent_color_)) {
+    return std::get<bool>(accent_color_);
+  }
+
+  std::string accent_color = electron::api::SystemPreferences::GetAccentColor();
+  if (accent_color.empty())
+    return false;
+  else
+    return accent_color;
+}
+
 void NativeWindowViews::UpdateThickFrame() {
   if (!thick_frame_)
     return;
diff --git a/shell/browser/native_window_views.h b/shell/browser/native_window_views.h
@@ -176,6 +176,8 @@ class NativeWindowViews : public NativeWindow,
 #endif
 
 #if BUILDFLAG(IS_WIN)
+  void SetAccentColor(std::variant<bool, std::string> accent_color) override;
+  std::variant<bool, std::string> GetAccentColor() const override;
   TaskbarHost& taskbar_host() { return taskbar_host_; }
   void UpdateThickFrame();
 #endif
diff --git a/shell/browser/native_window_views_win.cc b/shell/browser/native_window_views_win.cc
@@ -46,7 +46,7 @@ void SetWindowBorderAndCaptionColor(HWND hwnd, COLORREF color) {
     LOG(WARNING) << "Failed to set border color";
 }
 
-std::optional<DWORD> GetAccentColor() {
+std::optional<DWORD> GetSystemAccentColor() {
   base::win::RegKey key;
   if (key.Open(HKEY_CURRENT_USER, L"SOFTWARE\\Microsoft\\Windows\\DWM",
                KEY_READ) != ERROR_SUCCESS) {
@@ -594,7 +594,7 @@ void NativeWindowViews::UpdateWindowAccentColor() {
 
   // Use system accent color as fallback if no explicit color was set.
   if (!border_color.has_value() && should_apply_accent) {
-    std::optional<DWORD> system_accent_color = GetAccentColor();
+    std::optional<DWORD> system_accent_color = GetSystemAccentColor();
     if (system_accent_color.has_value()) {
       border_color = RGB(GetRValue(system_accent_color.value()),
                          GetGValue(system_accent_color.value()),
diff --git a/spec/api-browser-window-spec.ts b/spec/api-browser-window-spec.ts
@@ -2555,6 +2555,94 @@ describe('BrowserWindow module', () => {
     });
   });
 
+  ifdescribe(process.platform === 'win32')('BrowserWindow.setAccentColor', () => {
+    it('throws if called with an invalid parameter', () => {
+      const w = new BrowserWindow({ show: false });
+      expect(() => {
+        // @ts-ignore this is wrong on purpose.
+        w.setAccentColor([1, 2, 3]);
+      }).to.throw('Invalid accent color value - must be a string or boolean');
+    });
+  });
+
+  ifdescribe(process.platform === 'win32')('BrowserWindow.getAccentColor', () => {
+    afterEach(closeAllWindows);
+
+    it('returns the accent color after setting it to a string', () => {
+      const w = new BrowserWindow({ show: false });
+      const testColor = '#FF0000';
+      w.setAccentColor(testColor);
+      const accentColor = w.getAccentColor();
+      expect(accentColor).to.be.a('string');
+      expect(accentColor).to.equal(testColor);
+    });
+
+    it('returns the accent color after setting it to false', () => {
+      const w = new BrowserWindow({ show: false });
+      w.setAccentColor(false);
+      const accentColor = w.getAccentColor();
+      expect(accentColor).to.be.a('boolean');
+      expect(accentColor).to.equal(false);
+    });
+
+    it('returns a system color when set to true', () => {
+      const w = new BrowserWindow({ show: false });
+      w.setAccentColor(true);
+      const accentColor = w.getAccentColor();
+      expect(accentColor).to.be.a('string');
+      expect(accentColor).to.match(/^#[0-9A-F]{8}$/i);
+    });
+
+    it('returns the correct accent color after multiple changes', () => {
+      const w = new BrowserWindow({ show: false });
+
+      const testColor1 = '#00FF00';
+      w.setAccentColor(testColor1);
+      expect(w.getAccentColor()).to.equal(testColor1);
+
+      w.setAccentColor(false);
+      expect(w.getAccentColor()).to.equal(false);
+
+      const testColor2 = '#0000FF';
+      w.setAccentColor(testColor2);
+      expect(w.getAccentColor()).to.equal(testColor2);
+
+      w.setAccentColor(true);
+      const systemColor = w.getAccentColor();
+      expect(systemColor).to.be.a('string');
+      expect(systemColor).to.match(/^#[0-9A-F]{8}$/i);
+    });
+
+    it('handles CSS color names correctly', () => {
+      const w = new BrowserWindow({ show: false });
+      const testColor = 'red';
+      w.setAccentColor(testColor);
+      const accentColor = w.getAccentColor();
+      expect(accentColor).to.be.a('string');
+      expect(accentColor).to.equal('#FF0000');
+    });
+
+    it('handles RGB color values correctly', () => {
+      const w = new BrowserWindow({ show: false });
+      const testColor = 'rgb(255, 128, 0)';
+      w.setAccentColor(testColor);
+      const accentColor = w.getAccentColor();
+      expect(accentColor).to.be.a('string');
+      expect(accentColor).to.equal('#FF8000');
+    });
+
+    it('persists accent color across window operations', () => {
+      const w = new BrowserWindow({ show: false });
+      const testColor = '#ABCDEF';
+      w.setAccentColor(testColor);
+
+      w.show();
+      w.hide();
+
+      expect(w.getAccentColor()).to.equal(testColor);
+    });
+  });
+
   describe('BrowserWindow.setAlwaysOnTop(flag, level)', () => {
     let w: BrowserWindow;
 
