Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PUI] Make breadcrumbs adjustable #8027

Merged
merged 22 commits into from
Feb 11, 2025
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
3d28f40
adjust breadcrumbs to include current item
matmair Aug 22, 2024
3913e74
Merge branch 'master' of https://github.com/inventree/InvenTree into …
matmair Aug 28, 2024
411f31d
Add last breacdrumb to various pages
matmair Aug 28, 2024
5e084b4
Add user settings for last breadcrumb
matmair Aug 28, 2024
327405f
add breacrumbs to company subpages
matmair Aug 28, 2024
481bd8b
use getDetailUrl instead
matmair Aug 28, 2024
914b391
Merge branch 'master' into pui-adjust-breadcrumbs
SchrodingersGat Aug 29, 2024
86c816c
Merge branch 'master' into pui-adjust-breadcrumbs
matmair Aug 29, 2024
16259c0
set default
matmair Aug 29, 2024
553e4a3
Merge branch 'pui-adjust-breadcrumbs' of https://github.com/matmair/I…
matmair Aug 29, 2024
ea788b5
Merge branch 'master' of https://github.com/inventree/InvenTree into …
matmair Sep 1, 2024
b70cceb
change description
matmair Sep 1, 2024
1b9ddf7
Merge branch 'master' into pui-adjust-breadcrumbs
matmair Sep 10, 2024
66d917c
Merge branch 'master' into pui-adjust-breadcrumbs
matmair Sep 16, 2024
1ba4d77
Merge branch 'master' of https://github.com/inventree/InvenTree into …
matmair Nov 10, 2024
4bddce5
Merge branch 'master' into pui-adjust-breadcrumbs
matmair Nov 11, 2024
8987fb4
Merge branch 'master' of https://github.com/inventree/InvenTree into …
matmair Jan 31, 2025
2aa8214
fix styles
matmair Jan 31, 2025
d5dbd54
Merge branch 'master' of https://github.com/inventree/InvenTree into …
matmair Jan 31, 2025
e52c883
fix merge
matmair Jan 31, 2025
81b492a
Merge branch 'master' of https://github.com/inventree/InvenTree into …
matmair Feb 5, 2025
f946fed
rename to camelCase
matmair Feb 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/backend/InvenTree/common/setting/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,12 @@ def label_printer_options():
'validator': [int, MinValueValidator(0)],
'default': 100,
},
'ENABLE_LAST_BREADCRUMB': {
'name': _('Show Last Breadcrumb'),
'description': _('Show the current page in breadcrumbs'),
'default': False,
'validator': bool,
},
'NOTIFICATION_ERROR_REPORT': {
'name': _('Receive error reports'),
'description': _('Receive notifications for system errors'),
Expand Down
19 changes: 16 additions & 3 deletions src/frontend/src/components/nav/PageDetail.tsx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import { Group, Paper, SimpleGrid, Stack, Text } from '@mantine/core';
import { useHotkeys } from '@mantine/hooks';
import { Fragment, type ReactNode, useMemo } from 'react';

import { Fragment, type ReactNode, useMemo } from 'react';
import { shortenString } from '../../functions/tables';
import { useUserSettingsState } from '../../states/SettingsState';
import { ApiImage } from '../images/ApiImage';
import { StylishText } from '../items/StylishText';
import { type Breadcrumb, BreadcrumbList } from './BreadcrumbList';
Expand All @@ -16,6 +17,7 @@ interface PageDetailInterface {
detail?: ReactNode;
badges?: ReactNode[];
breadcrumbs?: Breadcrumb[];
last_crumb?: Breadcrumb[];
breadcrumbAction?: () => void;
actions?: ReactNode[];
editAction?: () => void;
Expand All @@ -36,11 +38,13 @@ export function PageDetail({
badges,
imageUrl,
breadcrumbs,
last_crumb,
breadcrumbAction,
actions,
editAction,
editEnabled
}: Readonly<PageDetailInterface>) {
const userSettings = useUserSettingsState();
useHotkeys([
[
'mod+E',
Expand Down Expand Up @@ -84,14 +88,23 @@ export function PageDetail({
return cols;
}, [detail, badges]);

// breadcrumb caching
const computedBreadcrumbs = useMemo(() => {
SchrodingersGat marked this conversation as resolved.
Show resolved Hide resolved
if (userSettings.isSet('ENABLE_LAST_BREADCRUMB', false)) {
return [...(breadcrumbs ?? []), ...(last_crumb ?? [])];
} else {
return breadcrumbs;
}
}, [breadcrumbs, last_crumb, userSettings]);

return (
<>
<PageTitle title={pageTitleString} />
<Stack gap='xs'>
{breadcrumbs && breadcrumbs.length > 0 && (
{computedBreadcrumbs && computedBreadcrumbs.length > 0 && (
<BreadcrumbList
navCallback={breadcrumbAction}
breadcrumbs={breadcrumbs}
breadcrumbs={computedBreadcrumbs}
/>
)}
<Paper p='xs' radius='xs' shadow='xs'>
Expand Down
3 changes: 2 additions & 1 deletion src/frontend/src/pages/Index/Settings/UserSettings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ export default function UserSettings() {
'PART_SHOW_QUANTITY_IN_FORMS',
'DISPLAY_SCHEDULE_TAB',
'DISPLAY_STOCKTAKE_TAB',
'TABLE_STRING_MAX_LENGTH'
'TABLE_STRING_MAX_LENGTH',
'ENABLE_LAST_BREADCRUMB'
]}
/>
)
Expand Down
4 changes: 2 additions & 2 deletions src/frontend/src/pages/build/BuildDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -542,8 +542,8 @@ export default function BuildDetail() {
editAction={editBuild.open}
editEnabled={user.hasChangePermission(ModelType.part)}
imageUrl={build.part_detail?.image ?? build.part_detail?.thumbnail}
breadcrumbs={[
{ name: t`Manufacturing`, url: '/manufacturing' },
breadcrumbs={[{ name: t`Manufacturing`, url: '/manufacturing' }]}
last_crumb={[
matmair marked this conversation as resolved.
Show resolved Hide resolved
{
name: build.reference,
url: getDetailUrl(ModelType.build, build.pk)
Expand Down
7 changes: 7 additions & 0 deletions src/frontend/src/pages/company/CompanyDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ import { StockItemTable } from '../../tables/stock/StockItemTable';
export type CompanyDetailProps = {
title: string;
breadcrumbs: Breadcrumb[];
last_crumb_url: string;
};

/**
Expand Down Expand Up @@ -328,6 +329,12 @@ export default function CompanyDetail(props: Readonly<CompanyDetailProps>) {
actions={companyActions}
imageUrl={company.image}
breadcrumbs={props.breadcrumbs}
last_crumb={[
{
name: company.name,
url: `${props.last_crumb_url}/${company.pk}/`
}
]}
badges={badges}
editAction={editCompany.open}
editEnabled={user.hasChangePermission(ModelType.company)}
Expand Down
1 change: 1 addition & 0 deletions src/frontend/src/pages/company/CustomerDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export default function CustomerDetail() {
<CompanyDetail
title={t`Customer`}
breadcrumbs={[{ name: t`Sales`, url: '/sales/' }]}
last_crumb_url='/sales/customer'
/>
);
}
1 change: 1 addition & 0 deletions src/frontend/src/pages/company/ManufacturerDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export default function ManufacturerDetail() {
<CompanyDetail
title={t`Manufacturer`}
breadcrumbs={[{ name: t`Purchasing`, url: '/purchasing/' }]}
last_crumb_url='/purchasing/manufacturer'
/>
);
}
9 changes: 9 additions & 0 deletions src/frontend/src/pages/company/ManufacturerPartDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,15 @@ export default function ManufacturerPartDetail() {
title={t`ManufacturerPart`}
subtitle={`${manufacturerPart.MPN} - ${manufacturerPart.part_detail?.name}`}
breadcrumbs={breadcrumbs}
last_crumb={[
{
name: manufacturerPart.MPN,
url: getDetailUrl(
ModelType.manufacturerpart,
manufacturerPart.pk
)
}
]}
actions={manufacturerPartActions}
imageUrl={manufacturerPart?.part_detail?.thumbnail}
editAction={editManufacturerPart.open}
Expand Down
1 change: 1 addition & 0 deletions src/frontend/src/pages/company/SupplierDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export default function SupplierDetail() {
<CompanyDetail
title={t`Supplier`}
breadcrumbs={[{ name: t`Purchasing`, url: '/purchasing/' }]}
last_crumb_url='/purchasing/supplier'
/>
);
}
6 changes: 6 additions & 0 deletions src/frontend/src/pages/company/SupplierPartDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,12 @@ export default function SupplierPartDetail() {
title={t`Supplier Part`}
subtitle={`${supplierPart.SKU} - ${supplierPart?.part_detail?.name}`}
breadcrumbs={breadcrumbs}
last_crumb={[
{
name: supplierPart.SKU,
url: `/purchasing/supplier-part/${supplierPart.pk}/`
}
]}
badges={badges}
actions={supplierPartActions}
imageUrl={supplierPart?.part_detail?.thumbnail}
Expand Down
6 changes: 6 additions & 0 deletions src/frontend/src/pages/part/PartDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -1001,6 +1001,12 @@ export default function PartDetail() {
? breadcrumbs
: undefined
}
last_crumb={[
{
name: part.name,
url: `/part/${part.pk}/`
}
]}
breadcrumbAction={() => {
setTreeOpen(true);
}}
Expand Down
6 changes: 6 additions & 0 deletions src/frontend/src/pages/purchasing/PurchaseOrderDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,12 @@ export default function PurchaseOrderDetail() {
subtitle={order.description}
imageUrl={order.supplier_detail?.image}
breadcrumbs={[{ name: t`Purchasing`, url: '/purchasing/' }]}
last_crumb={[
{
name: order.reference,
url: `/purchasing/purchase-order/${order.pk}`
}
]}
actions={poActions}
badges={orderBadges}
editAction={editPurchaseOrder.open}
Expand Down
3 changes: 3 additions & 0 deletions src/frontend/src/pages/sales/ReturnOrderDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,9 @@ export default function ReturnOrderDetail() {
badges={orderBadges}
actions={orderActions}
breadcrumbs={[{ name: t`Sales`, url: '/sales/' }]}
last_crumb={[
{ name: order.reference, url: `/sales/return-order/${order.pk}` }
]}
editAction={editReturnOrder.open}
editEnabled={user.hasChangePermission(ModelType.returnorder)}
/>
Expand Down
3 changes: 3 additions & 0 deletions src/frontend/src/pages/sales/SalesOrderDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,9 @@ export default function SalesOrderDetail() {
badges={orderBadges}
actions={soActions}
breadcrumbs={[{ name: t`Sales`, url: '/sales/' }]}
last_crumb={[
{ name: order.reference, url: `/sales/sales-order/${order.pk}` }
]}
editAction={editSalesOrder.open}
editEnabled={user.hasChangePermission(ModelType.salesorder)}
/>
Expand Down
6 changes: 6 additions & 0 deletions src/frontend/src/pages/stock/LocationDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,12 @@ export default function Stock() {
editAction={editLocation.open}
editEnabled={user.hasChangePermission(ModelType.stocklocation)}
breadcrumbs={breadcrumbs}
last_crumb={[
{
name: location.name,
url: `/stock/location/${location.pk}/`
}
]}
breadcrumbAction={() => {
setTreeOpen(true);
}}
Expand Down
6 changes: 6 additions & 0 deletions src/frontend/src/pages/stock/StockDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -916,6 +916,12 @@ export default function StockDetail() {
breadcrumbs={
user.hasViewRole(UserRoles.stock_location) ? breadcrumbs : undefined
}
last_crumb={[
{
name: stockitem.name,
url: `/stock/item/${stockitem.pk}/`
}
]}
breadcrumbAction={() => {
setTreeOpen(true);
}}
Expand Down
Loading