inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-04-28 11:36:44 +00:00
Code

Add loading indicator for custom panels (#9194)

Browse Source
This commit is contained in:
Oliver 2025-02-27 15:25:56 +11:00 committed by GitHub
parent 92edbf41ab
commit 28259a1ad6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 43 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/frontend/src/components/panels/PanelGroup.tsx
View File

@ -1,6 +1,8 @@
import { import {
ActionIcon, ActionIcon,
Divider, Divider,
Group,
Loader,
Paper, Paper,
Stack, Stack,
Tabs, Tabs,
@ -78,7 +80,7 @@ function BasePanelGroup({
const [expanded, setExpanded] = useState<boolean>(true); const [expanded, setExpanded] = useState<boolean>(true);
// Hook to load plugins for this panel // Hook to load plugins for this panel
const pluginPanels = usePluginPanels({ const pluginPanelSet = usePluginPanels({
model: model, model: model,
instance: instance, instance: instance,
id: id id: id
@ -89,7 +91,7 @@ function BasePanelGroup({
const _panels = [...panels]; const _panels = [...panels];
// Add plugin panels // Add plugin panels
pluginPanels?.forEach((panel) => { pluginPanelSet.panels?.forEach((panel) => {
let panelKey = panel.name; let panelKey = panel.name;
// Check if panel with this name already exists // Check if panel with this name already exists
@ -107,7 +109,7 @@ function BasePanelGroup({
}); });
return _panels; return _panels;
}, [panels, pluginPanels]); }, [panels, pluginPanelSet]);
const activePanels = useMemo( const activePanels = useMemo(
() => allPanels.filter((panel) => !panel.hidden && !panel.disabled), () => allPanels.filter((panel) => !panel.hidden && !panel.disabled),
@ -188,6 +190,7 @@ function BasePanelGroup({
) )
)} )}
{collapsible && ( {collapsible && (
<Group wrap='nowrap' gap='xs'>
<ActionIcon <ActionIcon
style={{ style={{
paddingLeft: '10px' paddingLeft: '10px'
@ -202,6 +205,8 @@ function BasePanelGroup({
<IconLayoutSidebarRightCollapse opacity={0.5} /> <IconLayoutSidebarRightCollapse opacity={0.5} />
)} )}
</ActionIcon> </ActionIcon>
{pluginPanelSet.isLoading && <Loader size='xs' />}
</Group>
)} )}
</Tabs.List> </Tabs.List>
{allPanels.map( {allPanels.map(

27
src/frontend/src/hooks/UsePluginPanels.tsx
View File

@ -1,4 +1,4 @@
import { useQuery } from '@tanstack/react-query'; import { type UseQueryResult, useQuery } from '@tanstack/react-query';
import { useMemo } from 'react'; import { useMemo } from 'react';
import { api } from '../App'; import { api } from '../App';
@ -35,6 +35,13 @@ export type PluginPanelContext = InvenTreeContext & {
*/ */
export type PluginPanelType = PanelType & { export type PluginPanelType = PanelType & {
pluginName: string; pluginName: string;
isLoading: boolean;
};
export type PluginPanelSet = {
panels: PluginPanelType[];
query: UseQueryResult;
isLoading: boolean;
}; };
export function usePluginPanels({ export function usePluginPanels({
@ -45,7 +52,7 @@ export function usePluginPanels({
instance?: any; instance?: any;
model?: ModelType | string; model?: ModelType | string;
id?: string | number | null; id?: string | number | null;
}): PluginPanelType[] { }): PluginPanelSet {
const globalSettings = useGlobalSettingsState(); const globalSettings = useGlobalSettingsState();
const pluginPanelsEnabled: boolean = useMemo( const pluginPanelsEnabled: boolean = useMemo(
@ -54,7 +61,7 @@ export function usePluginPanels({
); );
// API query to fetch initial information on available plugin panels // API query to fetch initial information on available plugin panels
const { data: pluginData } = useQuery({ const pluginQuery = useQuery({
enabled: pluginPanelsEnabled && !!model && id !== undefined, enabled: pluginPanelsEnabled && !!model && id !== undefined,
queryKey: ['custom-plugin-panels', model, id], queryKey: ['custom-plugin-panels', model, id],
queryFn: async () => { queryFn: async () => {
@ -95,7 +102,7 @@ export function usePluginPanels({
const pluginPanels: PluginPanelType[] = useMemo(() => { const pluginPanels: PluginPanelType[] = useMemo(() => {
return ( return (
pluginData?.map((props: PluginUIFeature) => { pluginQuery?.data?.map((props: PluginUIFeature) => {
const iconName: string = props?.icon || 'ti:plug:outline'; const iconName: string = props?.icon || 'ti:plug:outline';
const pluginContext: any = { const pluginContext: any = {
@ -117,7 +124,15 @@ export function usePluginPanels({
}; };
}) ?? [] }) ?? []
); );
}, [pluginData, contextData]); }, [pluginQuery.data, contextData]);
return pluginPanels; const panelSet: PluginPanelSet = useMemo(() => {
return {
panels: pluginPanels,
isLoading: pluginQuery.isLoading || pluginQuery.isFetching,
query: pluginQuery
};
}, [pluginPanels, pluginQuery]);
return panelSet;
} }