From 58f4ef21cbeb6c83957d66b7ee2be3e9e30148c8 Mon Sep 17 00:00:00 2001
From: Matthias Mair <code@mjmair.com>
Date: Tue, 9 Apr 2024 21:03:14 +0200
Subject: [PATCH] [PUI] Quick commands pallet Fixes #5888

---
 .../components/buttons/SpotlightButton.tsx    | 15 +++++++
 .../src/components/items/MenuLinks.tsx        |  4 ++
 src/frontend/src/components/nav/Header.tsx    |  2 +
 src/frontend/src/components/nav/Layout.tsx    | 32 ++++++++++-----
 .../src/components/nav/NavHoverMenu.tsx       |  4 +-
 .../src/components/nav/NavigationDrawer.tsx   |  3 +-
 src/frontend/src/defaults/actions.tsx         | 40 +++++++++++++++++++
 src/frontend/src/defaults/menuItems.tsx       | 32 +++++++--------
 8 files changed, 105 insertions(+), 27 deletions(-)
 create mode 100644 src/frontend/src/components/buttons/SpotlightButton.tsx
 create mode 100644 src/frontend/src/defaults/actions.tsx

diff --git a/src/frontend/src/components/buttons/SpotlightButton.tsx b/src/frontend/src/components/buttons/SpotlightButton.tsx
new file mode 100644
index 0000000000..c524e0b947
--- /dev/null
+++ b/src/frontend/src/components/buttons/SpotlightButton.tsx
@@ -0,0 +1,15 @@
+import { t } from '@lingui/macro';
+import { ActionIcon } from '@mantine/core';
+import { spotlight } from '@mantine/spotlight';
+import { IconCommand } from '@tabler/icons-react';
+
+/**
+ * A button which opens the quick command modal
+ */
+export function SpotlightButton() {
+  return (
+    <ActionIcon onClick={() => spotlight.open()} title={t`Open spotlight`}>
+      <IconCommand />
+    </ActionIcon>
+  );
+}
diff --git a/src/frontend/src/components/items/MenuLinks.tsx b/src/frontend/src/components/items/MenuLinks.tsx
index c75cc565d5..e9e9b10772 100644
--- a/src/frontend/src/components/items/MenuLinks.tsx
+++ b/src/frontend/src/components/items/MenuLinks.tsx
@@ -16,6 +16,10 @@ export interface MenuLinkItem {
   docchildren?: React.ReactNode;
 }
 
+export type menuItemsCollection = {
+  [key: string]: MenuLinkItem;
+};
+
 function ConditionalDocTooltip({
   item,
   children
diff --git a/src/frontend/src/components/nav/Header.tsx b/src/frontend/src/components/nav/Header.tsx
index b4f139cfb8..a9505f209e 100644
--- a/src/frontend/src/components/nav/Header.tsx
+++ b/src/frontend/src/components/nav/Header.tsx
@@ -10,6 +10,7 @@ import { navTabs as mainNavTabs } from '../../defaults/links';
 import { ApiEndpoints } from '../../enums/ApiEndpoints';
 import { InvenTreeStyle } from '../../globalStyle';
 import { apiUrl } from '../../states/ApiState';
+import { SpotlightButton } from '../buttons/SpotlightButton';
 import { ScanButton } from '../items/ScanButton';
 import { MainMenu } from './MainMenu';
 import { NavHoverMenu } from './NavHoverMenu';
@@ -80,6 +81,7 @@ export function Header() {
             <ActionIcon onClick={openSearchDrawer}>
               <IconSearch />
             </ActionIcon>
+            <SpotlightButton />
             <ScanButton />
             <ActionIcon onClick={openNotificationDrawer}>
               <Indicator
diff --git a/src/frontend/src/components/nav/Layout.tsx b/src/frontend/src/components/nav/Layout.tsx
index ae4b88df00..94b21c140c 100644
--- a/src/frontend/src/components/nav/Layout.tsx
+++ b/src/frontend/src/components/nav/Layout.tsx
@@ -1,6 +1,10 @@
+import { t } from '@lingui/macro';
 import { Container, Flex, Space } from '@mantine/core';
-import { Navigate, Outlet, useLocation } from 'react-router-dom';
+import { SpotlightProvider } from '@mantine/spotlight';
+import { IconSearch } from '@tabler/icons-react';
+import { Navigate, Outlet, useLocation, useNavigate } from 'react-router-dom';
 
+import { getActions } from '../../defaults/actions';
 import { InvenTreeStyle } from '../../globalStyle';
 import { useSessionState } from '../../states/SessionState';
 import { Footer } from './Footer';
@@ -22,17 +26,27 @@ export const ProtectedRoute = ({ children }: { children: JSX.Element }) => {
 
 export default function LayoutComponent() {
   const { classes } = InvenTreeStyle();
+  const navigate = useNavigate();
+  const actions = getActions(navigate);
 
   return (
     <ProtectedRoute>
-      <Flex direction="column" mih="100vh">
-        <Header />
-        <Container className={classes.layoutContent} size="100%">
-          <Outlet />
-        </Container>
-        <Space h="xl" />
-        <Footer />
-      </Flex>
+      <SpotlightProvider
+        actions={actions}
+        searchIcon={<IconSearch size="1.2rem" />}
+        searchPlaceholder={t`Search...`}
+        shortcut={['mod + K', '/']}
+        nothingFoundMessage={t`Nothing found...`}
+      >
+        <Flex direction="column" mih="100vh">
+          <Header />
+          <Container className={classes.layoutContent} size="100%">
+            <Outlet />
+          </Container>
+          <Space h="xl" />
+          <Footer />
+        </Flex>
+      </SpotlightProvider>
     </ProtectedRoute>
   );
 }
diff --git a/src/frontend/src/components/nav/NavHoverMenu.tsx b/src/frontend/src/components/nav/NavHoverMenu.tsx
index a6026956ff..499f3c493e 100644
--- a/src/frontend/src/components/nav/NavHoverMenu.tsx
+++ b/src/frontend/src/components/nav/NavHoverMenu.tsx
@@ -20,6 +20,8 @@ import { useLocalState } from '../../states/LocalState';
 import { InvenTreeLogo } from '../items/InvenTreeLogo';
 import { MenuLinks } from '../items/MenuLinks';
 
+const onlyItems = Object.values(menuItems);
+
 export function NavHoverMenu({
   openDrawer: openDrawer
 }: {
@@ -85,7 +87,7 @@ export function NavHoverMenu({
           mx="-md"
           color={theme.colorScheme === 'dark' ? 'dark.5' : 'gray.1'}
         />
-        <MenuLinks links={menuItems} highlighted={true} />
+        <MenuLinks links={onlyItems} highlighted={true} />
         <div className={classes.headerDropdownFooter}>
           <Group position="apart">
             <div>
diff --git a/src/frontend/src/components/nav/NavigationDrawer.tsx b/src/frontend/src/components/nav/NavigationDrawer.tsx
index 7bb8c90fa1..c68eacf100 100644
--- a/src/frontend/src/components/nav/NavigationDrawer.tsx
+++ b/src/frontend/src/components/nav/NavigationDrawer.tsx
@@ -18,6 +18,7 @@ import { MenuLinkItem, MenuLinks } from '../items/MenuLinks';
 
 // TODO @matmair #1: implement plugin loading and menu item generation see #5269
 const plugins: MenuLinkItem[] = [];
+const onlyItems = Object.values(menuItems);
 
 export function NavigationDrawer({
   opened,
@@ -60,7 +61,7 @@ function DrawerContent() {
       <Container className={classes.layoutContent} p={0}>
         <ScrollArea h={scrollHeight} type="always" offsetScrollbars>
           <Title order={5}>{t`Pages`}</Title>
-          <MenuLinks links={menuItems} />
+          <MenuLinks links={onlyItems} />
           <Space h="md" />
           {plugins.length > 0 ? (
             <>
diff --git a/src/frontend/src/defaults/actions.tsx b/src/frontend/src/defaults/actions.tsx
new file mode 100644
index 0000000000..6c773b013c
--- /dev/null
+++ b/src/frontend/src/defaults/actions.tsx
@@ -0,0 +1,40 @@
+import { t } from '@lingui/macro';
+import type { SpotlightAction } from '@mantine/spotlight';
+import { IconFileText, IconHome, IconInfoCircle } from '@tabler/icons-react';
+import { NavigateFunction } from 'react-router-dom';
+
+import { menuItems } from './menuItems';
+
+export function getActions(navigate: NavigateFunction) {
+  /**
+   * Default actions for the spotlight
+   */
+  const actions: SpotlightAction[] = [
+    {
+      title: t`Home`,
+      description: `Go to the home page`,
+      onTrigger: (action) => navigate(menuItems.home.link),
+      icon: <IconHome size="1.2rem" />
+    },
+    {
+      title: t`Dashboard`,
+      description: t`Go to the InvenTree dashboard`,
+      onTrigger: () => navigate(menuItems.dashboard.link),
+      icon: <IconHome size="1.2rem" />
+    },
+    {
+      title: t`Documentation`,
+      description: t`Visit documentation to learn more about InvenTree`,
+      onTrigger: () => console.log('Documentation'),
+      icon: <IconFileText size="1.2rem" />
+    },
+    {
+      title: t`About InvenTree`,
+      description: t`About the InvenTree org`,
+      onTrigger: () => navigate(menuItems.about.link),
+      icon: <IconInfoCircle size="1.2rem" />
+    }
+  ];
+
+  return actions;
+}
diff --git a/src/frontend/src/defaults/menuItems.tsx b/src/frontend/src/defaults/menuItems.tsx
index abc57e13a9..e713553217 100644
--- a/src/frontend/src/defaults/menuItems.tsx
+++ b/src/frontend/src/defaults/menuItems.tsx
@@ -1,75 +1,75 @@
 import { Trans } from '@lingui/macro';
 
-import { MenuLinkItem } from '../components/items/MenuLinks';
+import { menuItemsCollection } from '../components/items/MenuLinks';
 import { IS_DEV_OR_DEMO } from '../main';
 
-export const menuItems: MenuLinkItem[] = [
-  {
+export const menuItems: menuItemsCollection = {
+  home: {
     id: 'home',
     text: <Trans>Home</Trans>,
     link: '/',
     highlight: true
   },
-  {
+  profile: {
     id: 'profile',
     text: <Trans>Account settings</Trans>,
     link: '/settings/user',
     doctext: <Trans>User attributes and design settings.</Trans>
   },
-  {
+  scan: {
     id: 'scan',
     text: <Trans>Scanning</Trans>,
     link: '/scan',
     doctext: <Trans>View for interactive scanning and multiple actions.</Trans>,
     highlight: true
   },
-  {
+  dashboard: {
     id: 'dashboard',
     text: <Trans>Dashboard</Trans>,
     link: '/dashboard'
   },
-  {
+  parts: {
     id: 'parts',
     text: <Trans>Parts</Trans>,
     link: '/part/'
   },
-  {
+  stock: {
     id: 'stock',
     text: <Trans>Stock</Trans>,
     link: '/stock'
   },
-  {
+  build: {
     id: 'build',
     text: <Trans>Build</Trans>,
     link: '/build/'
   },
-  {
+  purchasing: {
     id: 'purchasing',
     text: <Trans>Purchasing</Trans>,
     link: '/purchasing/'
   },
-  {
+  sales: {
     id: 'sales',
     text: <Trans>Sales</Trans>,
     link: '/sales/'
   },
-  {
+  'settings-system': {
     id: 'settings-system',
     text: <Trans>System Settings</Trans>,
     link: '/settings/system'
   },
-  {
+  'settings-admin': {
     id: 'settings-admin',
     text: <Trans>Admin Center</Trans>,
     link: '/settings/admin'
   }
-];
+};
 
 if (IS_DEV_OR_DEMO) {
-  menuItems.push({
+  menuItems['playground'] = {
     id: 'playground',
     text: <Trans>Playground</Trans>,
     link: '/playground',
     highlight: true
-  });
+  };
 }