feat(frontend): optional nav tree sidebyside (#12974)

* disable restriction (for now)

* add option for a permanent navigation tree

* revert unintended change

* adjust search text to be less confusing when pinned

docs/docs/settings/user.md

@@ -31,6 +31,7 @@ The *Display Settings* screen shows general display configuration options:
 {{ usersetting("SHOW_FULL_CATEGORY_IN_TABLES")}}
 {{ usersetting("SHOW_BOM_SUBASSEMBLY_LEVELS")}}
 {{ usersetting("ENABLE_LAST_BREADCRUMB") }}
+{{ usersetting("NAVIGATION_TREE_PINNED") }}
 {{ usersetting("SHOW_EXTRA_MODEL_INFO") }}
 {{ usersetting("SHOW_FULL_LOCATION_IN_TABLES") }}
 {{ usersetting("DISPLAY_ITEMS_FINAL_LEVEL") }}

src/backend/InvenTree/common/setting/user.py

@@ -255,6 +255,12 @@ USER_SETTINGS: dict[str, InvenTreeSettingsKeyType] = {
         'default': False,
         'validator': bool,
     },
+    'NAVIGATION_TREE_PINNED': {
+        'name': _('Pin Navigation Tree'),
+        'description': _('Display navigation tree permanently'),
+        'default': False,
+        'validator': bool,
+    },
     'SHOW_EXTRA_MODEL_INFO': {
         'name': _('Show Extra Model Information'),
         'description': _('Display extra information in model selection dropdowns'),

src/frontend/src/components/nav/NavigationTree.tsx

@@ -8,30 +8,41 @@ import {
   HoverCard,
   Loader,
   LoadingOverlay,
+  Paper,
   type RenderTreeNodePayload,
   Space,
+  Splitter,
   Stack,
   Text,
   TextInput,
+  Tooltip,
   Tree,
   type TreeNodeData,
   useTree
 } from '@mantine/core';
-import { useDebouncedValue } from '@mantine/hooks';
+import { useDebouncedValue, useMediaQuery } from '@mantine/hooks';
 import {
   IconChevronDown,
   IconChevronRight,
   IconExclamationCircle,
+  IconPin,
+  IconPinnedOff,
   IconSearch,
   IconSitemap,
   IconX
 } from '@tabler/icons-react';
 import { useQuery } from '@tanstack/react-query';
-import { useCallback, useEffect, useMemo, useState } from 'react';
+import {
+  type ReactNode,
+  useCallback,
+  useEffect,
+  useMemo,
+  useState
+} from 'react';
 import { useNavigate } from 'react-router-dom';
 
 import { StylishText } from '@lib/components/StylishText';
-import type { ApiEndpoints } from '@lib/enums/ApiEndpoints';
+import { ApiEndpoints } from '@lib/enums/ApiEndpoints';
 import type { ModelType } from '@lib/enums/ModelType';
 import { apiUrl } from '@lib/functions/Api';
 import { resolveItem } from '@lib/functions/Conversion';
@@ -42,6 +53,7 @@ import {
 } from '@lib/functions/Navigation';
 import { t } from '@lingui/core/macro';
 import { useApi } from '../../contexts/ApiContext';
+import { useUserSettingsState } from '../../states/SettingsStates';
 import { ApiIcon } from '../items/ApiIcon';
 
 /*
@@ -54,7 +66,9 @@ export default function NavigationTree({
   selectedId,
   modelType,
   childIdentifier,
-  endpoint
+  endpoint,
+  hidden,
+  children
 }: Readonly<{
   title: string;
   opened: boolean;
@@ -63,11 +77,39 @@ export default function NavigationTree({
   modelType: ModelType;
   childIdentifier?: string;
   endpoint: ApiEndpoints;
+  hidden?: boolean;
+  children?: ReactNode;
 }>) {
   const api = useApi();
   const navigate = useNavigate();
   const treeState = useTree();
 
+  const userSettings = useUserSettingsState();
+  const canPin = useMediaQuery('(min-width: 350px)', true, {
+    getInitialValueInEffect: false
+  });
+  const pinned = canPin && userSettings.isSet('NAVIGATION_TREE_PINNED', false);
+  const visible = !hidden && (pinned || opened);
+
+  const setPinned = useCallback(
+    (value: boolean) => {
+      api
+        .patch(
+          apiUrl(ApiEndpoints.settings_user_list, 'NAVIGATION_TREE_PINNED'),
+          {
+            value: value
+          }
+        )
+        .then(() => {
+          if (value) onClose();
+        })
+        .finally(() => {
+          userSettings.fetchSettings();
+        });
+    },
+    [api, onClose, userSettings.fetchSettings]
+  );
+
   const [searchValue, setSearchValue] = useState('');
   const [debouncedSearch] = useDebouncedValue(searchValue, 300);
 
@@ -76,17 +118,17 @@ export default function NavigationTree({
   // PKs of nodes whose children are currently being fetched
   const [loadingNodes, setLoadingNodes] = useState<Set<number>>(new Set());
 
-  // Reset everything when the drawer opens or closes
+  // Reset everything when the tree is shown or hidden
   useEffect(() => {
     setSearchValue('');
     setAllNodes([]);
     setLoadingNodes(new Set());
-  }, [opened]);
+  }, [visible]);
 
   // Data query — browse mode loads root nodes only; search mode loads all matches + ancestors
   const query = useQuery({
-    enabled: opened,
-    queryKey: [modelType, 'tree', opened, debouncedSearch, selectedId],
+    enabled: visible,
+    queryKey: [modelType, 'tree', visible, debouncedSearch, selectedId],
     queryFn: async () =>
       api
         .get(apiUrl(endpoint), {
@@ -350,68 +392,122 @@ export default function NavigationTree({
     ]
   );
 
-  return (
-    <Drawer
-      opened={opened}
-      size='lg'
-      position='left'
-      onClose={onClose}
-      withCloseButton={true}
-      styles={{
-        header: {
-          width: '100%'
-        },
-        title: {
-          width: '100%'
+  const header = (
+    <Group justify='space-between' wrap='nowrap' w='100%'>
+      <Group justify='left' p='ms' gap='md' wrap='nowrap'>
+        <IconSitemap />
+        <StylishText size='lg'>{title}</StylishText>
+      </Group>
+      {canPin && (
+        <Tooltip label={pinned ? t`Unpin` : t`Pin`} position='bottom'>
+          <ActionIcon
+            variant='transparent'
+            aria-label={pinned ? 'nav-tree-unpin' : 'nav-tree-pin'}
+            onClick={() => setPinned(!pinned)}
+          >
+            {pinned ? <IconPinnedOff /> : <IconPin />}
+          </ActionIcon>
+        </Tooltip>
+      )}
+    </Group>
+  );
+
+  const content = (
+    <Stack gap='xs' pos='relative'>
+      <TextInput
+        aria-label='nav-tree-search'
+        placeholder={t`Filter ${{ title }}...`}
+        value={searchValue}
+        onChange={(event) => setSearchValue(event.currentTarget.value)}
+        leftSection={<IconSearch size={16} />}
+        rightSection={
+          searchValue ? (
+            <ActionIcon
+              size='sm'
+              variant='transparent'
+              onClick={() => setSearchValue('')}
+              aria-label={t`Clear search`}
+            >
+              <IconX size={14} />
+            </ActionIcon>
+          ) : null
         }
-      }}
-      title={
-        <Group justify='left' p='ms' gap='md' wrap='nowrap'>
-          <IconSitemap />
-          <StylishText size='lg'>{title}</StylishText>
-        </Group>
-      }
-    >
-      <Stack gap='xs'>
-        <TextInput
-          aria-label='nav-tree-search'
-          placeholder={t`Search...`}
-          value={searchValue}
-          onChange={(event) => setSearchValue(event.currentTarget.value)}
-          leftSection={<IconSearch size={16} />}
-          rightSection={
-            searchValue ? (
-              <ActionIcon
-                size='sm'
-                variant='transparent'
-                onClick={() => setSearchValue('')}
-                aria-label={t`Clear search`}
-              >
-                <IconX size={14} />
-              </ActionIcon>
-            ) : null
-          }
+      />
+      <Divider />
+      <LoadingOverlay visible={query.isFetching || query.isLoading} />
+      {query.isError ? (
+        <Alert color='red' title={t`Error`} icon={<IconExclamationCircle />}>
+          {t`Error loading navigation tree.`}
+        </Alert>
+      ) : !query.isFetching && !query.isLoading && data.length === 0 ? (
+        <Alert color='blue' icon={<IconSearch />}>
+          {t`No results found`}
+        </Alert>
+      ) : (
+        <Tree
+          data={data}
+          tree={treeState}
+          renderNode={renderNode}
+          withLines
+          levelOffset={25}
         />
-        <Divider />
-        <LoadingOverlay visible={query.isFetching || query.isLoading} />
-        {query.isError ? (
-          <Alert color='red' title={t`Error`} icon={<IconExclamationCircle />}>
-            {t`Error loading navigation tree.`}
-          </Alert>
-        ) : !query.isFetching && !query.isLoading && data.length === 0 ? (
-          <Alert color='blue' icon={<IconSearch />}>
-            {t`No results found`}
-          </Alert>
-        ) : (
-          <Tree
-            data={data}
-            tree={treeState}
-            renderNode={renderNode}
-            withLines
-            levelOffset={25}
-          />
-        )}
-      </Stack>
-    </Drawer>
+      )}
+    </Stack>
+  );
+
+  if (hidden) {
+    return <>{children}</>;
+  }
+
+  if (pinned) {
+    return (
+      <Splitter
+        onCollapseChange={(event) => {
+          console.log(event);
+          setPinned(!pinned);
+        }}
+      >
+        <Splitter.Pane defaultSize='350px' min={'200px'} collapsible>
+          <Paper
+            withBorder
+            p='xs'
+            aria-label='nav-tree-pinned'
+            style={{ flexShrink: 0 }}
+          >
+            <Stack gap='xs'>
+              {header}
+              {content}
+            </Stack>
+          </Paper>
+        </Splitter.Pane>
+        <Splitter.Pane defaultSize={50} min={20}>
+          {children}
+        </Splitter.Pane>
+      </Splitter>
+    );
+  }
+
+  return (
+    <>
+      <Drawer
+        opened={opened}
+        size='lg'
+        position='left'
+        onClose={onClose}
+        withCloseButton={true}
+        styles={{
+          header: {
+            width: '100%'
+          },
+          title: {
+            width: '100%'
+          }
+        }}
+        title={header}
+      >
+        {content}
+      </Drawer>
+      {children}
+    </>
   );
 }

src/frontend/src/pages/Index/Settings/UserSettings.tsx

@@ -63,6 +63,7 @@ export default function UserSettings() {
               'FORMS_CLOSE_USING_ESCAPE',
               'DISPLAY_STOCKTAKE_TAB',
               'ENABLE_LAST_BREADCRUMB',
+              'NAVIGATION_TREE_PINNED',
               'SHOW_EXTRA_MODEL_INFO',
               'SHOW_FULL_LOCATION_IN_TABLES',
               'SHOW_FULL_CATEGORY_IN_TABLES',

src/frontend/src/pages/part/CategoryDetail.tsx

@@ -318,30 +318,34 @@ export default function CategoryDetail() {
               setTreeOpen(false);
             }}
             selectedId={category?.pk}
-          />
-          <PageDetail
-            title={(category?.name ?? id) ? t`Part Category` : t`Parts`}
-            subtitle={category?.description}
-            icon={category?.icon && <ApiIcon name={category?.icon} />}
-            breadcrumbs={breadcrumbs}
-            breadcrumbAction={() => {
-              setTreeOpen(true);
-            }}
-            actions={categoryActions}
-            editAction={editCategory.open}
-            editEnabled={
-              !!category?.pk && user.hasChangePermission(ModelType.partcategory)
-            }
-          />
-          <PanelGroup
-            pageKey='partcategory'
-            panels={panels}
-            model={ModelType.partcategory}
-            instance={category}
-            reloadInstance={refreshInstance}
-            id={category.pk ?? null}
-            defaultPanel={defaultPanel}
-          />
+          >
+            <Stack gap='xs'>
+              <PageDetail
+                title={(category?.name ?? id) ? t`Part Category` : t`Parts`}
+                subtitle={category?.description}
+                icon={category?.icon && <ApiIcon name={category?.icon} />}
+                breadcrumbs={breadcrumbs}
+                breadcrumbAction={() => {
+                  setTreeOpen(true);
+                }}
+                actions={categoryActions}
+                editAction={editCategory.open}
+                editEnabled={
+                  !!category?.pk &&
+                  user.hasChangePermission(ModelType.partcategory)
+                }
+              />
+              <PanelGroup
+                pageKey='partcategory'
+                panels={panels}
+                model={ModelType.partcategory}
+                instance={category}
+                reloadInstance={refreshInstance}
+                id={category.pk ?? null}
+                defaultPanel={defaultPanel}
+              />
+            </Stack>
+          </NavigationTree>
         </Stack>
       </InstanceDetail>
     </>

src/frontend/src/pages/part/PartDetail.tsx

@@ -797,83 +797,87 @@ export default function PartDetail() {
       {stockAdjustActions.modals.map((modal) => modal.modal)}
       <InstanceDetail query={instanceQuery} requiredRole={UserRoles.part}>
         <Stack gap='xs'>
-          {user.hasViewRole(UserRoles.part_category) && (
-            <NavigationTree
-              title={t`Part Categories`}
-              childIdentifier='subcategories'
-              modelType={ModelType.partcategory}
-              endpoint={ApiEndpoints.category_tree}
-              opened={treeOpen}
-              onClose={() => {
-                setTreeOpen(false);
-              }}
-              selectedId={part?.category}
-            />
-          )}
-          <PageDetail
-            title={`${t`Part`}: ${part.full_name}`}
-            icon={
-              lockingEnabled ? (
-                <ActionIcon
-                  aria-label='part-lock-icon'
-                  variant='transparent'
-                  disabled={!user.hasChangeRole(UserRoles.part)}
-                  onClick={() => {
-                    const locking = !part.locked;
-                    api
-                      .patch(apiUrl(ApiEndpoints.part_list, part.pk), {
-                        locked: locking
-                      })
-                      .then(() => {
-                        notifications.hide('part-lock');
-                        notifications.show({
-                          id: 'part-lock',
-                          message: locking ? t`Part locked` : t`Part unlocked`,
-                          color: 'green',
-                          icon: locking ? (
-                            <IconLock size='1rem' />
-                          ) : (
-                            <IconLockOpen size='1rem' />
-                          )
-                        });
-                        refreshInstance();
-                      });
-                  }}
-                >
-                  {part?.locked ? <IconLock /> : <IconLockOpen />}
-                </ActionIcon>
-              ) : undefined
-            }
-            subtitle={part.description}
-            imageUrl={part.image}
-            thumbnailUrl={part.thumbnail}
-            badges={badges}
-            breadcrumbs={
-              user.hasViewRole(UserRoles.part_category)
-                ? breadcrumbs
-                : undefined
-            }
-            lastCrumb={[
-              {
-                name: part.name,
-                url: `/part/${part.pk}/`
-              }
-            ]}
-            breadcrumbAction={() => {
-              setTreeOpen(true);
+          <NavigationTree
+            hidden={!user.hasViewRole(UserRoles.part_category)}
+            title={t`Part Categories`}
+            childIdentifier='subcategories'
+            modelType={ModelType.partcategory}
+            endpoint={ApiEndpoints.category_tree}
+            opened={treeOpen}
+            onClose={() => {
+              setTreeOpen(false);
             }}
-            editAction={editPart.open}
-            editEnabled={user.hasChangeRole(UserRoles.part)}
-            actions={partActions}
-          />
-          <PanelGroup
-            pageKey='part'
-            panels={partPanels}
-            instance={part}
-            reloadInstance={refreshInstance}
-            model={ModelType.part}
-            id={part.pk}
-          />
+            selectedId={part?.category}
+          >
+            <Stack gap='xs'>
+              <PageDetail
+                title={`${t`Part`}: ${part.full_name}`}
+                icon={
+                  lockingEnabled ? (
+                    <ActionIcon
+                      aria-label='part-lock-icon'
+                      variant='transparent'
+                      disabled={!user.hasChangeRole(UserRoles.part)}
+                      onClick={() => {
+                        const locking = !part.locked;
+                        api
+                          .patch(apiUrl(ApiEndpoints.part_list, part.pk), {
+                            locked: locking
+                          })
+                          .then(() => {
+                            notifications.hide('part-lock');
+                            notifications.show({
+                              id: 'part-lock',
+                              message: locking
+                                ? t`Part locked`
+                                : t`Part unlocked`,
+                              color: 'green',
+                              icon: locking ? (
+                                <IconLock size='1rem' />
+                              ) : (
+                                <IconLockOpen size='1rem' />
+                              )
+                            });
+                            refreshInstance();
+                          });
+                      }}
+                    >
+                      {part?.locked ? <IconLock /> : <IconLockOpen />}
+                    </ActionIcon>
+                  ) : undefined
+                }
+                subtitle={part.description}
+                imageUrl={part.image}
+                thumbnailUrl={part.thumbnail}
+                badges={badges}
+                breadcrumbs={
+                  user.hasViewRole(UserRoles.part_category)
+                    ? breadcrumbs
+                    : undefined
+                }
+                lastCrumb={[
+                  {
+                    name: part.name,
+                    url: `/part/${part.pk}/`
+                  }
+                ]}
+                breadcrumbAction={() => {
+                  setTreeOpen(true);
+                }}
+                editAction={editPart.open}
+                editEnabled={user.hasChangeRole(UserRoles.part)}
+                actions={partActions}
+              />
+              <PanelGroup
+                pageKey='part'
+                panels={partPanels}
+                instance={part}
+                reloadInstance={refreshInstance}
+                model={ModelType.part}
+                id={part.pk}
+              />
+            </Stack>
+          </NavigationTree>
         </Stack>
       </InstanceDetail>
     </>

src/frontend/src/pages/stock/LocationDetail.tsx

@@ -438,38 +438,41 @@ export default function Stock() {
             opened={treeOpen}
             onClose={() => setTreeOpen(false)}
             selectedId={location?.pk}
-          />
-          <PageDetail
-            title={(location?.name ?? id) ? t`Stock Location` : t`Stock`}
-            subtitle={location?.description}
-            icon={location?.icon && <ApiIcon name={location?.icon} />}
-            actions={location?.pk ? locationActions : undefined}
-            editAction={editLocation.open}
-            editEnabled={
-              !!location?.pk &&
-              user.hasChangePermission(ModelType.stocklocation)
-            }
-            breadcrumbs={breadcrumbs}
-            lastCrumb={[
-              {
-                name: location.name,
-                url: `/stock/location/${location.pk}/`
-              }
-            ]}
-            breadcrumbAction={() => {
-              setTreeOpen(true);
-            }}
-          />
-          <PanelGroup
-            pageKey='stocklocation'
-            panels={locationPanels}
-            model={ModelType.stocklocation}
-            reloadInstance={refreshInstance}
-            id={location?.pk}
-            instance={location}
-            pluginPanelWithoutId
-            defaultPanel={defaultPanel}
-          />
+          >
+            <Stack>
+              <PageDetail
+                title={(location?.name ?? id) ? t`Stock Location` : t`Stock`}
+                subtitle={location?.description}
+                icon={location?.icon && <ApiIcon name={location?.icon} />}
+                actions={location?.pk ? locationActions : undefined}
+                editAction={editLocation.open}
+                editEnabled={
+                  !!location?.pk &&
+                  user.hasChangePermission(ModelType.stocklocation)
+                }
+                breadcrumbs={breadcrumbs}
+                lastCrumb={[
+                  {
+                    name: location.name,
+                    url: `/stock/location/${location.pk}/`
+                  }
+                ]}
+                breadcrumbAction={() => {
+                  setTreeOpen(true);
+                }}
+              />
+              <PanelGroup
+                pageKey='stocklocation'
+                panels={locationPanels}
+                model={ModelType.stocklocation}
+                reloadInstance={refreshInstance}
+                id={location?.pk}
+                instance={location}
+                pluginPanelWithoutId
+                defaultPanel={defaultPanel}
+              />
+            </Stack>
+          </NavigationTree>
         </Stack>
         {stockAdjustActions.modals.map((modal) => modal.modal)}
       </InstanceDetail>

src/frontend/src/pages/stock/StockDetail.tsx

@@ -728,47 +728,49 @@ export default function StockDetail() {
         requiredPermission={ModelType.stockitem}
       >
         <Stack>
-          {user.hasViewRole(UserRoles.stock_location) && (
-            <NavigationTree
-              title={t`Stock Locations`}
-              modelType={ModelType.stocklocation}
-              endpoint={ApiEndpoints.stock_location_tree}
-              childIdentifier='sublocations'
-              opened={treeOpen}
-              onClose={() => setTreeOpen(false)}
-              selectedId={stockitem?.location}
-            />
-          )}
-          <PageDetail
-            title={t`Stock Item`}
-            subtitle={stockitem.part_detail?.full_name}
-            imageUrl={stockitem.part_detail?.thumbnail}
-            editAction={editStockItem.open}
-            editEnabled={user.hasChangePermission(ModelType.stockitem)}
-            badges={stockBadges}
-            breadcrumbs={
-              user.hasViewRole(UserRoles.stock_location)
-                ? breadcrumbs
-                : undefined
-            }
-            lastCrumb={[
-              {
-                name: stockitem.name,
-                url: `/stock/item/${stockitem.pk}/`
-              }
-            ]}
-            breadcrumbAction={() => {
-              setTreeOpen(true);
-            }}
-            actions={stockActions}
-          />
-          <PanelGroup
-            pageKey='stockitem'
-            panels={stockPanels}
-            model={ModelType.stockitem}
-            id={stockitem.pk}
-            instance={stockitem}
-          />
+          <NavigationTree
+            hidden={!user.hasViewRole(UserRoles.stock_location)}
+            title={t`Stock Locations`}
+            modelType={ModelType.stocklocation}
+            endpoint={ApiEndpoints.stock_location_tree}
+            childIdentifier='sublocations'
+            opened={treeOpen}
+            onClose={() => setTreeOpen(false)}
+            selectedId={stockitem?.location}
+          >
+            <Stack>
+              <PageDetail
+                title={t`Stock Item`}
+                subtitle={stockitem.part_detail?.full_name}
+                imageUrl={stockitem.part_detail?.thumbnail}
+                editAction={editStockItem.open}
+                editEnabled={user.hasChangePermission(ModelType.stockitem)}
+                badges={stockBadges}
+                breadcrumbs={
+                  user.hasViewRole(UserRoles.stock_location)
+                    ? breadcrumbs
+                    : undefined
+                }
+                lastCrumb={[
+                  {
+                    name: stockitem.name,
+                    url: `/stock/item/${stockitem.pk}/`
+                  }
+                ]}
+                breadcrumbAction={() => {
+                  setTreeOpen(true);
+                }}
+                actions={stockActions}
+              />
+              <PanelGroup
+                pageKey='stockitem'
+                panels={stockPanels}
+                model={ModelType.stockitem}
+                id={stockitem.pk}
+                instance={stockitem}
+              />
+            </Stack>
+          </NavigationTree>
         </Stack>
       </InstanceDetail>
       {editStockItem.modal}