From 194f6a0260f5eb292d29cd07e2a2639ca33fbf87 Mon Sep 17 00:00:00 2001
From: gabalafou <gabriel@fouasnon.com>
Date: Thu, 23 Nov 2023 13:55:39 +0200
Subject: [PATCH] Fix control + k keyboard shortcut (#1571)

* Fix control + k keyboard shortcut

* Update src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js
---
 .../assets/scripts/pydata-sphinx-theme.js     | 25 ++++++++-----------
 1 file changed, 10 insertions(+), 15 deletions(-)

diff --git a/src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js b/src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js
index 57c329c57..30765c995 100644
--- a/src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js
+++ b/src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js
@@ -241,7 +241,7 @@ var addEventListenerForSearchKeyboard = () => {
         !event.shiftKey &&
         !event.altKey &&
         // On Mac use ⌘, all other OS use Ctrl
-        (isMac
+        (useCommandKey
           ? event.metaKey && !event.ctrlKey
           : !event.metaKey && event.ctrlKey) &&
         // Case-insensitive so the shortcut still works with caps lock
@@ -260,20 +260,15 @@ var addEventListenerForSearchKeyboard = () => {
 };
 
 /**
- * Find out if we're on a Mac
+ * If the user is on a Mac, use command (⌘) instead of control (ctrl) key
+ *
+ * Note: `navigator.platform` is deprecated; however MDN still recommends using
+ * it for the one specific use case of detecting whether a keyboard shortcut
+ * should use control or command:
+ * https://developer.mozilla.org/en-US/docs/Web/API/Navigator/platform#examples
  */
-var isMac = (navigator) => {
-  var platform = "";
-  if (
-    typeof navigator.userAgentData !== "undefined" &&
-    navigator.userAgentData != null
-  ) {
-    platform = navigator.userAgentData.platform;
-  } else if (typeof navigator.platform !== "undefined") {
-    platform = navigator.platform;
-  }
-  return /mac.?os/.test(platform.toLowerCase());
-};
+var useCommandKey =
+  navigator.platform.indexOf("Mac") === 0 || navigator.platform === "iPhone";
 
 /**
  * Change the search hint to `meta key` if we are a Mac
@@ -281,7 +276,7 @@ var isMac = (navigator) => {
 
 var changeSearchShortcutKey = () => {
   let shortcuts = document.querySelectorAll(".search-button__kbd-shortcut");
-  if (isMac(window.navigator)) {
+  if (useCommandKey) {
     shortcuts.forEach(
       (f) => (f.querySelector("kbd.kbd-shortcut__modifier").innerText = "⌘")
     );