From 0f04c31ffb4d4415a97babcecebe4ea7bce4e1a3 Mon Sep 17 00:00:00 2001
From: Oliver <oliver.henry.walters@gmail.com>
Date: Fri, 15 Aug 2025 20:41:03 +1000
Subject: [PATCH] [UI] Search shortcut (#10181)

* Add search shortcut

- Use '/' to open search drawer

* Add user setting for spotlight

* Hide spotlight if disabled

* Updated playwright tests
---
 docs/docs/settings/user.md                    |  1 +
 src/backend/InvenTree/common/setting/user.py  |  6 +++++
 src/frontend/src/components/nav/Header.tsx    | 24 +++++++++++++++--
 src/frontend/src/components/nav/Layout.tsx    | 26 +++++++++++--------
 .../src/pages/Index/Settings/UserSettings.tsx |  1 +
 src/frontend/tests/pui_general.spec.ts        |  9 +++++--
 6 files changed, 52 insertions(+), 15 deletions(-)

diff --git a/docs/docs/settings/user.md b/docs/docs/settings/user.md
index 5028508ead..39871b25d3 100644
--- a/docs/docs/settings/user.md
+++ b/docs/docs/settings/user.md
@@ -21,6 +21,7 @@ The *Display Settings* screen shows general display configuration options:
 {{ usersetting("ICONS_IN_NAVBAR") }}
 {{ usersetting("STICKY_HEADER") }}
 {{ usersetting("STICKY_TABLE_HEADER") }}
+{{ usersetting("SHOW_SPOTLIGHT") }}
 {{ usersetting("DATE_DISPLAY_FORMAT") }}
 {{ usersetting("FORMS_CLOSE_USING_ESCAPE") }}
 {{ usersetting("DISPLAY_STOCKTAKE_TAB") }}
diff --git a/src/backend/InvenTree/common/setting/user.py b/src/backend/InvenTree/common/setting/user.py
index 73cdf769fe..793f9bae1b 100644
--- a/src/backend/InvenTree/common/setting/user.py
+++ b/src/backend/InvenTree/common/setting/user.py
@@ -191,6 +191,12 @@ USER_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
         'default': False,
         'validator': bool,
     },
+    'SHOW_SPOTLIGHT': {
+        'name': _('Show Spotlight'),
+        'description': _('Enable spotlight navigation functionality'),
+        'default': True,
+        'validator': bool,
+    },
     'ICONS_IN_NAVBAR': {
         'name': _('Navigation Icons'),
         'description': _('Display icons in the navigation bar'),
diff --git a/src/frontend/src/components/nav/Header.tsx b/src/frontend/src/components/nav/Header.tsx
index 4b5a3ed9c6..edbee51df6 100644
--- a/src/frontend/src/components/nav/Header.tsx
+++ b/src/frontend/src/components/nav/Header.tsx
@@ -8,7 +8,11 @@ import {
   Tooltip,
   UnstyledButton
 } from '@mantine/core';
-import { useDisclosure, useDocumentVisibility } from '@mantine/hooks';
+import {
+  useDisclosure,
+  useDocumentVisibility,
+  useHotkeys
+} from '@mantine/hooks';
 import { IconBell, IconSearch } from '@tabler/icons-react';
 import { useQuery } from '@tanstack/react-query';
 import { type ReactNode, useEffect, useMemo, useState } from 'react';
@@ -49,11 +53,27 @@ export function Header() {
   const [server] = useServerApiState(useShallow((state) => [state.server]));
   const [navDrawerOpened, { open: openNavDrawer, close: closeNavDrawer }] =
     useDisclosure(navigationOpen);
+
   const [
     searchDrawerOpened,
     { open: openSearchDrawer, close: closeSearchDrawer }
   ] = useDisclosure(false);
 
+  useHotkeys([
+    [
+      '/',
+      () => {
+        openSearchDrawer();
+      }
+    ],
+    [
+      'mod+/',
+      () => {
+        openSearchDrawer();
+      }
+    ]
+  ]);
+
   const [
     notificationDrawerOpened,
     { open: openNotificationDrawer, close: closeNotificationDrawer }
@@ -154,7 +174,7 @@ export function Header() {
                 <IconSearch />
               </ActionIcon>
             </Tooltip>
-            <SpotlightButton />
+            {userSettings.isSet('SHOW_SPOTLIGHT') && <SpotlightButton />}
             {globalSettings.isSet('BARCODE_ENABLE') && <ScanButton />}
             <Indicator
               radius='lg'
diff --git a/src/frontend/src/components/nav/Layout.tsx b/src/frontend/src/components/nav/Layout.tsx
index f34187ebbd..7ab9435bbf 100644
--- a/src/frontend/src/components/nav/Layout.tsx
+++ b/src/frontend/src/components/nav/Layout.tsx
@@ -7,6 +7,7 @@ import { Navigate, Outlet, useLocation, useNavigate } from 'react-router-dom';
 
 import { getActions } from '../../defaults/actions';
 import * as classes from '../../main.css';
+import { useUserSettingsState } from '../../states/SettingsStates';
 import { useUserState } from '../../states/UserState';
 import { Boundary } from '../Boundary';
 import { Footer } from './Footer';
@@ -37,6 +38,7 @@ export const [firstStore, firstSpotlight] = createSpotlight();
 export default function LayoutComponent() {
   const navigate = useNavigate();
   const location = useLocation();
+  const userSettings = useUserSettingsState();
 
   const defaultActions = getActions(navigate);
   const [actions, setActions] = useState(defaultActions);
@@ -68,17 +70,19 @@ export default function LayoutComponent() {
         </Container>
         <Space h='xl' />
         <Footer />
-        <Spotlight
-          actions={actions}
-          store={firstStore}
-          highlightQuery
-          searchProps={{
-            leftSection: <IconSearch size='1.2rem' />,
-            placeholder: t`Search...`
-          }}
-          shortcut={['mod + K', '/']}
-          nothingFound={t`Nothing found...`}
-        />
+        {userSettings.isSet('SHOW_SPOTLIGHT') && (
+          <Spotlight
+            actions={actions}
+            store={firstStore}
+            highlightQuery
+            searchProps={{
+              leftSection: <IconSearch size='1.2rem' />,
+              placeholder: t`Search...`
+            }}
+            shortcut={['mod + K']}
+            nothingFound={t`Nothing found...`}
+          />
+        )}
       </Flex>
     </ProtectedRoute>
   );
diff --git a/src/frontend/src/pages/Index/Settings/UserSettings.tsx b/src/frontend/src/pages/Index/Settings/UserSettings.tsx
index 48b29748a6..66ebb74b53 100644
--- a/src/frontend/src/pages/Index/Settings/UserSettings.tsx
+++ b/src/frontend/src/pages/Index/Settings/UserSettings.tsx
@@ -58,6 +58,7 @@ export default function UserSettings() {
               'ICONS_IN_NAVBAR',
               'STICKY_HEADER',
               'STICKY_TABLE_HEADER',
+              'SHOW_SPOTLIGHT',
               'DATE_DISPLAY_FORMAT',
               'FORMS_CLOSE_USING_ESCAPE',
               'DISPLAY_STOCKTAKE_TAB',
diff --git a/src/frontend/tests/pui_general.spec.ts b/src/frontend/tests/pui_general.spec.ts
index fcd19708dc..4a8cbbcc0c 100644
--- a/src/frontend/tests/pui_general.spec.ts
+++ b/src/frontend/tests/pui_general.spec.ts
@@ -5,7 +5,7 @@ import { doCachedLogin } from './login.js';
 /**
  * Test for integration of django admin button
  */
-test('Admin Button', async ({ browser }) => {
+test('General - Admin Button', async ({ browser }) => {
   const page = await doCachedLogin(browser, {
     username: 'admin',
     password: 'inventree',
@@ -21,12 +21,17 @@ test('Admin Button', async ({ browser }) => {
 });
 
 // Tests for the global search functionality
-test('Search', async ({ browser }) => {
+test('General - Search', async ({ browser }) => {
   const page = await doCachedLogin(browser, {
     username: 'steven',
     password: 'wizardstaff'
   });
 
+  // Open the search drawer with a shortcut
+  await page.keyboard.press('Control+/');
+  await page.getByRole('textbox', { name: 'global-search-input' }).waitFor();
+  await page.keyboard.press('Escape');
+
   await globalSearch(page, 'another customer');
 
   // Check for expected results