Skip to content

A modern and easy to use dashboard. 80+ integrations. 20K+ icons built in. Authentication out of the box. No YAML, drag and drop configuration.

perf(dashboard): retain loading gains without prepared pages (#7406)

Thomasf7ff10598434
diff --git a/apps/nextjs/public/images/mock/avatar.jpg b/apps/nextjs/public/images/mock/avatar.jpg
index c06c8c88c..b5120510d 100644
Binary files a/apps/nextjs/public/images/mock/avatar.jpg and b/apps/nextjs/public/images/mock/avatar.jpg differ
diff --git a/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx b/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx
index a33ec44cf..065e60525 100644
--- a/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx
+++ b/apps/nextjs/src/app/[locale]/_client-providers/trpc.tsx
@@ -26,7 +26,7 @@ import {
dashboardSupportingQueryPolicies,
isTrpcForbiddenError,
isWidgetDataQueryKey,
- queryCacheDefaultGcTimeMs,
+ getQueryCacheGcTime,
queryCacheDefaultRefetchIntervalMs,
queryCacheDefaultStaleTimeMs,
} from "@homarr/api/query-cache";
@@ -131,7 +131,7 @@ const ScopedTRPCReactProvider = ({ children, demoReadOnly }: PropsWithChildren<{
defaultOptions: {
queries: {
staleTime: queryCacheDefaultStaleTimeMs,
- gcTime: queryCacheDefaultGcTimeMs,
+ gcTime: getQueryCacheGcTime(),
retry: createQueryRetry(env.NODE_ENV === "development" ? 1 : 3),
},
mutations: {
diff --git a/apps/nextjs/src/app/[locale]/auth/loading.tsx b/apps/nextjs/src/app/[locale]/auth/loading.tsx
new file mode 100644
index 000000000..e40b66149
--- /dev/null
+++ b/apps/nextjs/src/app/[locale]/auth/loading.tsx
@@ -0,0 +1 @@
+export { CommonLoading as default } from "~/components/layout/loading";
diff --git a/apps/nextjs/src/app/[locale]/boards/(content)/_client.tsx b/apps/nextjs/src/app/[locale]/boards/(content)/_client.tsx
index 717516ffe..e3e79d479 100644
--- a/apps/nextjs/src/app/[locale]/boards/(content)/_client.tsx
+++ b/apps/nextjs/src/app/[locale]/boards/(content)/_client.tsx
@@ -1,7 +1,7 @@
"use client";
import type { PropsWithChildren } from "react";
-import { Box, Paper, Stack, Text } from "@mantine/core";
+import { Box, Paper, px, Stack, Text, useMantineTheme } from "@mantine/core";
import { IconBulb } from "@tabler/icons-react";
import { useCurrentLayout, useInitialViewportWidth, useLayoutOverride, useRequiredBoard } from "@homarr/boards/context";
@@ -33,8 +33,6 @@ import { BoardSelectionProvider } from "~/components/board/selection/board-selec
import { BoardSelectionToolbar } from "~/components/board/selection/board-selection-toolbar";
import classes from "./_client.module.css";
-const APP_SHELL_SIDE_PADDING = 32;
-
const BoardSelectionGridProvider = ({ children }: PropsWithChildren) => (
<GridEditorRegistryProvider>
<BoardSelectionProvider>{children}</BoardSelectionProvider>
@@ -50,6 +48,7 @@ export const ClientBoard = () => {
const currentLayoutId = useCurrentLayout();
const initialViewportWidth = useInitialViewportWidth();
const layoutOverrideId = useLayoutOverride();
+ const theme = useMantineTheme();
const currentLayout = board.layouts.find((layout) => layout.id === currentLayoutId) ?? board.layouts.at(0);
if (!currentLayout) throw new Error("Expected the board to contain a layout");
@@ -68,11 +67,16 @@ export const ClientBoard = () => {
laneWidths.reduce((total, width) => total + width, 0) + (laneWidths.length - 1) * LOGICAL_GRID_GAP;
const initialLogicalHeight = getInitialBoardLogicalHeight(board, currentLayoutId);
const representativeWidth = layoutOverrideId ? getRepresentativeLayoutWidth(currentLayout, board.layouts) : null;
+ const shellPadding = Number(px(theme.spacing.xs));
+ const belowSmallViewport = initialViewportWidth > 0 && initialViewportWidth < Number(px(theme.breakpoints.sm));
+ const isPreview = representativeWidth !== null;
+ const previewWidth = Math.max(1, Math.min(representativeWidth ?? 1, initialViewportWidth - Number(px("2rem"))));
let inlinePadding = 0;
- if (leftColumnCount === 0) inlinePadding += APP_SHELL_SIDE_PADDING;
- if (rightColumnCount === 0) inlinePadding += APP_SHELL_SIDE_PADDING;
- if (representativeWidth !== null) inlinePadding = APP_SHELL_SIDE_PADDING * 2;
- const initialAvailableWidth = Math.max(1, (representativeWidth ?? initialViewportWidth) - inlinePadding);
+ if (!isPreview && !belowSmallViewport) {
+ if (leftColumnCount === 0) inlinePadding += shellPadding;
+ if (rightColumnCount === 0) inlinePadding += shellPadding;
+ }
+ const initialAvailableWidth = Math.max(1, (isPreview ? previewWidth : initialViewportWidth) - inlinePadding);
const gridTemplateColumns = [
leftColumnCount > 0 ? `${getLogicalGridSize(leftColumnCount)}px` : null,
`${getLogicalGridSize(mainColumnCount)}px`,
diff --git a/apps/nextjs/src/app/[locale]/boards/(content)/_query-snapshot.ts b/apps/nextjs/src/app/[locale]/boards/(content)/_query-snapshot.ts
index b98dce482..d147fc6f6 100644
--- a/apps/nextjs/src/app/[locale]/boards/(content)/_query-snapshot.ts
+++ b/apps/nextjs/src/app/[locale]/boards/(content)/_query-snapshot.ts
@@ -21,7 +21,7 @@ const snapshotRestoreBudgetMs = 50;
const maxQueryBytes = 128 * 1024;
const maxBeszelStatsBytes = 256 * 1024;
const maxSnapshotBytes = 512 * 1024;
-const snapshotVersion = "board-widget-queries-v1";
+const snapshotVersion = "board-widget-queries-v2";
type Integrations = Awaited<ReturnType<typeof getIntegrationsWithPermissionsAsync>>;
type CachedQuery = PersistedClient["clientState"]["queries"][number];
@@ -86,6 +86,7 @@ const getShareableQueries = (
let totalBytes = 0;
return queries.filter((query) => {
if (query.meta?.rscWidgetPrefetch !== true || query.state.status !== "success") return false;
+ if (query.state.dataUpdatedAt < Date.now() - snapshotMaxAgeMs) return false;
const ids = getQueryIntegrationIds(query.queryKey, board);
if (!ids?.every((id) => boardIntegrationIds.has(id) && allowedIds.has(id))) return false;
const serialized = superjson.stringify({ key: query.queryKey, data: query.state.data });
@@ -159,10 +160,7 @@ export const createBoardQuerySnapshot = (board: Board, integrations: Integration
...snapshot,
clientState: {
mutations: [],
- queries: queries.map((query) => ({
- ...query,
- state: { ...query.state, dataUpdatedAt: Date.now(), fetchStatus: "idle" as const },
- })),
+ queries: queries.map((query) => ({ ...query, state: { ...query.state, fetchStatus: "idle" as const } })),
},
};
},
diff --git a/apps/nextjs/src/app/[locale]/boards/[name]/settings/loading.tsx b/apps/nextjs/src/app/[locale]/boards/[name]/settings/loading.tsx
new file mode 100644
index 000000000..e40b66149
--- /dev/null
+++ b/apps/nextjs/src/app/[locale]/boards/[name]/settings/loading.tsx
@@ -0,0 +1 @@
+export { CommonLoading as default } from "~/components/layout/loading";
diff --git a/apps/nextjs/src/app/[locale]/custom-widget-configuration/loading.tsx b/apps/nextjs/src/app/[locale]/custom-widget-configuration/loading.tsx
new file mode 100644
index 000000000..e40b66149
--- /dev/null
+++ b/apps/nextjs/src/app/[locale]/custom-widget-configuration/loading.tsx
@@ -0,0 +1 @@
+export { CommonLoading as default } from "~/components/layout/loading";
diff --git a/apps/nextjs/src/app/[locale]/init/loading.tsx b/apps/nextjs/src/app/[locale]/init/loading.tsx
new file mode 100644
index 000000000..e40b66149
--- /dev/null
+++ b/apps/nextjs/src/app/[locale]/init/loading.tsx
@@ -0,0 +1 @@
+export { CommonLoading as default } from "~/components/layout/loading";
diff --git a/apps/nextjs/src/app/[locale]/loading.tsx b/apps/nextjs/src/app/[locale]/loading.tsx
deleted file mode 100644
index 201f429d0..000000000
--- a/apps/nextjs/src/app/[locale]/loading.tsx
+++ /dev/null
@@ -1,9 +0,0 @@
-import { Center, Loader } from "@mantine/core";
-
-export default function CommonLoading() {
- return (
- <Center h="100vh">
- <Loader />
- </Center>
- );
-}
diff --git a/apps/nextjs/src/app/[locale]/manage/loading.tsx b/apps/nextjs/src/app/[locale]/manage/loading.tsx
new file mode 100644
index 000000000..e40b66149
--- /dev/null
+++ b/apps/nextjs/src/app/[locale]/manage/loading.tsx
@@ -0,0 +1 @@
+export { CommonLoading as default } from "~/components/layout/loading";
diff --git a/apps/nextjs/src/app/[locale]/reference/loading.tsx b/apps/nextjs/src/app/[locale]/reference/loading.tsx
new file mode 100644
index 000000000..e40b66149
--- /dev/null
+++ b/apps/nextjs/src/app/[locale]/reference/loading.tsx
@@ -0,0 +1 @@
+export { CommonLoading as default } from "~/components/layout/loading";
diff --git a/apps/nextjs/src/app/[locale]/widgets/loading.tsx b/apps/nextjs/src/app/[locale]/widgets/loading.tsx
new file mode 100644
index 000000000..e40b66149
--- /dev/null
+++ b/apps/nextjs/src/app/[locale]/widgets/loading.tsx
@@ -0,0 +1 @@
+export { CommonLoading as default } from "~/components/layout/loading";
diff --git a/apps/nextjs/src/components/assistant/assistant-launcher.tsx b/apps/nextjs/src/components/assistant/assistant-launcher.tsx
index b5c95d033..13697d6d9 100644
--- a/apps/nextjs/src/components/assistant/assistant-launcher.tsx
+++ b/apps/nextjs/src/components/assistant/assistant-launcher.tsx
@@ -1,13 +1,22 @@
"use client";
import type { PropsWithChildren, ReactNode } from "react";
-import { createContext, useCallback, useContext, useEffect, useId, useMemo, useRef, useState } from "react";
+import {
+ createContext,
+ startTransition,
+ useCallback,
+ useContext,
+ useEffect,
+ useId,
+ useMemo,
+ useRef,
+ useState,
+} from "react";
import dynamic from "next/dynamic";
import { useHotkeys } from "@mantine/hooks";
import { hotkeys } from "@homarr/definitions";
import { useRegisterSpotlightContextResults } from "@homarr/spotlight";
-import { closeSpotlight } from "@homarr/spotlight/store";
import { useI18n } from "@homarr/translation/client";
import type { WidgetComponentProps } from "@homarr/widgets";
import { AssistantWidgetRendererProvider } from "@homarr/widgets/assistant/context";
@@ -56,7 +65,13 @@ const DeferredAssistantSpotlight = ({ sendPrompt }: Pick<AssistantContextValue,
alwaysVisible: true,
placement: "fallback" as const,
interaction: (prompt: string) =>
- createAssistantPromptInteraction({ sendPrompt, prompt, onPromptAccepted: closeSpotlight }),
+ createAssistantPromptInteraction({
+ sendPrompt,
+ prompt,
+ onPromptAccepted: () => {
+ void import("@homarr/spotlight/store").then(({ closeSpotlight }) => closeSpotlight());
+ },
+ }),
}),
[sendPrompt, t],
);
@@ -73,7 +88,10 @@ export const AssistantLauncher = ({ children }: PropsWithChildren) => {
const runtimeRef = useRef<AssistantContextValue | null>(null);
const [widgets, setWidgets] = useState<Set<string>>(() => new Set());
const [renderWidget, setRenderWidget] = useState<AssistantWidgetRender | null>(null);
- const onWidgetRender = useCallback((render: AssistantWidgetRender) => setRenderWidget(() => render), []);
+ const onWidgetRender = useCallback(
+ (render: AssistantWidgetRender) => startTransition(() => setRenderWidget(() => render)),
+ [],
+ );
const onOpen = useCallback(() => setOpened(true), []);
const close = useCallback(() => setOpened(false), []);
const open = useCallback(() => {
@@ -106,22 +124,26 @@ export const AssistantLauncher = ({ children }: PropsWithChildren) => {
}, []);
const onStateChange = useCallback((value: AssistantContextValue) => {
runtimeRef.current = value;
- setRuntimeValue(value);
+ startTransition(() => setRuntimeValue(value));
}, []);
const register = useCallback((id: string) => {
- setActivated(true);
- setWidgets((current) => {
- if (current.has(id)) return current;
- return new Set([...current, id]);
+ startTransition(() => {
+ setActivated(true);
+ setWidgets((current) => {
+ if (current.has(id)) return current;
+ return new Set([...current, id]);
+ });
});
}, []);
const unregister = useCallback((id: string) => {
- setWidgets((current) => {
- if (!current.has(id)) return current;
- const next = new Set(current);
- next.delete(id);
- return next;
- });
+ startTransition(() =>
+ setWidgets((current) => {
+ if (!current.has(id)) return current;
+ const next = new Set(current);
+ next.delete(id);
+ return next;
+ }),
+ );
}, []);
const mounts = useMemo(() => ({ register, unregister, render: renderWidget }), [register, renderWidget, unregister]);
useHotkeys([[hotkeys.openAssistant, open, { preventDefault: true }]]);
diff --git a/apps/nextjs/src/components/assistant/assistant-provider.tsx b/apps/nextjs/src/components/assistant/assistant-provider.tsx
index 7eb51e3ac..604b8863f 100644
--- a/apps/nextjs/src/components/assistant/assistant-provider.tsx
+++ b/apps/nextjs/src/components/assistant/assistant-provider.tsx
@@ -24,6 +24,7 @@ import {
} from "@assistant-ui/react";
import { useChat } from "@ai-sdk/react";
import { AssistantChatTransport, useAISDKRuntime } from "@assistant-ui/react-ai-sdk";
+import { useCallbackRef } from "@mantine/hooks";
import { createAssistantStream } from "assistant-stream";
import { clientApi, fetchApi } from "@homarr/api/client";
@@ -928,9 +929,9 @@ const EnabledAssistantProvider = ({
useEffect(() => {
if (pendingPrompt === null || isLoading || preferences.isLoading) return;
- sendPrompt(pendingPrompt);
+ if (!sendPrompt(pendingPrompt)) open();
onPromptHandled();
- }, [isLoading, onPromptHandled, pendingPrompt, preferences.isLoading, sendPrompt]);
+ }, [isLoading, onPromptHandled, open, pendingPrompt, preferences.isLoading, sendPrompt]);
useEffect(() => {
if (assistantIsRunning) setActivityDismissed(false);
@@ -989,6 +990,8 @@ const EnabledAssistantProvider = ({
});
}, [conversationId, isLoading, refreshCurrentView, successfulMutationIds, t]);
+ // Spotlight can retain its previous item while a registration transition is pending.
+ const sendSpotlightPrompt = useCallbackRef(sendPrompt);
const spotlightItem = useMemo(() => {
const canSend =
!historyLoadFailed && !providerUnavailable && !assistantIsRunning && latestStatus?.type !== "requires-action";
@@ -1006,13 +1009,13 @@ const EnabledAssistantProvider = ({
placement: "fallback" as const,
interaction: (query: string) =>
createAssistantPromptInteraction({
- sendPrompt,
+ sendPrompt: sendSpotlightPrompt,
onPromptAccepted: closeSpotlight,
prompt: query,
canSend,
}),
};
- }, [assistantIsRunning, historyLoadFailed, latestStatus?.type, providerUnavailable, sendPrompt, t]);
+ }, [assistantIsRunning, historyLoadFailed, latestStatus?.type, providerUnavailable, sendSpotlightPrompt, t]);
useRegisterSpotlightContextResults("homarr-assistant", [spotlightItem], [spotlightItem]);
const activeWidgetId = visibleWidgetIds.values().next().value ?? null;
diff --git a/apps/nextjs/src/components/board/advanced-focus/context.tsx b/apps/nextjs/src/components/board/advanced-focus/context.tsx
index cc218e4c4..d202ae2d1 100644
--- a/apps/nextjs/src/components/board/advanced-focus/context.tsx
+++ b/apps/nextjs/src/components/board/advanced-focus/context.tsx
@@ -1,9 +1,9 @@
"use client";
import type { CSSProperties, PropsWithChildren } from "react";
-import { createContext, useCallback, useContext, useEffect, useMemo, useRef, useState } from "react";
+import { createContext, startTransition, useCallback, useContext, useEffect, useMemo, useRef, useState } from "react";
import { Overlay, Portal } from "@mantine/core";
-import { useIsomorphicEffect, useViewportSize } from "@mantine/hooks";
+import { useIsomorphicEffect, useWindowEvent } from "@mantine/hooks";
import { useEditMode } from "@homarr/boards/edit-mode";
@@ -42,6 +42,7 @@ const AdvancedFocusContext = createContext<AdvancedFocusContextValue | null>(nul
const HOVER_DELAY_MS = 500;
const POINTER_TRANSITION_GRACE_MS = 80;
const CLOSE_DURATION_MS = 180;
+const VIEWPORT_EVENT_OPTIONS = { passive: true };
const isEditableTarget = (target: EventTarget | null) =>
target instanceof HTMLElement &&
@@ -49,7 +50,7 @@ const isEditableTarget = (target: EventTarget | null) =>
export const BoardAdvancedFocusProvider = ({ children }: PropsWithChildren) => {
const [isEditMode] = useEditMode();
- const viewportSize = useViewportSize();
+ const viewportSize = useNonUrgentViewportSize();
const [active, setActive] = useState<ActiveFocus | null>(null);
const [isHoldPending, setIsHoldPending] = useState(false);
const activeRef = useRef<ActiveFocus | null>(null);
@@ -410,6 +411,21 @@ export const BoardAdvancedFocusProvider = ({ children }: PropsWithChildren) => {
);
};
+const useNonUrgentViewportSize = () => {
+ const [viewportSize, setViewportSize] = useState({ width: 0, height: 0 });
+ const setSize = useCallback(() => {
+ startTransition(() => {
+ setViewportSize({ width: window.innerWidth || 0, height: window.innerHeight || 0 });
+ });
+ }, []);
+
+ useWindowEvent("resize", setSize, VIEWPORT_EVENT_OPTIONS);
+ useWindowEvent("orientationchange", setSize, VIEWPORT_EVENT_OPTIONS);
+ useEffect(setSize, [setSize]);
+
+ return viewportSize;
+};
+
export const useAdvancedFocus = () => {
const context = useContext(AdvancedFocusContext);
if (!context) throw new Error("useAdvancedFocus must be used within BoardAdvancedFocusProvider");
diff --git a/apps/nextjs/src/components/board/items/item-content.tsx b/apps/nextjs/src/components/board/items/item-content.tsx
index a839a408f..b76cbc90a 100644
--- a/apps/nextjs/src/components/board/items/item-content.tsx
+++ b/apps/nextjs/src/components/board/items/item-content.tsx
@@ -3,7 +3,7 @@ import { memo, Suspense, use, useCallback, useEffect, useMemo, useRef, useState,
import { createPortal } from "react-dom";
import dynamic from "next/dynamic";
import { Box, Button, Center, Portal, Text } from "@mantine/core";
-import { useElementSize, useIsomorphicEffect } from "@mantine/hooks";
+import { useInViewport, useIsomorphicEffect } from "@mantine/hooks";
import { QueryErrorResetBoundary, useQueryClient } from "@tanstack/react-query";
import combineClasses from "clsx";
import { NoIntegrationSelectedError } from "@homarr/widgets/errors/classes";
@@ -15,6 +15,7 @@ import { useEditMode } from "@homarr/boards/edit-mode";
import { getWidgetName } from "@homarr/definitions";
import { useSettings } from "@homarr/settings";
import { useI18n } from "@homarr/translation/client";
+import { useDeferredElementSize } from "@homarr/ui/hooks";
import { WidgetError } from "@homarr/widgets/errors";
import {
createWidgetRuntimeState,
@@ -23,7 +24,7 @@ import {
} from "@homarr/widgets/definition";
import type { WidgetComponentProps, WidgetDefinition, WidgetRuntimeRef } from "@homarr/widgets/definition";
import { initialWidgetResources } from "@homarr/widgets/initial-widget-resources";
-import { loadWidgetResources, reduceWidgetOptionsWithDefinition } from "@homarr/widgets/manifest";
+import { loadWidgetModule, loadWidgetResources, reduceWidgetOptionsWithDefinition } from "@homarr/widgets/manifest";
import { WidgetCardShell, WidgetTitleBadge } from "@homarr/widgets/widget-card-shell";
import type { SectionItem } from "~/app/[locale]/boards/_types";
@@ -105,7 +106,7 @@ const getServerHydratedSnapshot = () => false;
export const BoardItemContent = ({ item }: BoardItemContentProps) => {
const hydrated = useSyncExternalStore(subscribeToHydration, getHydratedSnapshot, getServerHydratedSnapshot);
- const { ref, width: measuredWidth, height: measuredHeight } = useElementSize<HTMLDivElement>();
+ const { ref, width: measuredWidth, height: measuredHeight } = useDeferredElementSize<HTMLDivElement>();
const { getEntryRuntime } = useBoardGridPortalHost();
const { widgetStateRef, widgetRuntimeRef } = getEntryRuntime(item.id, createBoardItemRuntime);
const width = measuredWidth || getLogicalTrackSize(item.width);
@@ -173,6 +174,13 @@ const LoadedBoardItemContent = (props: LoadedBoardItemContentProps) => {
};
const DynamicBoardItemContent = (props: LoadedBoardItemContentProps) => {
+ const { definition } = use(loadWidgetModule(props.item.kind));
+ if (definition.deferUntilVisible)
+ return <ResolvedBoardItemContent {...props} definition={definition} Component={null} />;
+ return <LoadedDynamicBoardItemContent {...props} />;
+};
+
+const LoadedDynamicBoardItemContent = (props: LoadedBoardItemContentProps) => {
const resources = use(loadWidgetResources(props.item.kind));
return <ResolvedBoardItemContent {...props} {...resources} />;
};
@@ -188,7 +196,7 @@ const ResolvedBoardItemContent = ({
Component,
}: LoadedBoardItemContentProps & {
definition: WidgetDefinition;
- Component: ComponentType<WidgetComponentProps<SectionItem["kind"]>>;
+ Component: ComponentType<WidgetComponentProps<SectionItem["kind"]>> | null;
}) => {
const sourceRef = useRef<HTMLDivElement>(null);
const advancedFocusTriggerRef = useRef<HTMLButtonElement>(null);
@@ -465,7 +473,7 @@ interface InnerContentProps {
widgetRuntimeRef: WidgetRuntimeRef;
displayMode: "compact" | "advanced";
definition: WidgetDefinition;
- Component: ComponentType<WidgetComponentProps<SectionItem["kind"]>>;
+ Component: ComponentType<WidgetComponentProps<SectionItem["kind"]>> | null;
}
const InnerContent = memo(function InnerContent({ item, definition, Component, ...dimensions }: InnerContentProps) {
@@ -511,10 +519,12 @@ const InnerContent = memo(function InnerContent({ item, definition, Component, .
<div
className={itemContentClasses.editModeInertContent}
data-board-grid-inert-content={isEditMode ? "true" : undefined}
- data-homarr-widget-ready={item.kind}
+ data-homarr-widget-ready={Component ? item.kind : undefined}
inert={isEditMode}
>
- <Component
+ <WidgetRuntime
+ kind={item.kind}
+ Component={Component}
options={options as never}
integrationIds={item.integrationIds}
isEditMode={isEditMode}
@@ -538,6 +548,43 @@ const InnerContent = memo(function InnerContent({ item, definition, Component, .
);
});
+type WidgetRuntimeProps = WidgetComponentProps<SectionItem["kind"]> & {
+ kind: SectionItem["kind"];
+};
+
+const WidgetRuntime = ({ Component, ...props }: WidgetRuntimeProps & { Component: InnerContentProps["Component"] }) => {
+ if (Component) return <Component {...props} />;
+ return <VisibleWidgetRuntime {...props} />;
+};
+
+const VisibleWidgetRuntime = (props: WidgetRuntimeProps) => {
+ const { ref, inViewport } = useInViewport<HTMLDivElement>();
+ const [activated, setActivated] = useState(false);
+ useEffect(() => {
+ if (inViewport || props.displayMode === "advanced" || typeof IntersectionObserver === "undefined")
+ setActivated(true);
+ }, [inViewport, props.displayMode]);
+
+ return (
+ <div ref={ref} style={{ height: "100%", width: "100%" }}>
+ {activated && (
+ <Suspense fallback={null}>
+ <LoadedWidgetRuntime {...props} />
+ </Suspense>
+ )}
+ </div>
+ );
+};
+
+const LoadedWidgetRuntime = ({ kind, ...props }: WidgetRuntimeProps) => {
+ const { Component } = use(loadWidgetResources(kind));
+ return (
+ <div data-homarr-widget-ready={kind} style={{ height: "100%", width: "100%" }}>
+ <Component {...props} />
+ </div>
+ );
+};
+
const Throw = ({ when, error }: { when: boolean; error: Error }) => {
if (when) throw error;
return null;
diff --git a/apps/nextjs/src/components/board/items/widget-context-menu.tsx b/apps/nextjs/src/components/board/items/widget-context-menu.tsx
index 1479f74a0..870cae57d 100644
--- a/apps/nextjs/src/components/board/items/widget-context-menu.tsx
+++ b/apps/nextjs/src/components/board/items/widget-context-menu.tsx
@@ -1,8 +1,9 @@
"use client";
import type { MutableRefObject, ReactNode, RefObject } from "react";
-import { useCallback, useMemo, useState } from "react";
+import { useCallback, useEffect, useMemo, useState } from "react";
import { Drawer, Group, Loader, Menu, Text, Tooltip } from "@mantine/core";
+import { useFocusReturn } from "@mantine/hooks";
import { IconAlertTriangle, IconCircleCheck, IconMaximize, IconRefresh, IconSettings } from "@tabler/icons-react";
import type { QueryClient, QueryKey } from "@tanstack/react-query";
import { useIsFetching, useQueryClient } from "@tanstack/react-query";
@@ -345,12 +346,35 @@ interface WidgetContextMenuDropdownProps {
const WidgetContextMenuDropdown = ({ opened, onClose, title, children }: WidgetContextMenuDropdownProps) => {
const isMobile = useIsMobile();
- if (!isMobile) return <Menu.Dropdown>{children}</Menu.Dropdown>;
+ return (
+ <>
+ {(!isMobile || !opened) && <Menu.Dropdown>{children}</Menu.Dropdown>}
+ {isMobile && (
+ <WidgetContextMenuDrawer opened={opened} onClose={onClose} title={title}>
+ {children}
+ </WidgetContextMenuDrawer>
+ )}
+ </>
+ );
+};
+
+const WidgetContextMenuDrawer = ({ opened, onClose, title, children }: WidgetContextMenuDropdownProps) => {
+ const [mounted, setMounted] = useState(false);
+ const drawerOpened = opened && mounted;
+ useFocusReturn({ opened: drawerOpened });
+
+ useEffect(() => {
+ if (opened) setMounted(true);
+ }, [opened]);
+
+ if (!opened && !mounted) return null;
return (
<Drawer
- opened={opened}
+ opened={drawerOpened}
onClose={onClose}
+ onExitTransitionEnd={() => setMounted(false)}
+ returnFocus={false}
position="bottom"
size="min(80dvh, 40rem)"
title={title}
diff --git a/apps/nextjs/src/components/board/layout/scaled-board-canvas.tsx b/apps/nextjs/src/components/board/layout/scaled-board-canvas.tsx
index 02c8eacd8..51a646ee1 100644
--- a/apps/nextjs/src/components/board/layout/scaled-board-canvas.tsx
+++ b/apps/nextjs/src/components/board/layout/scaled-board-canvas.tsx
@@ -3,11 +3,11 @@
import type { PropsWithChildren } from "react";
import { createContext, useContext, useEffect, useMemo, useState } from "react";
import { Box } from "@mantine/core";
-import { useElementSize } from "@mantine/hooks";
import { calculateBoardUiScale } from "@homarr/boards/scale";
import classes from "./scaled-board-canvas.module.css";
+import { useDeferredElementSize } from "@homarr/ui/hooks";
export { calculateBoardUiScale } from "@homarr/boards/scale";
@@ -22,6 +22,109 @@ export const calculateBoardCanvasScale = (availableWidth: number, logicalWidth:
return availableWidth / logicalWidth;
};
+const setBoardCanvasStyle = (element: HTMLElement, property: string, value: number, suffix = "") => {
+ const current = Number.parseFloat(element.style.getPropertyValue(property));
+ if (Number.isFinite(current) && Math.abs(current - value) < Math.max(1, Math.abs(value)) * 0.00001) return;
+ element.style.setProperty(property, `${value}${suffix}`);
+};
+
+const installBoardCanvasFitting = (
+ calculateScale: typeof calculateBoardCanvasScale,
+ calculateUiScale: typeof calculateBoardUiScale,
+ setStyle: typeof setBoardCanvasStyle,
+) => {
+ const viewport = document.currentScript?.previousElementSibling;
+ if (!(viewport instanceof HTMLElement)) return;
+ const sizer = viewport.firstElementChild;
+ const canvas = sizer?.firstElementChild;
+ if (!(sizer instanceof HTMLElement) || !(canvas instanceof HTMLElement)) return;
+
+ const adjustedStyles = new WeakMap<HTMLElement, Map<string, { value: number; scale: number; applied: string }>>();
+ const adjustStyle = (
+ element: HTMLElement,
+ property: string,
+ renderedScale: number,
+ factor: (sourceScale: number) => number,
+ suffix = "",
+ ) => {
+ const current = element.style.getPropertyValue(property);
+ const value = Number.parseFloat(current);
+ if (!Number.isFinite(value)) return;
+ let styles = adjustedStyles.get(element);
+ if (!styles) {
+ styles = new Map();
+ adjustedStyles.set(element, styles);
+ }
+ let source = styles.get(property);
+ if (!source || source.applied !== current) {
+ source = { value, scale: renderedScale, applied: current };
+ styles.set(property, source);
+ }
+ setStyle(element, property, source.value * factor(source.scale), suffix);
+ source.applied = element.style.getPropertyValue(property);
+ };
+ const check = () => {
+ if (!viewport.isConnected) {
+ stop();
+ return;
+ }
+ const width = viewport.clientWidth;
+ const logicalWidth = Number(canvas.dataset.logicalWidth);
+ const renderedScale = Number(viewport.dataset.canvasScale);
+ if (!(width > 0 && logicalWidth > 0 && renderedScale > 0)) return;
+ const measuredWidth = Number(viewport.dataset.canvasMeasuredWidth);
+ if (
+ measuredWidth > 0 &&
+ Math.abs(measuredWidth - width) < 1 &&
+ Math.abs(renderedScale * logicalWidth - width) < 1 &&
+ Math.abs(Number(canvas.style.zoom) * logicalWidth - width) < 1
+ ) {
+ stop();
+ return;
+ }
+
+ const scale = calculateScale(width, logicalWidth);
+ const uiScale = calculateUiScale(scale);
+ setStyle(sizer, "width", logicalWidth * scale, "px");
+ setStyle(sizer, "height", Number(viewport.dataset.canvasInitialHeight) * scale, "px");
+ setStyle(canvas, "zoom", scale);
+ setStyle(canvas, "--board-canvas-inverse-scale", 1 / scale);
+ setStyle(canvas, "--board-canvas-ui-scale", uiScale);
+ for (const section of canvas.querySelectorAll<HTMLElement>("[data-grid-section-id]")) {
+ adjustStyle(section, "--board-canvas-inverse-scale", renderedScale, (source) => source / scale);
+ adjustStyle(section, "--board-canvas-ui-scale", renderedScale, (source) => uiScale / calculateUiScale(source));
+ }
+ for (const section of canvas.querySelectorAll<HTMLElement>("[data-section-id]")) {
+ adjustStyle(section, "--board-container-inset", renderedScale, (source) => source / scale, "px");
+ }
+ };
+ let frame = 0;
+ const scheduleCheck = () => {
+ if (frame !== 0) return;
+ frame = requestAnimationFrame(() => {
+ frame = 0;
+ check();
+ });
+ };
+ const mutations = new MutationObserver(scheduleCheck);
+ const measurements = new ResizeObserver(scheduleCheck);
+ const stop = () => {
+ cancelAnimationFrame(frame);
+ mutations.disconnect();
+ measurements.disconnect();
+ };
+ mutations.observe(viewport, {
+ attributes: true,
+ attributeFilter: ["data-canvas-scale", "data-canvas-measured-width", "data-logical-width"],
+ childList: true,
+ subtree: true,
+ });
+ measurements.observe(viewport);
+ check();
+};
+
+const fitBeforePaintScript = `(${installBoardCanvasFitting.toString()})(${calculateBoardCanvasScale.toString()},${calculateBoardUiScale.toString()},${setBoardCanvasStyle.toString()})`;
+
interface ScaledBoardCanvasProps {
logicalWidth: number;
initialLogicalHeight: number;
@@ -41,8 +144,8 @@ export const ScaledBoardCanvas = ({
label,
children,
}: PropsWithChildren<ScaledBoardCanvasProps>) => {
- const { ref: viewportRef, width: availableWidth } = useElementSize<HTMLDivElement>();
- const { ref: canvasRef, height: logicalHeight } = useElementSize<HTMLDivElement>();
+ const { ref: viewportRef, width: availableWidth } = useDeferredElementSize<HTMLDivElement>();
+ const { ref: canvasRef, height: logicalHeight } = useDeferredElementSize<HTMLDivElement>();
const [isHydrated, setIsHydrated] = useState(false);
useEffect(() => {
@@ -61,33 +164,43 @@ export const ScaledBoardCanvas = ({
const hasHorizontalOverflow = resolvedAvailableWidth > 0 && visualWidth - resolvedAvailableWidth > 0.5;
return (
- <Box
- component="section"
- ref={viewportRef}
- className={classes.viewport}
- data-testid="board-canvas"
- data-board-hydrated={isHydrated ? "true" : "false"}
- data-canvas-scale={scale}
- data-canvas-overflow={hasHorizontalOverflow ? "true" : "false"}
- data-canvas-initial-height={initialLogicalHeight}
- data-canvas-initial-width={initialAvailableWidth}
- aria-label={label}
- >
- <Box className={classes.sizer} style={{ width: visualWidth, height: resolvedLogicalHeight * scale }}>
+ <>
+ <Box
+ component="section"
+ ref={viewportRef}
+ className={classes.viewport}
+ data-testid="board-canvas"
+ data-board-hydrated={isHydrated ? "true" : "false"}
+ data-canvas-scale={scale}
+ data-canvas-measured-width={availableWidth}
+ data-canvas-overflow={hasHorizontalOverflow ? "true" : "false"}
+ data-canvas-initial-height={initialLogicalHeight}
+ data-canvas-initial-width={initialAvailableWidth}
+ aria-label={label}
+ >
<Box
- ref={canvasRef}
- data-board-canvas-content
- className={classes.canvas}
- style={{
- "--board-canvas-inverse-scale": inverseScale,
- "--board-canvas-ui-scale": uiScale,
- width: logicalWidth,
- zoom: scale,
- }}
+ className={classes.sizer}
+ style={{ width: visualWidth, height: resolvedLogicalHeight * scale }}
+ suppressHydrationWarning
>
- <BoardCanvasScaleContext.Provider value={scale}>{children}</BoardCanvasScaleContext.Provider>
+ <Box
+ ref={canvasRef}
+ data-board-canvas-content
+ data-logical-width={logicalWidth}
+ className={classes.canvas}
+ suppressHydrationWarning
+ style={{
+ "--board-canvas-inverse-scale": inverseScale,
+ "--board-canvas-ui-scale": uiScale,
+ width: logicalWidth,
+ zoom: scale,
+ }}
+ >
+ <BoardCanvasScaleContext.Provider value={scale}>{children}</BoardCanvasScaleContext.Provider>
+ </Box>
</Box>
</Box>
- </Box>
+ <script dangerouslySetInnerHTML={{ __html: fitBeforePaintScript }} />
+ </>
);
};
diff --git a/apps/nextjs/src/components/board/sections/grid/section-grid.tsx b/apps/nextjs/src/components/board/sections/grid/section-grid.tsx
index 8d5ad8bb9..0a7683c68 100644
--- a/apps/nextjs/src/components/board/sections/grid/section-grid.tsx
+++ b/apps/nextjs/src/components/board/sections/grid/section-grid.tsx
@@ -1,7 +1,16 @@
"use client";
import type { CSSProperties, KeyboardEvent, PointerEvent, RefObject } from "react";
-import { createContext, useContext, useEffect, useLayoutEffect, useMemo, useRef, useState } from "react";
+import {
+ createContext,
+ startTransition,
+ useContext,
+ useEffect,
+ useLayoutEffect,
+ useMemo,
+ useRef,
+ useState,
+} from "react";
import { Box } from "@mantine/core";
import combineClasses from "clsx";
@@ -344,6 +353,7 @@ export const SectionGrid = ({
} as CSSProperties
}
data-section-id={section.id}
+ suppressHydrationWarning
data-section-kind={section.kind}
data-rail-placement={railPlacement}
data-scrollable={isScrollableContainer ? "true" : undefined}
@@ -363,6 +373,7 @@ export const SectionGrid = ({
} as CSSProperties
}
data-grid-section-id={section.id}
+ suppressHydrationWarning
data-kind={section.kind}
data-grid-editor-error={isEditMode && editorRuntimeStatus === "error" ? "true" : undefined}
>
@@ -406,7 +417,11 @@ const useMinimumViewportRowCount = (enabled: boolean, canvasScale: number) => {
useEffect(() => {
if (!enabled) return;
- const update = () => setVisualHeight(window.visualViewport?.height ?? window.innerHeight);
+ const update = () => {
+ startTransition(() => {
+ setVisualHeight(window.visualViewport?.height ?? window.innerHeight);
+ });
+ };
update();
window.addEventListener("resize", update, { passive: true });
window.visualViewport?.addEventListener("resize", update, { passive: true });
diff --git a/apps/nextjs/src/components/board/sections/section-collapse.tsx b/apps/nextjs/src/components/board/sections/section-collapse.tsx
index 6d2492e2f..b0343f898 100644
--- a/apps/nextjs/src/components/board/sections/section-collapse.tsx
+++ b/apps/nextjs/src/components/board/sections/section-collapse.tsx
@@ -39,9 +39,10 @@ export const BoardSectionCollapseProvider = ({ children }: PropsWithChildren) =>
useEffect(() => {
setCollapsedById((previous) => {
- const next = { ...previous };
+ let next = previous;
for (const section of board.sections) {
if (section.kind === "empty" || section.id in next) continue;
+ if (next === previous) next = { ...previous };
next[section.id] = section.collapsed;
}
return next;
diff --git a/apps/nextjs/src/components/board/selection/board-selection-context.tsx b/apps/nextjs/src/components/board/selection/board-selection-context.tsx
index c0b9781e7..fa75a89ee 100644
--- a/apps/nextjs/src/components/board/selection/board-selection-context.tsx
+++ b/apps/nextjs/src/components/board/selection/board-selection-context.tsx
@@ -61,7 +61,10 @@ export const BoardSelectionProvider = ({ children }: PropsWithChildren) => {
// Clear selection if leaving edit mode
useEffect(() => {
if (!isEditMode) {
- setSelectedItemIds(new Set());
+ setSelectedItemIds((previous) => {
+ if (previous.size === 0) return previous;
+ return new Set();
+ });
}
}, [isEditMode]);
diff --git a/apps/nextjs/src/components/layout/loading.tsx b/apps/nextjs/src/components/layout/loading.tsx
new file mode 100644
index 000000000..ae59ee49b
--- /dev/null
+++ b/apps/nextjs/src/components/layout/loading.tsx
@@ -0,0 +1,7 @@
+import { Center, Loader } from "@mantine/core";
+
+export const CommonLoading = () => (
+ <Center h="100vh">
+ <Loader />
+ </Center>
+);
diff --git a/bun.lock b/bun.lock
index 17335fdaf..434c8caa1 100644
--- a/bun.lock
+++ b/bun.lock
@@ -1012,6 +1012,7 @@
"acorn-jsx": "catalog:",
"clsx": "catalog:",
"dayjs": "catalog:",
+ "isomorphic-dompurify": "catalog:",
"lucide-react": "catalog:",
"mantine-datatable": "catalog:",
"mantine-react-table": "catalog:",
diff --git a/packages/api/src/query-cache.ts b/packages/api/src/query-cache.ts
index 513557399..4fbc18fc0 100644
--- a/packages/api/src/query-cache.ts
+++ b/packages/api/src/query-cache.ts
@@ -16,6 +16,13 @@ export const isTrpcForbiddenError = (error: unknown): error is ForbiddenTrpcErro
export const queryCacheDefaultStaleTimeMs = 30_000;
export const queryCacheDefaultRefetchIntervalMs = 30_000;
export const queryCacheDefaultGcTimeMs = 1000 * 60 * 5;
+// A finite server GC timer roots the request cache after SSR has finished.
+// Infinity schedules no timer; the request's QueryClient can be collected normally.
+export const getQueryCacheGcTime = () => {
+ if (typeof window === "undefined") return Infinity;
+ return queryCacheDefaultGcTimeMs;
+};
+
export const queryCacheMetadataStaleTimeMs = 1000 * 60 * 5;
const widgetDataQueryPaths = new Set(["app.byId", "app.byIds", "docker.getContainers", "integration.byIds"]);
diff --git a/packages/api/src/test/query-cache.spec.ts b/packages/api/src/test/query-cache.spec.ts
index e5928bf71..0383cab9e 100644
--- a/packages/api/src/test/query-cache.spec.ts
+++ b/packages/api/src/test/query-cache.spec.ts
@@ -3,6 +3,7 @@ import { QueryClient } from "@tanstack/react-query";
import {
dashboardSupportingQueryPolicies,
+ getQueryCacheGcTime,
isWidgetDataQueryKey,
isWidgetDataTrpcPath,
queryCacheDefaultRefetchIntervalMs,
@@ -111,3 +112,33 @@ describe("dashboard supporting query policies", () => {
]);
});
});
+
+describe("server query lifetime", () => {
+ test("keeps SSR data readable without a timer retaining the completed request", () => {
+ vi.useFakeTimers();
+ vi.stubGlobal("window", undefined);
+ const client = new QueryClient({ defaultOptions: { queries: { gcTime: getQueryCacheGcTime() } } });
+ try {
+ client.setQueryData(["dashboard"], { history: [1, 2, 3] });
+ expect(client.getQueryData(["dashboard"])).toEqual({ history: [1, 2, 3] });
+ expect(vi.getTimerCount()).toBe(0);
+ } finally {
+ client.clear();
+ vi.unstubAllGlobals();
+ }
+ });
+
+ test("still collects unused browser queries after five minutes", () => {
+ vi.useFakeTimers();
+ vi.stubGlobal("window", {});
+ const client = new QueryClient({ defaultOptions: { queries: { gcTime: getQueryCacheGcTime() } } });
+ try {
+ client.setQueryData(["dashboard"], { history: [1, 2, 3] });
+ vi.advanceTimersByTime(5 * 60_000);
+ expect(client.getQueryData(["dashboard"])).toBeUndefined();
+ } finally {
+ client.clear();
+ vi.unstubAllGlobals();
+ }
+ });
+});
diff --git a/packages/spotlight/src/modes/home/context.tsx b/packages/spotlight/src/modes/home/context.tsx
index 07b967a97..166b93fae 100644
--- a/packages/spotlight/src/modes/home/context.tsx
+++ b/packages/spotlight/src/modes/home/context.tsx
@@ -1,5 +1,5 @@
import type { DependencyList, PropsWithChildren } from "react";
-import { createContext, useCallback, useContext, useEffect, useMemo, useState } from "react";
+import { createContext, startTransition, useCallback, useContext, useEffect, useMemo, useState } from "react";
import type { TablerIcon } from "@homarr/ui";
@@ -39,28 +39,32 @@ const createSpotlightContext = (displayName: string) => {
const [itemsMap, setItemsMap] = useState<Map<string, { items: ContextSpecificItem[]; count: number }>>(new Map());
const registerItems = useCallback((key: string, newItems: ContextSpecificItem[]) => {
- setItemsMap((prevItems) => {
- const newItemsMap = new Map(prevItems);
- newItemsMap.set(key, { items: newItems, count: (newItemsMap.get(key)?.count ?? 0) + 1 });
- return newItemsMap;
- });
+ startTransition(() =>
+ setItemsMap((prevItems) => {
+ const newItemsMap = new Map(prevItems);
+ newItemsMap.set(key, { items: newItems, count: (newItemsMap.get(key)?.count ?? 0) + 1 });
+ return newItemsMap;
+ }),
+ );
}, []);
const unregisterItems = useCallback((key: string) => {
- setItemsMap((prevItems) => {
- const registrationCount = prevItems.get(key)?.count ?? 0;
+ startTransition(() =>
+ setItemsMap((prevItems) => {
+ const registrationCount = prevItems.get(key)?.count ?? 0;
- if (registrationCount <= 1) {
- const newItemsMap = new Map(prevItems);
- newItemsMap.delete(key);
- return newItemsMap;
- }
+ if (registrationCount <= 1) {
+ const newItemsMap = new Map(prevItems);
+ newItemsMap.delete(key);
+ return newItemsMap;
+ }
- const newItemsMap = new Map(prevItems);
- newItemsMap.set(key, { items: newItemsMap.get(key)?.items ?? [], count: registrationCount - 1 });
+ const newItemsMap = new Map(prevItems);
+ newItemsMap.set(key, { items: newItemsMap.get(key)?.items ?? [], count: registrationCount - 1 });
- return newItemsMap;
- });
+ return newItemsMap;
+ }),
+ );
}, []);
const items = useMemo(() => {
diff --git a/packages/ui/src/hooks/index.ts b/packages/ui/src/hooks/index.ts
index 950536175..42dfa2624 100644
--- a/packages/ui/src/hooks/index.ts
+++ b/packages/ui/src/hooks/index.ts
@@ -1,2 +1,3 @@
export * from "./use-is-mobile";
+export * from "./use-deferred-element-size";
export * from "./use-translated-mantine-react-table";
diff --git a/packages/ui/src/hooks/use-deferred-element-size.ts b/packages/ui/src/hooks/use-deferred-element-size.ts
new file mode 100644
index 000000000..ee1fc322a
--- /dev/null
+++ b/packages/ui/src/hooks/use-deferred-element-size.ts
@@ -0,0 +1,22 @@
+import { startTransition, useCallback, useState } from "react";
+
+// Measuring a mounted board should not interrupt hydration of its widgets.
+export const useDeferredElementSize = <TElement extends HTMLElement>() => {
+ const [size, setSize] = useState({ width: 0, height: 0 });
+ const ref = useCallback((element: TElement | null) => {
+ if (!element) return;
+ const observer = new ResizeObserver(([entry]) => {
+ if (!entry) return;
+ const { width, height } = entry.contentRect;
+ startTransition(() => {
+ setSize((current) => {
+ if (current.width === width && current.height === height) return current;
+ return { width, height };
+ });
+ });
+ });
+ observer.observe(element);
+ return () => observer.disconnect();
+ }, []);
+ return { ref, ...size };
+};
diff --git a/packages/widgets/package.json b/packages/widgets/package.json
index 24af4e3e6..070945a97 100644
--- a/packages/widgets/package.json
+++ b/packages/widgets/package.json
@@ -97,6 +97,7 @@
"acorn-jsx": "catalog:",
"clsx": "catalog:",
"dayjs": "catalog:",
+ "isomorphic-dompurify": "catalog:",
"lucide-react": "catalog:",
"mantine-datatable": "catalog:",
"mantine-react-table": "catalog:",
diff --git a/packages/widgets/src/assistant/index.ts b/packages/widgets/src/assistant/index.ts
index e93951e35..7129dfb0d 100644
--- a/packages/widgets/src/assistant/index.ts
+++ b/packages/widgets/src/assistant/index.ts
@@ -4,6 +4,7 @@ import { createWidgetDefinition } from "../definition";
import { optionsBuilder } from "../options";
export const { definition, componentLoader } = createWidgetDefinition("assistant", {
+ deferUntilVisible: true,
icon: IconRobot,
createOptions() {
return optionsBuilder.from(() => ({}));
diff --git a/packages/widgets/src/beszel-system-table/component.tsx b/packages/widgets/src/beszel-system-table/component.tsx
index b7352622c..ecadecffa 100644
--- a/packages/widgets/src/beszel-system-table/component.tsx
+++ b/packages/widgets/src/beszel-system-table/component.tsx
@@ -418,7 +418,7 @@ export default function BeszelSystemTableWidget({
return cols.filter(Boolean) as DataTableColumn<SystemRowWithKey>[];
}, [formatByteRate, formatBytes, options.fahrenheit, tBeszel, tCommon, size, visibleMetricKeys, isAdvanced]);
- const { effectiveColumns, storeKey } = usePersistedTableLayout({
+ const { effectiveColumns, storeKey, onColumnLayoutChange } = usePersistedTableLayout({
columns,
columnAccessors,
columnOrder: options.columnOrder,
@@ -458,6 +458,7 @@ export default function BeszelSystemTableWidget({
noRecordsText={tBeszel("empty.noSystems")}
idAccessor="rowKey"
storeColumnsKey={storeKey}
+ onColumnLayoutChange={onColumnLayoutChange}
onRowClick={isEditMode ? undefined : handleRowClick}
/>
</div>
diff --git a/packages/widgets/src/beszel/_shared/chart-style.ts b/packages/widgets/src/beszel/_shared/chart-style.ts
new file mode 100644
index 000000000..dbbf1aced
--- /dev/null
+++ b/packages/widgets/src/beszel/_shared/chart-style.ts
@@ -0,0 +1,8 @@
+export const chartStyle = {
+ minWidth: 0,
+ minHeight: 1,
+ flexGrow: 1,
+ flexShrink: 0,
+ // Recharts measures pixels; keep points, axes and tooltips readable on a scaled board.
+ zoom: "var(--board-canvas-inverse-scale, 1)",
+} as const;
diff --git a/packages/widgets/src/beszel/_shared/chart.tsx b/packages/widgets/src/beszel/_shared/chart.tsx
index 7693b034b..5a3f060dc 100644
--- a/packages/widgets/src/beszel/_shared/chart.tsx
+++ b/packages/widgets/src/beszel/_shared/chart.tsx
@@ -3,7 +3,9 @@
import { memo, useDeferredValue, useEffect, useMemo, useRef, useState } from "react";
import { Box, Group, Stack, Text } from "@mantine/core";
import type { AreaChartProps } from "@mantine/charts";
-import { AreaChart } from "@mantine/charts";
+import dynamic from "next/dynamic";
+
+import type { BeszelAreaChartProps } from "./interactive-chart";
import { useInViewport } from "@mantine/hooks";
import dayjs from "dayjs";
@@ -15,9 +17,15 @@ import { formatLocalizedDate } from "../../common/locale";
import { WidgetQueryLoadingState } from "../../common/query-state-indicator";
import { containerChartColor } from "./colors";
import classes from "./chart.module.css";
+import { chartStyle } from "./chart-style";
export type { BeszelTimePeriod } from "@homarr/definitions/beszel";
+const BeszelAreaChart = dynamic(() => import("./interactive-chart"), {
+ ssr: false,
+ loading: () => <BeszelChartPlaceholder height={180} />,
+});
+
const timeFormatOptions: Record<BeszelTimePeriod, Intl.DateTimeFormatOptions> = {
"1m": { hour: "numeric", minute: "2-digit", second: "2-digit" },
"1h": { hour: "numeric", minute: "2-digit" },
@@ -94,18 +102,6 @@ export function padLiveTimeGrid(data: Record<string, unknown>[], pointCount = 60
});
}
-const yAxisBase = {
- tickMargin: 0,
- tick: { fontSize: 12, fill: "var(--beszel-chart-muted)" },
-} as const;
-const chartStyle = {
- minWidth: 0,
- minHeight: 1,
- flexGrow: 1,
- flexShrink: 0,
- // Recharts measures pixels; keep points, axes and tooltips readable on a scaled board.
- zoom: "var(--board-canvas-inverse-scale, 1)",
-} as const;
const panelStyle = { minWidth: 0 } as const;
const chartContainerStyle = {
minWidth: 0,
@@ -115,7 +111,6 @@ const chartContainerStyle = {
flexGrow: 1,
flexShrink: 0,
} as const;
-const chartMargin = { top: 12, right: 5, bottom: 0, left: 0 } as const;
export const CPU_Y_AXIS_DOMAIN: [number, string] = [0, "auto"];
interface BeszelChartPanelProps {
@@ -161,91 +156,14 @@ const BeszelChartPlaceholder = ({ height }: { height: AreaChartProps["h"] }) =>
const DeferredBeszelChart = memo(
({ chartProps }: { chartProps: BeszelAreaChartProps; isVisible: boolean }) => {
- // Let the dashboard hydrate and handle input before mounting or refreshing SVG charts.
- const deferredChartProps = useDeferredValue(chartProps, null);
- if (!deferredChartProps) {
- return <BeszelChartPlaceholder height={chartProps.h} />;
- }
+ // Render the first visible chart promptly; defer subsequent data updates.
+ const deferredChartProps = useDeferredValue(chartProps);
return <BeszelAreaChart {...deferredChartProps} />;
},
// Retain mounted charts while offscreen; apply the latest data when they re-enter view.
(previous, next) => !next.isVisible || previous.chartProps === next.chartProps,
);
-type BeszelAreaChartProps = Omit<AreaChartProps, "dataKey" | "curveType" | "withDots" | "withYAxis"> & {
- yAxisFormatter: (value: number) => string;
- yAxisDomain?: [number, string];
-};
-
-const BeszelAreaChart = memo(
- ({
- yAxisFormatter,
- withXAxis = true,
- yAxisDomain,
- yAxisProps: yAxisPropsOverride,
- xAxisProps: xAxisPropsOverride,
- areaChartProps: areaChartPropsOverride,
- type = "default",
- fillOpacity = 0.4,
- ...props
- }: BeszelAreaChartProps) => {
- const mergedXAxis = useMemo(
- () => ({
- interval: "preserveEnd" as const,
- minTickGap: 50,
- tick: { fontSize: 12, fill: "var(--beszel-chart-muted)" },
- ...xAxisPropsOverride,
- }),
- [xAxisPropsOverride],
- );
- const mergedYAxis = useMemo(() => {
- const base = {
- ...yAxisBase,
- width: "auto" as const,
- tickMargin: 2,
- tickFormatter: yAxisFormatter,
- ...yAxisPropsOverride,
- };
- if (yAxisDomain) {
- return { ...base, domain: yAxisDomain };
- }
- return base;
- }, [yAxisFormatter, yAxisDomain, yAxisPropsOverride]);
-
- return (
- <AreaChart
- // Recharts keeps registration order when keyed areas move; reset it when ranks change.
- key={JSON.stringify(props.series.map(({ name }) => name))}
- className={classes.chart}
- dataKey="time"
- curveType="monotone"
- withGradient={false}
- connectNulls={false}
- withDots={false}
- areaProps={({ color }) => ({
- fill: color,
- fillOpacity,
- activeDot: { r: 4, fill: color, stroke: "transparent", strokeWidth: 2 },
- })}
- type={type}
- strokeWidth={1}
- fillOpacity={fillOpacity}
- strokeDasharray="0"
- gridColor="color-mix(in srgb, var(--beszel-chart-border) 50%, transparent)"
- textColor="var(--beszel-chart-muted)"
- withXAxis={withXAxis}
- withYAxis
- w="100%"
- areaChartProps={{ margin: chartMargin, ...areaChartPropsOverride }}
- style={chartStyle}
- xAxisProps={mergedXAxis}
- yAxisProps={mergedYAxis}
- {...props}
- />
- );
- },
-);
-
export const useSystemChartData = (
systemStats: BeszelSystemStatsRecord[] | undefined,
mapFn: (stats: BeszelSystemStatsRecord["stats"]) => Record<string, unknown>,
diff --git a/packages/widgets/src/beszel/_shared/interactive-chart.tsx b/packages/widgets/src/beszel/_shared/interactive-chart.tsx
new file mode 100644
index 000000000..1d2d218aa
--- /dev/null
+++ b/packages/widgets/src/beszel/_shared/interactive-chart.tsx
@@ -0,0 +1,88 @@
+"use client";
+import { memo, useMemo } from "react";
+import { AreaChart } from "@mantine/charts";
+import type { AreaChartProps } from "@mantine/charts";
+import classes from "./chart.module.css";
+import { chartStyle } from "./chart-style";
+
+const yAxisBase = {
+ tickMargin: 0,
+ tick: { fontSize: 12, fill: "var(--beszel-chart-muted)" },
+} as const;
+const chartMargin = { top: 12, right: 5, bottom: 0, left: 0 } as const;
+
+export type BeszelAreaChartProps = Omit<AreaChartProps, "dataKey" | "curveType" | "withDots" | "withYAxis"> & {
+ yAxisFormatter: (value: number) => string;
+ yAxisDomain?: [number, string];
+};
+
+const BeszelAreaChart = memo(
+ ({
+ yAxisFormatter,
+ withXAxis = true,
+ yAxisDomain,
+ yAxisProps: yAxisPropsOverride,
+ xAxisProps: xAxisPropsOverride,
+ areaChartProps: areaChartPropsOverride,
+ type = "default",
+ fillOpacity = 0.4,
+ ...props
+ }: BeszelAreaChartProps) => {
+ const mergedXAxis = useMemo(
+ () => ({
+ interval: "preserveEnd" as const,
+ minTickGap: 50,
+ tick: { fontSize: 12, fill: "var(--beszel-chart-muted)" },
+ ...xAxisPropsOverride,
+ }),
+ [xAxisPropsOverride],
+ );
+ const mergedYAxis = useMemo(() => {
+ const base = {
+ ...yAxisBase,
+ width: "auto" as const,
+ tickMargin: 2,
+ tickFormatter: yAxisFormatter,
+ ...yAxisPropsOverride,
+ };
+ if (yAxisDomain) {
+ return { ...base, domain: yAxisDomain };
+ }
+ return base;
+ }, [yAxisFormatter, yAxisDomain, yAxisPropsOverride]);
+
+ return (
+ <AreaChart
+ // Recharts keeps registration order when keyed areas move; reset it when ranks change.
+ key={JSON.stringify(props.series.map(({ name }) => name))}
+ className={classes.chart}
+ dataKey="time"
+ curveType="monotone"
+ withGradient={false}
+ connectNulls={false}
+ withDots={false}
+ areaProps={({ color }) => ({
+ fill: color,
+ fillOpacity,
+ activeDot: { r: 4, fill: color, stroke: "transparent", strokeWidth: 2 },
+ })}
+ type={type}
+ strokeWidth={1}
+ fillOpacity={fillOpacity}
+ strokeDasharray="0"
+ gridColor="color-mix(in srgb, var(--beszel-chart-border) 50%, transparent)"
+ textColor="var(--beszel-chart-muted)"
+ withXAxis={withXAxis}
+ withYAxis
+ w="100%"
+ areaChartProps={{ margin: chartMargin, ...areaChartPropsOverride }}
+ style={chartStyle}
+ xAxisProps={mergedXAxis}
+ yAxisProps={mergedYAxis}
+ {...props}
+ />
+ );
+ },
+);
+
+export default BeszelAreaChart;
diff --git a/packages/widgets/src/calendar/index.ts b/packages/widgets/src/calendar/index.ts
index 055dbb77d..1ff509a65 100644
--- a/packages/widgets/src/calendar/index.ts
+++ b/packages/widgets/src/calendar/index.ts
@@ -9,6 +9,7 @@ import { optionsBuilder } from "../options";
import { calendarViews } from "./calendar-view";
export const { definition, componentLoader } = createWidgetDefinition("calendar", {
+ deferUntilVisible: true,
icon: IconCalendar,
supportsAdvancedFocus: true,
queryKey: [["widget", "calendar", "findAllEvents"]],
diff --git a/packages/widgets/src/common/homarr-data-table.tsx b/packages/widgets/src/common/homarr-data-table.tsx
index e21a69d90..8f6b5cfa9 100644
--- a/packages/widgets/src/common/homarr-data-table.tsx
+++ b/packages/widgets/src/common/homarr-data-table.tsx
@@ -8,6 +8,8 @@ import { DataTable } from "mantine-datatable";
import { scrollAreaDefaultProps } from "@homarr/ui";
+import type { TableLayoutChange } from "./use-persisted-table-layout";
+
const fallbackColumnWidth = 60;
const getColumnWidth = (width: string | number | undefined): number => {
@@ -26,6 +28,7 @@ type HomarrDataTableProps<T> = DataTableProps<T> & {
cellPadding: string;
rowCursor?: "auto" | "default";
preserveColumnWidths?: boolean;
+ onColumnLayoutChange?: (change: TableLayoutChange) => void;
fillColumnAccessor?: string;
defaultColumnWidths?: readonly Pick<DataTableColumn<T>, "accessor" | "width">[];
onColumnWidthsChange?: (widths: { accessor: string; width: number }[]) => void;
@@ -43,12 +46,18 @@ export function HomarrDataTable<T>({
columns,
defaultColumnProps,
onMouseDownCapture,
+ onDoubleClick,
+ onDragStartCapture,
+ onDragEndCapture,
+ onDrop,
+ onColumnLayoutChange,
scrollAreaProps,
style,
...props
}: HomarrDataTableProps<T>) {
const [resizePreviewWidths, setResizePreviewWidths] = useState<Record<string, number>>();
const removeResizeListeners = useRef<() => void>(() => undefined);
+ const draggedColumn = useRef<Element | null>(null);
const internalScrollViewportRef = useRef<HTMLDivElement>(null);
const scrollViewportRef = props.scrollViewportRef ?? internalScrollViewportRef;
useEffect(() => () => removeResizeListeners.current(), []);
@@ -88,6 +97,7 @@ export function HomarrDataTable<T>({
const startX = event.clientX;
removeResizeListeners.current();
+ let resized = false;
const usesDisplayedWidths = Boolean(
preserveColumnWidths &&
fillColumnAccessor &&
@@ -129,6 +139,7 @@ export function HomarrDataTable<T>({
nextWidth - nextMinimumWidth,
Math.max(currentMinimumWidth - currentWidth, moveEvent.clientX - startX),
);
+ resized = moveEvent.clientX !== startX;
previewWidths = {
...widths,
[currentAccessor]: currentWidth + delta,
@@ -146,6 +157,7 @@ export function HomarrDataTable<T>({
});
if (resizedWidths.length > 0) onColumnWidthsChange?.(resizedWidths);
}
+ if (resized) onColumnLayoutChange?.("columnWidths");
requestAnimationFrame(() => requestAnimationFrame(() => setResizePreviewWidths(undefined)));
};
removeResizeListeners.current = () => {
@@ -167,6 +179,7 @@ export function HomarrDataTable<T>({
defaultColumnWidths,
fillColumnAccessor,
onColumnWidthsChange,
+ onColumnLayoutChange,
onMouseDownCapture,
preserveColumnWidths,
scrollViewportRef,
@@ -251,6 +264,33 @@ export function HomarrDataTable<T>({
striped={false}
columns={fittedColumns}
onMouseDownCapture={handleMouseDownCapture}
+ onDoubleClick={(event) => {
+ onDoubleClick?.(event);
+ if (event.target instanceof Element && event.target.closest(".mantine-datatable-header-resizable-handle")) {
+ onColumnLayoutChange?.("columnWidths");
+ }
+ }}
+ onDragStartCapture={(event) => {
+ onDragStartCapture?.(event);
+ if (event.target instanceof Element) {
+ draggedColumn.current = event.target.closest('.mantine-datatable-header-cell-draggable[draggable="true"]');
+ }
+ }}
+ onDragEndCapture={(event) => {
+ onDragEndCapture?.(event);
+ draggedColumn.current = null;
+ }}
+ onDrop={(event) => {
+ onDrop?.(event);
+ let target: Element | null = null;
+ if (event.target instanceof Element) {
+ target = event.target.closest('.mantine-datatable-header-cell-draggable[draggable="true"]');
+ }
+ if (draggedColumn.current && target && draggedColumn.current !== target) {
+ onColumnLayoutChange?.("columnOrder");
+ }
+ draggedColumn.current = null;
+ }}
className={mergedClassName}
style={[{ pointerEvents: isEditMode ? "none" : undefined, "--homarr-table-min-width": minimumTableWidth }, style]}
defaultColumnProps={{
diff --git a/packages/widgets/src/common/use-persisted-table-layout.spec.ts b/packages/widgets/src/common/use-persisted-table-layout.spec.ts
index 0e1297b88..3c5186178 100644
--- a/packages/widgets/src/common/use-persisted-table-layout.spec.ts
+++ b/packages/widgets/src/common/use-persisted-table-layout.spec.ts
@@ -26,7 +26,7 @@ const columns: DataTableColumn<{ name: string; state: string }>[] = [{ accessor:
const columnAccessors = ["name", "state"] as const;
const LayoutHarness = ({ itemId, onLayoutChange }: { itemId: string; onLayoutChange: (layout: unknown) => void }) => {
- usePersistedTableLayout({
+ const { onColumnLayoutChange } = usePersistedTableLayout({
columns,
columnAccessors,
columnOrder: "",
@@ -35,7 +35,7 @@ const LayoutHarness = ({ itemId, onLayoutChange }: { itemId: string; onLayoutCha
storeKeyPrefix: "test-table",
onLayoutChange,
});
- return null;
+ return createElement("button", { onClick: () => onColumnLayoutChange("columnOrder") }, "Reorder");
};
describe("usePersistedTableLayout", () => {
@@ -71,6 +71,7 @@ describe("usePersistedTableLayout", () => {
await act(async () => {
root.render(createElement(LayoutHarness, { itemId: "first", onLayoutChange: firstItemLayoutChange }));
});
+ await act(async () => container.querySelector("button")?.click());
expect(firstItemLayoutChange).not.toHaveBeenCalled();
await act(async () => {
diff --git a/packages/widgets/src/common/use-persisted-table-layout.ts b/packages/widgets/src/common/use-persisted-table-layout.ts
index cf19bb9aa..fe3d67e93 100644
--- a/packages/widgets/src/common/use-persisted-table-layout.ts
+++ b/packages/widgets/src/common/use-persisted-table-layout.ts
@@ -1,6 +1,6 @@
"use client";
-import { useCallback, useEffect, useMemo, useRef } from "react";
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import type { DataTableColumn } from "mantine-datatable";
import { useDataTableColumns } from "mantine-datatable";
@@ -11,7 +11,10 @@ interface TableLayoutOptions extends Record<string, unknown> {
columnWidths?: string;
}
+export type TableLayoutChange = "columnOrder" | "columnWidths";
+
interface PendingTableLayout {
+ changes: Set<TableLayoutChange>;
layout: TableLayoutOptions;
onLayoutChange: (layout: TableLayoutOptions) => void;
storeKey: string;
@@ -52,28 +55,15 @@ export const useTableLayoutPersistence = ({
[boardId, hasChangeAccess, itemId, saveItemOptions, setOptions],
);
-const toPixelWidth = (width: string | number): number | undefined => {
+const toPixelWidth = (width: string | number | undefined): number | undefined => {
if (typeof width === "number" && Number.isFinite(width) && width > 0) return width;
if (typeof width !== "string" || !width.endsWith("px")) return undefined;
- const parsedWidth = Number.parseInt(width, 10);
+ const parsedWidth = Number.parseFloat(width);
return Number.isFinite(parsedWidth) && parsedWidth > 0 ? parsedWidth : undefined;
};
-const getColumnWidthMap = (
- columnsWidth: Record<string, string | number>[],
- visibleAccessorSet: ReadonlySet<string>,
-): Record<string, number> => {
- const widths: Record<string, number> = {};
- for (const entry of columnsWidth) {
- for (const [accessor, width] of Object.entries(entry)) {
- if (!visibleAccessorSet.has(accessor)) continue;
- const pixelWidth = toPixelWidth(width);
- if (pixelWidth !== undefined) widths[accessor] = pixelWidth;
- }
- }
- return widths;
-};
+const normalizeWidth = (width: string | number | undefined) => toPixelWidth(width) ?? width ?? "auto";
export const parseColumnOrder = (value: string, columnAccessors: readonly string[]): string[] => {
if (!value) return [];
@@ -130,52 +120,85 @@ export const usePersistedTableLayout = <T>({
[savedOrder, visibleAccessors, visibleAccessorSet],
);
const storeKey = `${storeKeyPrefix}-${itemId ?? "preview"}-${[...visibleAccessors].toSorted().join(",")}`;
+ const savedColumns = useMemo(
+ () =>
+ restoredOrder.flatMap((accessor) => {
+ const column = columns.find((candidate) => String(candidate.accessor) === accessor);
+ if (!column) return [];
+ const width = savedWidths[accessor];
+ if (width === undefined) return [column];
+ return [{ ...column, width }];
+ }),
+ [columns, restoredOrder, savedWidths],
+ );
const { effectiveColumns, columnsOrder, columnsWidth, setColumnsOrder, setMultipleColumnWidths } =
- useDataTableColumns<T>({
- key: storeKey,
- columns,
- });
-
- const lastStoreKey = useRef(storeKey);
- const hydrated = useRef(false);
- const previousOrder = useRef(columnsOrder);
- const previousWidths = useRef(columnsWidth);
+ useDataTableColumns<T>({ key: storeKey, columns: savedColumns });
+ const currentWidths = useMemo<Record<string, string | number>>(
+ () => Object.fromEntries(columnsWidth.flatMap((entry) => Object.entries(entry))),
+ [columnsWidth],
+ );
+ const layoutKey = JSON.stringify([storeKey, columnOrder, columnWidths]);
+ const restoringLayoutKey = useRef<string | undefined>(undefined);
+ const [syncedLayoutKey, setSyncedLayoutKey] = useState<string>();
useEffect(() => {
- if (lastStoreKey.current !== storeKey) {
- lastStoreKey.current = storeKey;
- hydrated.current = false;
+ const widths = savedColumns.map(({ accessor, width }) => ({ accessor: String(accessor), width: width ?? "auto" }));
+ if (restoringLayoutKey.current !== layoutKey) {
+ restoringLayoutKey.current = layoutKey;
+ setSyncedLayoutKey(undefined);
+ setColumnsOrder(restoredOrder);
+ setMultipleColumnWidths(widths);
+ return;
}
- if (hydrated.current) return;
+ if (syncedLayoutKey === layoutKey) return;
const orderMatches =
columnsOrder.length === restoredOrder.length &&
columnsOrder.every((accessor, index) => accessor === restoredOrder[index]);
- const currentWidths = getColumnWidthMap(columnsWidth, visibleAccessorSet);
- const visibleWidths = Object.entries(savedWidths).filter(([accessor]) => visibleAccessorSet.has(accessor));
- const widthsMatch = visibleWidths.every(([accessor, width]) => currentWidths[accessor] === width);
+ const widthsMatch = widths.every(
+ ({ accessor, width }) => normalizeWidth(currentWidths[accessor]) === normalizeWidth(width),
+ );
if (orderMatches && widthsMatch) {
- previousOrder.current = columnsOrder;
- previousWidths.current = columnsWidth;
- hydrated.current = true;
+ setSyncedLayoutKey(layoutKey);
return;
}
if (!orderMatches) setColumnsOrder(restoredOrder);
- if (!widthsMatch) {
- setMultipleColumnWidths(visibleWidths.map(([accessor, width]) => ({ accessor, width })));
- }
+ if (!widthsMatch) setMultipleColumnWidths(widths);
}, [
columnsOrder,
- columnsWidth,
+ currentWidths,
+ layoutKey,
restoredOrder,
- savedWidths,
+ savedColumns,
setColumnsOrder,
setMultipleColumnWidths,
- storeKey,
- visibleAccessorSet,
+ syncedLayoutKey,
]);
+ const layout = useMemo(() => {
+ const newLayout: TableLayoutOptions = {};
+ const fullOrder = [...savedOrder, ...columnAccessors.filter((accessor) => !savedOrder.includes(accessor))];
+ const reorderedVisibleColumns = [...columnsOrder];
+ const mergedOrder = fullOrder.map((accessor) =>
+ visibleAccessorSet.has(accessor) ? (reorderedVisibleColumns.shift() ?? accessor) : accessor,
+ );
+ if (JSON.stringify(mergedOrder) !== JSON.stringify(fullOrder)) newLayout.columnOrder = JSON.stringify(mergedOrder);
+
+ const widthMap: Record<string, number> = { ...savedWidths };
+ let widthsChanged = false;
+ for (const column of columns) {
+ const accessor = String(column.accessor);
+ const width = toPixelWidth(currentWidths[accessor]);
+ const defaultWidth = toPixelWidth(column.width);
+ if ((width ?? defaultWidth) !== (savedWidths[accessor] ?? defaultWidth)) widthsChanged = true;
+ if (width === undefined) delete widthMap[accessor];
+ else widthMap[accessor] = width;
+ }
+ if (widthsChanged) newLayout.columnWidths = JSON.stringify(widthMap);
+ return newLayout;
+ }, [columnAccessors, columns, columnsOrder, currentWidths, savedOrder, savedWidths, visibleAccessorSet]);
+
const pendingLayout = useRef<PendingTableLayout | undefined>(undefined);
const saveTimeout = useRef<number | undefined>(undefined);
const flushPendingLayout = useCallback(() => {
@@ -183,53 +206,36 @@ export const usePersistedTableLayout = <T>({
pendingLayout.current = undefined;
window.clearTimeout(saveTimeout.current);
saveTimeout.current = undefined;
- if (pending) pending.onLayoutChange(pending.layout);
+ if (pending && Object.keys(pending.layout).length > 0) pending.onLayoutChange(pending.layout);
}, []);
useEffect(() => {
if (pendingLayout.current && pendingLayout.current.storeKey !== storeKey) flushPendingLayout();
}, [flushPendingLayout, storeKey]);
useEffect(() => () => flushPendingLayout(), [flushPendingLayout]);
- useEffect(() => {
- if (!hydrated.current) return;
-
- const orderChanged = JSON.stringify(columnsOrder) !== JSON.stringify(previousOrder.current);
- const widthsChanged = JSON.stringify(columnsWidth) !== JSON.stringify(previousWidths.current);
- previousOrder.current = columnsOrder;
- previousWidths.current = columnsWidth;
- if (!orderChanged && !widthsChanged) return;
-
- const newLayout: TableLayoutOptions = {};
- if (orderChanged) {
- const fullOrder = [...savedOrder, ...columnAccessors.filter((accessor) => !savedOrder.includes(accessor))];
- const reorderedVisibleColumns = [...columnsOrder];
- const mergedOrder = fullOrder.map((accessor) =>
- visibleAccessorSet.has(accessor) ? (reorderedVisibleColumns.shift() ?? accessor) : accessor,
- );
- newLayout.columnOrder = JSON.stringify(mergedOrder);
- }
- if (widthsChanged) {
- const widthMap: Record<string, number> = { ...savedWidths };
- Object.assign(widthMap, getColumnWidthMap(columnsWidth, visibleAccessorSet));
- newLayout.columnWidths = JSON.stringify(widthMap);
+ const updatePendingLayout = useCallback(() => {
+ const pending = pendingLayout.current;
+ if (!pending || pending.storeKey !== storeKey) return;
+ const nextLayout: TableLayoutOptions = {};
+ for (const change of pending.changes) {
+ const value = layout[change];
+ if (value !== undefined) nextLayout[change] = value;
}
+ pending.layout = nextLayout;
+ }, [layout, storeKey]);
+ useEffect(updatePendingLayout, [updatePendingLayout]);
+ const onColumnLayoutChange = useCallback(
+ (change: TableLayoutChange) => {
+ if (pendingLayout.current && pendingLayout.current.storeKey !== storeKey) flushPendingLayout();
+ pendingLayout.current ??= { changes: new Set(), layout: {}, onLayoutChange, storeKey };
+ pendingLayout.current.changes.add(change);
+ updatePendingLayout();
+ window.clearTimeout(saveTimeout.current);
+ saveTimeout.current = window.setTimeout(flushPendingLayout, layoutSaveDelay);
+ },
+ [flushPendingLayout, onLayoutChange, storeKey, updatePendingLayout],
+ );
- if (pendingLayout.current && pendingLayout.current.storeKey !== storeKey) flushPendingLayout();
- pendingLayout.current = pendingLayout.current
- ? { ...pendingLayout.current, layout: { ...pendingLayout.current.layout, ...newLayout } }
- : { layout: newLayout, onLayoutChange, storeKey };
- window.clearTimeout(saveTimeout.current);
- saveTimeout.current = window.setTimeout(flushPendingLayout, layoutSaveDelay);
- }, [
- columnAccessors,
- columnsOrder,
- columnsWidth,
- flushPendingLayout,
- onLayoutChange,
- savedOrder,
- savedWidths,
- storeKey,
- visibleAccessorSet,
- ]);
-
- return { effectiveColumns, storeKey, setMultipleColumnWidths };
+ if (syncedLayoutKey !== layoutKey)
+ return { effectiveColumns: savedColumns, storeKey, onColumnLayoutChange, setMultipleColumnWidths };
+ return { effectiveColumns, storeKey, onColumnLayoutChange, setMultipleColumnWidths };
};
diff --git a/packages/widgets/src/custom-api/index.ts b/packages/widgets/src/custom-api/index.ts
index 5ca4b6f1f..a9cbc147b 100644
--- a/packages/widgets/src/custom-api/index.ts
+++ b/packages/widgets/src/custom-api/index.ts
@@ -5,6 +5,7 @@ import { createWidgetDefinition } from "../definition";
import { optionsBuilder } from "../options";
export const { definition, componentLoader } = createWidgetDefinition("customApi", {
+ deferUntilVisible: true,
icon: IconApi,
createOptions() {
return optionsBuilder.from((factory) => ({
diff --git a/packages/widgets/src/definition.ts b/packages/widgets/src/definition.ts
index d19fa686d..cd0602861 100644
--- a/packages/widgets/src/definition.ts
+++ b/packages/widgets/src/definition.ts
@@ -111,6 +111,8 @@ export const createWidgetDefinition = <TKind extends WidgetKind, TDefinition ext
export interface WidgetDefinition {
icon: TablerIcon;
supportsAdvancedFocus?: boolean;
+ /** Start the browser runtime on first visibility, then retain its state offscreen. */
+ deferUntilVisible?: boolean;
queryKey?: QueryKey;
queryKeys?: readonly QueryKey[];
queryMatcher?: WidgetQueryMatcher;
diff --git a/packages/widgets/src/docker/component.tsx b/packages/widgets/src/docker/component.tsx
index 17daf8473..505491f0f 100644
--- a/packages/widgets/src/docker/component.tsx
+++ b/packages/widgets/src/docker/component.tsx
@@ -392,7 +392,7 @@ export default function DockerWidget({
({ accessor }) => columnVisibility[String(accessor) as keyof typeof columnVisibility],
);
}, [actionHandlers, columnVisibility, formatBytes, isAdvanced, isEditMode, options.enableRowSorting, t, tCommon]);
- const { effectiveColumns, storeKey, setMultipleColumnWidths } = usePersistedTableLayout({
+ const { effectiveColumns, storeKey, onColumnLayoutChange, setMultipleColumnWidths } = usePersistedTableLayout({
columns,
columnAccessors,
columnOrder: options.columnOrder,
@@ -445,6 +445,7 @@ export default function DockerWidget({
noRecordsText={tWidget("empty.noContainers")}
columns={effectiveColumns}
storeColumnsKey={storeKey}
+ onColumnLayoutChange={onColumnLayoutChange}
sortStatus={sortStatus}
onSortStatusChange={(isAdvanced || options.enableRowSorting) && !isEditMode ? setSortStatus : undefined}
idAccessor="resourceId"
diff --git a/packages/widgets/src/downloads/component.tsx b/packages/widgets/src/downloads/component.tsx
index 4455096e5..052c815b4 100644
--- a/packages/widgets/src/downloads/component.tsx
+++ b/packages/widgets/src/downloads/component.tsx
@@ -720,7 +720,7 @@ export default function DownloadClientsWidget({
return cols.filter(Boolean) as DataTableColumn<ExtendedDownloadClientItem>[];
}, [columnContext, displayMode, formatByteRate, formatBytes, formatBytesPair, progressColumnWidth, size, t]);
- const { effectiveColumns, storeKey, setMultipleColumnWidths } = usePersistedTableLayout({
+ const { effectiveColumns, storeKey, onColumnLayoutChange, setMultipleColumnWidths } = usePersistedTableLayout({
columns,
columnAccessors: DOWNLOAD_COLUMN_ACCESSORS,
columnOrder: options.columnOrder,
@@ -816,6 +816,7 @@ export default function DownloadClientsWidget({
records={sortedData}
columns={effectiveColumns}
storeColumnsKey={storeKey}
+ onColumnLayoutChange={onColumnLayoutChange}
sortStatus={sortStatus}
onSortStatusChange={setSortStatus}
noRecordsText={t("errors.noItems")}
diff --git a/packages/widgets/src/manifest.ts b/packages/widgets/src/manifest.ts
index 47c82cf13..d32fbfe0b 100644
--- a/packages/widgets/src/manifest.ts
+++ b/packages/widgets/src/manifest.ts
@@ -65,9 +65,12 @@ export const createRetryableLoader = <TKey, TValue>(loaders: ReadonlyMap<TKey, (
const promise = loader();
promises.set(key, promise);
- void promise.catch(() => {
- if (promises.get(key) === promise) promises.delete(key);
- });
+ void promise.then(
+ (value) => Object.assign(promise, { status: "fulfilled", value }),
+ () => {
+ if (promises.get(key) === promise) promises.delete(key);
+ },
+ );
return promise;
};
};
diff --git a/packages/widgets/src/media-transcoding/index.ts b/packages/widgets/src/media-transcoding/index.ts
index 4dd75e2f5..8426402a1 100644
--- a/packages/widgets/src/media-transcoding/index.ts
+++ b/packages/widgets/src/media-transcoding/index.ts
@@ -11,6 +11,7 @@ import { views } from "./views";
export { views };
export const { componentLoader, definition } = createWidgetDefinition("mediaTranscoding", {
+ deferUntilVisible: true,
icon: IconTransform,
supportsAdvancedFocus: true,
queryKey: [["widget", "mediaTranscoding", "getDataAsync"]],
diff --git a/packages/widgets/src/notebook/canonical-task.ts b/packages/widgets/src/notebook/canonical-task.ts
new file mode 100644
index 000000000..003c95ba4
--- /dev/null
+++ b/packages/widgets/src/notebook/canonical-task.ts
@@ -0,0 +1,13 @@
+export const updateNotebookTaskChecked = (html: string, taskIndex: number, checked: boolean) => {
+ const parsed = new DOMParser().parseFromString(html, "text/html");
+ const taskItems = parsed.querySelectorAll('li[data-type="taskItem"]');
+ const taskItem = taskItems.item(taskIndex);
+ if (!taskItem) return html;
+ taskItem.setAttribute("data-checked", String(checked));
+ const checkbox = taskItem.querySelector('input[type="checkbox"]');
+ if (checkbox instanceof HTMLInputElement) {
+ if (checked) checkbox.setAttribute("checked", "checked");
+ else checkbox.removeAttribute("checked");
+ }
+ return parsed.body.innerHTML;
+};
diff --git a/packages/widgets/src/notebook/component.tsx b/packages/widgets/src/notebook/component.tsx
index 84f3b1085..daad64375 100644
--- a/packages/widgets/src/notebook/component.tsx
+++ b/packages/widgets/src/notebook/component.tsx
@@ -1,13 +1,56 @@
"use client";
-import dynamic from "next/dynamic";
+import { useCallback, useEffect, useRef, useState } from "react";
+
+import { showErrorNotification } from "@homarr/notifications";
import type { WidgetComponentProps } from "../definition";
+import type { Notebook as NotebookEditorComponent } from "./notebook";
+import dynamic from "next/dynamic";
-const Notebook = dynamic(() => import("./notebook").then((module) => module.Notebook), {
- ssr: false,
-});
+const loadReadMode = () => import("./read-mode").then((module) => module.NotebookReadMode);
+// Visible widget preloading should also start the read view's browser chunk.
+if (typeof window !== "undefined") void loadReadMode().catch(() => undefined);
+const NotebookReadMode = dynamic(loadReadMode, { ssr: false });
export default function NotebookWidget(props: WidgetComponentProps<"notebook">) {
- return <Notebook {...props} />;
+ const [editor, setEditor] = useState<typeof NotebookEditorComponent | null>(null);
+ const [isLoadingEditor, setIsLoadingEditor] = useState(false);
+ const pendingRef = useRef(false);
+ const isMountedRef = useRef(true);
+
+ useEffect(() => {
+ isMountedRef.current = true;
+ return () => {
+ isMountedRef.current = false;
+ };
+ }, []);
+
+ const handleRequestEdit = useCallback(() => {
+ if (pendingRef.current) return;
+ pendingRef.current = true;
+ setIsLoadingEditor(true);
+ void (async () => {
+ try {
+ const module = await import("./notebook");
+ const Component = module.Notebook;
+ if (!isMountedRef.current) return;
+ pendingRef.current = false;
+ setIsLoadingEditor(false);
+ setEditor(() => Component);
+ } catch (error) {
+ if (!isMountedRef.current) return;
+ pendingRef.current = false;
+ setIsLoadingEditor(false);
+ showErrorNotification({ message: error instanceof Error ? error.message : String(error) });
+ }
+ })();
+ }, []);
+
+ if (editor) {
+ const Editor = editor;
+ return <Editor {...props} autoEdit />;
+ }
+
+ return <NotebookReadMode {...props} isLoadingEditor={isLoadingEditor} onRequestEdit={handleRequestEdit} />;
}
diff --git a/packages/widgets/src/notebook/notebook.css b/packages/widgets/src/notebook/notebook.css
index 4762db2c2..11f3239b0 100644
--- a/packages/widgets/src/notebook/notebook.css
+++ b/packages/widgets/src/notebook/notebook.css
@@ -44,7 +44,7 @@
vertical-align: top;
}
-.tiptap table :where(th, td) > * {
+.homarr-notebook .tiptap table :where(th, td) > * {
margin-bottom: 0;
}
@@ -60,7 +60,7 @@
z-index: 2;
}
-.tiptap table p {
+.homarr-notebook .tiptap table p {
margin: 0;
}
@@ -132,3 +132,48 @@
max-height: 2rem;
object-fit: contain;
}
+
+.homarr-notebook .tiptap :where(p) {
+ margin-top: 0;
+ margin-bottom: calc(0.4375rem * var(--mantine-scale));
+}
+
+.homarr-notebook .tiptap :where(h1, h2, h3, h4, h5, h6) {
+ margin-top: 0;
+}
+
+.homarr-notebook .tiptap :where(ul, ol) :where(li) {
+ margin-top: calc(0.125rem * var(--mantine-scale));
+}
+
+.homarr-notebook .tiptap :where(pre) {
+ font-family: var(--mantine-font-family-monospace);
+ border-radius: var(--mantine-radius-default);
+ padding: var(--mantine-spacing-sm) var(--mantine-spacing-md);
+}
+
+.homarr-notebook .tiptap :where(pre) :where(code) {
+ font-size: var(--mantine-font-size-sm);
+}
+
+.homarr-notebook .tiptap > :last-child {
+ margin-bottom: 0;
+}
+
+/* Read mode does not mount the editor that normally injects these text styles. */
+.homarr-notebook .homarr-notebook-read-mode {
+ white-space: normal;
+ overflow-wrap: break-word;
+}
+
+.homarr-notebook .ProseMirror pre {
+ white-space: pre-wrap;
+}
+
+.homarr-notebook .tiptap :where(p, h1, h2, h3, h4, h5, h6):empty::before {
+ content: "\00a0";
+}
+
+.homarr-notebook .tiptap li > p {
+ margin: 0;
+}
diff --git a/packages/widgets/src/notebook/notebook.tsx b/packages/widgets/src/notebook/notebook.tsx
index e42be2e38..f28a3a87b 100644
--- a/packages/widgets/src/notebook/notebook.tsx
+++ b/packages/widgets/src/notebook/notebook.tsx
@@ -4,7 +4,6 @@ import type { MouseEvent as ReactMouseEvent } from "react";
import { useCallback, useEffect, useId, useRef, useState } from "react";
import {
ActionIcon,
- Box,
Button,
ColorPicker,
ColorSwatch,
@@ -12,9 +11,7 @@ import {
Popover,
ScrollArea,
Stack,
- Text,
TextInput,
- Tooltip,
useMantineColorScheme,
useMantineTheme,
} from "@mantine/core";
@@ -62,6 +59,8 @@ import type { WidgetComponentProps } from "../definition";
import actionTargetClasses from "../common/action-target.module.css";
import { createReadOnlyTaskItemTransaction, ReadOnlyTaskItem } from "./read-only-task-item";
import { getNotebookDisplay } from "./display";
+import { getNotebookSurface, NotebookSurface, NotebookFooter } from "./surface";
+import { isSupportedAspectRatioValue } from "./sanitize-content";
import { NotebookTextDirection, setTextDirection } from "./text-direction";
import "@mantine/tiptap/styles.css";
@@ -82,6 +81,24 @@ const controlIconProps = {
stroke: 1.5,
};
+export const notebookImage = Image.extend({
+ addAttributes() {
+ return {
+ ...this.parent?.(),
+ width: { default: null },
+ aspectRatio: {
+ default: null,
+ parseHTML: (element: HTMLElement) => element.style.aspectRatio || null,
+ renderHTML: (attributes: Record<string, unknown>) => {
+ const aspectRatio = attributes.aspectRatio;
+ if (typeof aspectRatio !== "string" || !isSupportedAspectRatioValue(aspectRatio)) return {};
+ return { style: `aspect-ratio: ${aspectRatio}` };
+ },
+ },
+ };
+ },
+}).configure({ inline: true });
+
export function Notebook({
options,
setOptions,
@@ -92,7 +109,8 @@ export function Notebook({
height,
displayScale = 1,
displayMode = "compact",
-}: WidgetComponentProps<"notebook">) {
+ autoEdit = false,
+}: WidgetComponentProps<"notebook"> & { autoEdit?: boolean }) {
const [content, setContent] = useState(options.content);
const previousContentRef = useRef(options.content);
const [saveError, setSaveError] = useState<string | null>(null);
@@ -102,7 +120,7 @@ export function Notebook({
const { hasChangeAccess } = constructBoardPermissions(board, session);
const canChange = !isEditMode && hasChangeAccess;
- const [isEditing, setIsEditing] = useState(false);
+ const [isEditing, setIsEditing] = useState(autoEdit);
const canChangeRef = useRef(canChange);
const allowReadOnlyCheckRef = useRef(options.allowReadOnlyCheck);
const savingRef = useRef(false);
@@ -164,14 +182,7 @@ export function Notebook({
DetailsSummary,
DetailsContent,
Highlight.configure({ multicolor: true }),
- Image.extend({
- addAttributes() {
- return {
- ...this.parent?.(),
- width: { default: null },
- };
- },
- }).configure({ inline: true }),
+ notebookImage,
Link.configure({
openOnClick: true,
validate(url) {
@@ -323,13 +334,12 @@ export function Notebook({
[canChange, editor, isEditing],
);
- let layoutScale = 1;
- if (displayMode !== "advanced" && Number.isFinite(displayScale) && displayScale > 0) {
- layoutScale = displayScale;
- }
- const renderedWidth = width * layoutScale;
- const renderedHeight = height * layoutScale;
- const compactSurface = renderedWidth < 280 || renderedHeight < 240;
+ const { renderedWidth, renderedHeight, compactSurface, compact } = getNotebookSurface({
+ width,
+ height,
+ displayMode,
+ displayScale,
+ });
const display = getNotebookDisplay({
height: renderedHeight,
isAdvanced: displayMode === "advanced",
@@ -341,19 +351,9 @@ export function Notebook({
const showDocumentStats = display.showDocumentStats && (displayMode === "advanced" || renderedWidth >= 280);
let documentText = "";
if (showDocumentStats) documentText = editor?.getText().trim() ?? "";
- const documentStats = {
- characters: documentText.length,
- words: documentText.length === 0 ? 0 : documentText.split(/\s+/).length,
- };
return (
- <Box
- className="homarr-notebook"
- data-notebook-compact={(displayMode === "compact" && compactSurface) || undefined}
- h="100%"
- onDoubleClick={handleDoubleClick}
- style={{ display: "flex", flexDirection: "column", minHeight: 0, position: "relative" }}
- >
+ <NotebookSurface compact={compact} onDoubleClick={handleDoubleClick}>
<RichTextEditor
p={0}
mt={0}
@@ -545,36 +545,7 @@ export function Notebook({
<RichTextEditor.Content />
</ScrollArea>
</RichTextEditor>
- {(saveError || showDocumentStats) && (
- <Group
- w="100%"
- justify="flex-end"
- gap="xs"
- px={8}
- pb={4}
- style={{ flex: "0 0 auto", pointerEvents: saveError ? undefined : "none" }}
- >
- {saveError && (
- <Tooltip label={saveError} multiline>
- <Text
- size="xs"
- c="red"
- lineClamp={1}
- maw={320}
- tabIndex={0}
- aria-label={`${t("saveFailed")}. ${saveError}`}
- >
- {t("saveFailed")}
- </Text>
- </Tooltip>
- )}
- {showDocumentStats && (
- <Text size="xs" c="dimmed">
- {t("documentStats", documentStats)}
- </Text>
- )}
- </Group>
- )}
+ <NotebookFooter saveError={saveError} showDocumentStats={showDocumentStats} text={documentText} />
{canChange && (
<Stack pos="absolute" top={7} right={7} gap={7} style={{ zIndex: 1 }}>
<ActionIcon
@@ -611,7 +582,7 @@ export function Notebook({
)}
</Stack>
)}
- </Box>
+ </NotebookSurface>
);
}
diff --git a/packages/widgets/src/notebook/read-mode.tsx b/packages/widgets/src/notebook/read-mode.tsx
new file mode 100644
index 000000000..790f96e36
--- /dev/null
+++ b/packages/widgets/src/notebook/read-mode.tsx
@@ -0,0 +1,254 @@
+"use client";
+
+import type { MouseEvent as ReactMouseEvent } from "react";
+import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState } from "react";
+import { ActionIcon, Box, ScrollArea, Stack, Typography, useMantineTheme } from "@mantine/core";
+import { IconEdit } from "@tabler/icons-react";
+
+import { clientApi } from "@homarr/api/client";
+import { useSession } from "@homarr/auth/client";
+import { constructBoardPermissions } from "@homarr/auth/shared";
+import { useRequiredBoard } from "@homarr/boards/context";
+import { useI18n } from "@homarr/translation/client";
+
+import actionTargetClasses from "../common/action-target.module.css";
+import type { WidgetComponentProps } from "../definition";
+import { updateNotebookTaskChecked } from "./canonical-task";
+import { getNotebookDisplay } from "./display";
+import { getNotebookSurface, NotebookSurface, NotebookFooter } from "./surface";
+import { getNotebookText, sanitizeNotebookHtml } from "./sanitize-content";
+import "./notebook.css";
+
+const iconProps = { size: 30, stroke: 1.5 };
+
+const applyTaskInteractivity = (container: HTMLDivElement, enabled: boolean) => {
+ for (const input of container.querySelectorAll("input")) input.disabled = !enabled;
+};
+
+export const NotebookReadMode = ({
+ options,
+ setOptions,
+ isEditMode,
+ boardId,
+ itemId,
+ width,
+ height,
+ displayScale = 1,
+ displayMode = "compact",
+ onRequestEdit,
+ isLoadingEditor = false,
+}: WidgetComponentProps<"notebook"> & { onRequestEdit: () => void; isLoadingEditor?: boolean }) => {
+ const board = useRequiredBoard();
+ const { data: session } = useSession();
+ const { hasChangeAccess } = constructBoardPermissions(board, session);
+ const { primaryColor } = useMantineTheme();
+ const t = useI18n("widget.notebook");
+ const tCommon = useI18n("common");
+
+ const canChange = !isEditMode && hasChangeAccess;
+ const canCheck = canChange && options.allowReadOnlyCheck && !isLoadingEditor;
+
+ const contentRef = useRef<HTMLDivElement>(null);
+ const savingRef = useRef(false);
+ const canCheckRef = useRef(canCheck);
+ const operationTokenRef = useRef(0);
+ const renderedCanonicalRef = useRef(options.content);
+ const listenerAttachedRef = useRef(false);
+ const handlerRef = useRef<(event: Event) => void>(() => undefined);
+ const [initialHtml] = useState(() => sanitizeNotebookHtml(options.content, true));
+ const initialInnerHtml = useMemo(() => ({ __html: initialHtml }), [initialHtml]);
+ const [pendingTaskCommit, setPendingTaskCommit] = useState(false);
+ const [saveError, setSaveError] = useState<string | null>(null);
+
+ const { mutateAsync, isPending: isSaving } = clientApi.widget.notebook.updateContent.useMutation({
+ scope: { id: `notebook-content:${boardId ?? "preview"}:${itemId ?? "preview"}` },
+ });
+
+ useEffect(() => {
+ canCheckRef.current = canCheck && !isSaving;
+ }, [canCheck, isSaving]);
+
+ useLayoutEffect(() => {
+ const container = contentRef.current;
+ if (!container) return;
+ if (options.content !== renderedCanonicalRef.current) {
+ operationTokenRef.current += 1;
+ savingRef.current = false;
+ canCheckRef.current = canCheck;
+ setPendingTaskCommit(false);
+ setSaveError(null);
+ renderedCanonicalRef.current = options.content;
+ container.innerHTML = sanitizeNotebookHtml(options.content, true);
+ }
+ if (listenerAttachedRef.current) applyTaskInteractivity(container, canCheck);
+ }, [canCheck, options.content]);
+
+ useEffect(() => {
+ if (!pendingTaskCommit || options.content !== renderedCanonicalRef.current) return;
+ savingRef.current = false;
+ canCheckRef.current = canCheck;
+ setPendingTaskCommit(false);
+ }, [canCheck, options.content, pendingTaskCommit]);
+
+ const notebookText = useMemo(() => getNotebookText(options.content), [options.content]);
+
+ const handleContentChange = useCallback(
+ (event: Event) => {
+ const target = event.target;
+ if (!(target instanceof HTMLInputElement) || target.type !== "checkbox") return;
+ const container = contentRef.current;
+ const taskItem = target.closest('li[data-type="taskItem"]');
+ if (!container || !(taskItem instanceof HTMLElement)) return;
+ if (savingRef.current || !canCheckRef.current) {
+ target.checked = !target.checked;
+ return;
+ }
+ const taskIndex = Array.from(container.querySelectorAll('li[data-type="taskItem"]')).indexOf(taskItem);
+ if (taskIndex < 0) {
+ target.checked = !target.checked;
+ return;
+ }
+ const checked = target.checked;
+ const previousCanonical = renderedCanonicalRef.current;
+ const nextCanonical = updateNotebookTaskChecked(previousCanonical, taskIndex, checked);
+ taskItem.setAttribute("data-checked", String(checked));
+ if (nextCanonical === previousCanonical) return;
+ const operationToken = operationTokenRef.current;
+ renderedCanonicalRef.current = nextCanonical;
+ savingRef.current = true;
+ canCheckRef.current = false;
+ setPendingTaskCommit(true);
+ setSaveError(null);
+ void (async () => {
+ try {
+ if (boardId && itemId) await mutateAsync({ boardId, itemId, content: nextCanonical });
+ if (operationTokenRef.current !== operationToken) return;
+ setOptions({ newOptions: { content: nextCanonical } });
+ } catch {
+ if (operationTokenRef.current !== operationToken) return;
+ renderedCanonicalRef.current = previousCanonical;
+ taskItem.setAttribute("data-checked", String(!checked));
+ target.checked = !checked;
+ savingRef.current = false;
+ canCheckRef.current = canCheck;
+ setPendingTaskCommit(false);
+ setSaveError(t("saveFailed"));
+ }
+ })();
+ },
+ [boardId, canCheck, itemId, mutateAsync, setOptions, t],
+ );
+
+ useEffect(() => {
+ handlerRef.current = handleContentChange;
+ }, [handleContentChange]);
+
+ useEffect(() => {
+ const container = contentRef.current;
+ if (!container) return;
+ const listener = (event: Event) => handlerRef.current(event);
+ container.addEventListener("change", listener);
+ listenerAttachedRef.current = true;
+ applyTaskInteractivity(container, canCheck);
+ return () => {
+ container.removeEventListener("change", listener);
+ listenerAttachedRef.current = false;
+ applyTaskInteractivity(container, false);
+ };
+ }, [canCheck]);
+
+ const editBlocked = pendingTaskCommit || isSaving || isLoadingEditor;
+ const handleRequestEdit = useCallback(() => {
+ if (savingRef.current || pendingTaskCommit || isSaving || isLoadingEditor) return;
+ onRequestEdit();
+ }, [isLoadingEditor, isSaving, onRequestEdit, pendingTaskCommit]);
+
+ const handleDoubleClick = useCallback(
+ (event: ReactMouseEvent<HTMLDivElement>) => {
+ if (!canChange) return;
+ if (event.target instanceof Element && event.target.closest("button, a")) return;
+ handleRequestEdit();
+ },
+ [canChange, handleRequestEdit],
+ );
+
+ const { renderedWidth, renderedHeight, compactSurface, compact } = getNotebookSurface({
+ width,
+ height,
+ displayMode,
+ displayScale,
+ });
+ const display = getNotebookDisplay({
+ height: renderedHeight,
+ isAdvanced: displayMode === "advanced",
+ isEditing: false,
+ isSaving,
+ showToolbar: options.showToolbar,
+ });
+ const showDocumentStats = display.showDocumentStats && (displayMode === "advanced" || renderedWidth >= 280);
+ return (
+ <NotebookSurface compact={compact} onDoubleClick={handleDoubleClick}>
+ <Box
+ style={{
+ backgroundColor: "transparent",
+ border: "none",
+ borderRadius: "0.5rem",
+ display: "flex",
+ flexDirection: "column",
+ flex: "1 1 auto",
+ height: "auto",
+ minHeight: 0,
+ }}
+ >
+ <ScrollArea
+ pl={compactSurface ? 4 : 12}
+ pt={compactSurface ? 4 : 12}
+ styles={{
+ root: { flex: "1 1 auto", height: "100%", minHeight: 0 },
+ content: { height: "100%", minHeight: 0 },
+ }}
+ >
+ <Typography style={{ height: "100%" }}>
+ <div
+ style={{
+ backgroundColor: "transparent",
+ height: "100%",
+ padding: renderedHeight < 120 ? "0.25rem" : "0.5rem",
+ }}
+ >
+ <div
+ ref={contentRef}
+ className="tiptap ProseMirror homarr-notebook-read-mode"
+ style={{
+ backgroundColor: "transparent",
+ fontSize: "var(--mantine-font-size-md)",
+ height: "100%",
+ padding: "var(--mantine-spacing-md)",
+ }}
+ dangerouslySetInnerHTML={initialInnerHtml}
+ />
+ </div>
+ </Typography>
+ </ScrollArea>
+ </Box>
+ <NotebookFooter saveError={saveError} showDocumentStats={showDocumentStats} text={notebookText} />
+ {canChange && (
+ <Stack pos="absolute" top={7} right={7} gap={7} style={{ zIndex: 1 }}>
+ <ActionIcon
+ className={`homarr-notebook-action ${actionTargetClasses.root}`}
+ title={tCommon("action.edit")}
+ aria-label={tCommon("action.edit")}
+ color={primaryColor}
+ variant="light"
+ size={30}
+ disabled={editBlocked}
+ loading={isLoadingEditor}
+ onClick={handleRequestEdit}
+ >
+ <IconEdit {...iconProps} />
+ </ActionIcon>
+ </Stack>
+ )}
+ </NotebookSurface>
+ );
+};
diff --git a/packages/widgets/src/notebook/sanitize-content.spec.ts b/packages/widgets/src/notebook/sanitize-content.spec.ts
new file mode 100644
index 000000000..bc7a2331b
--- /dev/null
+++ b/packages/widgets/src/notebook/sanitize-content.spec.ts
@@ -0,0 +1,15 @@
+import { expect, test } from "vitest";
+
+import { sanitizeNotebookHtml } from "./sanitize-content";
+
+test("preserves saved table column widths without allowing executable content or arbitrary CSS", () => {
+ const html = sanitizeNotebookHtml(
+ '<table style="min-width: 400px; position: fixed"><colgroup><col style="width: 100px"><col style="width: 300px"></colgroup><tbody><tr><td><p>Narrow</p></td><td><p>Wide</p><img src="x" onerror="alert(1)"></td></tr></tbody></table>',
+ );
+ const holder = document.createElement("div");
+ holder.innerHTML = html;
+ expect(holder.querySelector("table")?.style.minWidth).toBe("400px");
+ expect([...holder.querySelectorAll("col")].map((col) => col.style.width)).toEqual(["100px", "300px"]);
+ expect(holder.querySelector("table")?.style.position).toBe("");
+ expect(holder.querySelector("img")?.hasAttribute("onerror")).toBe(false);
+});
diff --git a/packages/widgets/src/notebook/sanitize-content.ts b/packages/widgets/src/notebook/sanitize-content.ts
new file mode 100644
index 000000000..ac1ed6d0c
--- /dev/null
+++ b/packages/widgets/src/notebook/sanitize-content.ts
@@ -0,0 +1,222 @@
+import { addHook, removeHook, sanitize } from "isomorphic-dompurify";
+import type { Config, UponSanitizeAttributeHook, UponSanitizeElementHook } from "isomorphic-dompurify";
+
+const textAlignValuePattern = /^(?:left|right|center|justify)$/;
+const aspectRatioValuePattern = /^\s*(\d+(?:\.\d+)?)\s*\/\s*(\d+(?:\.\d+)?)\s*$/;
+
+export const isSupportedAspectRatioValue = (value: string) => {
+ const match = aspectRatioValuePattern.exec(value);
+ if (!match) return false;
+ const width = Number(match[1]);
+ const height = Number(match[2]);
+ return Number.isFinite(width) && Number.isFinite(height) && width > 0 && height > 0;
+};
+
+const isValidColorValue = (node: Element, property: string, value: string) => {
+ if (value.includes("var(") || value.includes("url(")) return false;
+ const probe = node.ownerDocument.createElement("span");
+ probe.style.setProperty(property, value);
+ return probe.style.getPropertyValue(property) !== "";
+};
+
+const filterSupportedStyles = (node: Element, style: string) => {
+ const declarations: string[] = [];
+ for (const declaration of style.split(";")) {
+ const separator = declaration.indexOf(":");
+ if (separator === -1) continue;
+ const property = declaration.slice(0, separator).trim().toLowerCase();
+ const value = declaration.slice(separator + 1).trim();
+ if (!value) continue;
+ if ((node.nodeName === "TABLE" || node.nodeName === "COL") && (property === "width" || property === "min-width")) {
+ if (/^\d+(?:\.\d+)?px$/.test(value)) declarations.push(`${property}: ${value}`);
+ continue;
+ }
+ if (property === "text-align" && textAlignValuePattern.test(value)) {
+ declarations.push(`${property}: ${value}`);
+ continue;
+ }
+ if (property === "aspect-ratio") {
+ if (node.nodeName === "IMG" && isSupportedAspectRatioValue(value)) declarations.push(`${property}: ${value}`);
+ continue;
+ }
+ if ((property === "color" || property === "background-color") && isValidColorValue(node, property, value)) {
+ declarations.push(`${property}: ${value}`);
+ }
+ }
+ return declarations.join("; ");
+};
+
+const requiredDataAttributeValues: Record<string, (node: Element, value: string) => boolean> = {
+ "data-type": (_node, value) => value === "taskList" || value === "taskItem" || value === "detailsContent",
+ "data-checked": (_node, value) => value === "true" || value === "false" || value === "",
+ "data-color": (node, value) => isValidColorValue(node, "color", value),
+};
+
+const attributeHook: UponSanitizeAttributeHook = (node, event) => {
+ if (event.attrName === "style") {
+ const filtered = filterSupportedStyles(node, event.attrValue);
+ if (filtered.length === 0) {
+ event.keepAttr = false;
+ return;
+ }
+ event.attrValue = filtered;
+ return;
+ }
+ if (!event.attrName.startsWith("data-")) return;
+ const isRequiredDataAttribute = requiredDataAttributeValues[event.attrName];
+ if (!isRequiredDataAttribute || !isRequiredDataAttribute(node, event.attrValue)) {
+ event.keepAttr = false;
+ }
+};
+
+const elementHook: UponSanitizeElementHook = (node, event) => {
+ if (event.tagName === "a") {
+ const element = node as Element;
+ if (element.getAttribute("target") !== "_blank") return;
+ const rel = new Set((element.getAttribute("rel") ?? "").split(/\s+/).filter(Boolean));
+ rel.delete("opener");
+ rel.add("noopener");
+ rel.add("noreferrer");
+ element.setAttribute("rel", [...rel].join(" "));
+ return;
+ }
+ if (event.tagName === "input") {
+ const element = node as Element;
+ const isTaskCheckbox =
+ element.getAttribute("type") === "checkbox" && element.closest('li[data-type="taskItem"]') !== null;
+ if (!isTaskCheckbox) element.parentNode?.removeChild(element);
+ }
+};
+
+const notebookSanitizeConfig: Config = {
+ ALLOWED_TAGS: [
+ "a",
+ "b",
+ "blockquote",
+ "br",
+ "code",
+ "col",
+ "colgroup",
+ "del",
+ "details",
+ "div",
+ "em",
+ "h1",
+ "h2",
+ "h3",
+ "h4",
+ "h5",
+ "h6",
+ "hr",
+ "i",
+ "img",
+ "input",
+ "label",
+ "li",
+ "mark",
+ "ol",
+ "p",
+ "pre",
+ "s",
+ "span",
+ "strong",
+ "sub",
+ "summary",
+ "sup",
+ "table",
+ "tbody",
+ "td",
+ "tfoot",
+ "th",
+ "thead",
+ "tr",
+ "u",
+ "ul",
+ ],
+ ADD_ATTR: ["data-type", "data-color", "data-checked", "target", "colwidth"],
+ FORBID_ATTR: ["class", "id", "name"],
+ ALLOW_DATA_ATTR: false,
+ ALLOW_ARIA_ATTR: false,
+};
+
+const runSanitize = <TResult>(callback: () => TResult): TResult => {
+ addHook("uponSanitizeElement", elementHook);
+ addHook("uponSanitizeAttribute", attributeHook);
+ try {
+ return callback();
+ } finally {
+ removeHook("uponSanitizeElement", elementHook);
+ removeHook("uponSanitizeAttribute", attributeHook);
+ }
+};
+
+const sanitizeFragment = (html: string) =>
+ runSanitize(() => sanitize(html, { ...notebookSanitizeConfig, RETURN_DOM_FRAGMENT: true }));
+
+export const sanitizeNotebookHtml = (html: string, disableTasks = false) => {
+ const fragment = sanitizeFragment(html);
+ for (const input of fragment.querySelectorAll("input")) {
+ const task = input.closest('li[data-type="taskItem"]')?.cloneNode(true) as Element | undefined;
+ task?.querySelectorAll('label, ul[data-type="taskList"]').forEach((element) => element.remove());
+ const label = task?.textContent?.replace(/\s+/g, " ").trim() || "Task item";
+ input.setAttribute("aria-label", label);
+ if (disableTasks) input.disabled = true;
+ }
+ const holder = fragment.ownerDocument.createElement("div");
+ holder.append(fragment);
+ return holder.innerHTML;
+};
+
+const blockTagNames = new Set([
+ "P",
+ "H1",
+ "H2",
+ "H3",
+ "H4",
+ "H5",
+ "H6",
+ "BLOCKQUOTE",
+ "PRE",
+ "UL",
+ "OL",
+ "LI",
+ "TABLE",
+ "TR",
+ "TD",
+ "TH",
+ "HR",
+ "DETAILS",
+ "SUMMARY",
+]);
+
+const isBlockNode = (node: Node) => {
+ if (node.nodeType !== 1) return false;
+ if (node.nodeName === "DIV") return (node as Element).getAttribute("data-type") === "detailsContent";
+ return blockTagNames.has(node.nodeName);
+};
+
+const collectText = (node: Node, state: { seen: boolean }, segments: string[]) => {
+ if (node.nodeType === 3) {
+ segments.push(node.textContent ?? "");
+ return;
+ }
+ if (node.nodeType !== 1) {
+ node.childNodes.forEach((child) => collectText(child, state, segments));
+ return;
+ }
+ if (node.nodeName === "BR") {
+ segments.push("\n");
+ return;
+ }
+ const isBlock = isBlockNode(node);
+ if (isBlock && state.seen) segments.push("\n\n");
+ if (isBlock) state.seen = true;
+ node.childNodes.forEach((child) => collectText(child, state, segments));
+};
+
+export const getNotebookText = (html: string) => {
+ const fragment = sanitizeFragment(html);
+ const segments: string[] = [];
+ collectText(fragment, { seen: false }, segments);
+ return segments.join("").trim();
+};
diff --git a/packages/widgets/src/notebook/surface.tsx b/packages/widgets/src/notebook/surface.tsx
new file mode 100644
index 000000000..2cd272ec4
--- /dev/null
+++ b/packages/widgets/src/notebook/surface.tsx
@@ -0,0 +1,80 @@
+import type { ComponentProps, PropsWithChildren } from "react";
+import { Box, Group, Text, Tooltip } from "@mantine/core";
+
+import { useI18n } from "@homarr/translation/client";
+
+export const getNotebookSurface = ({
+ width,
+ height,
+ displayMode,
+ displayScale,
+}: {
+ width: number;
+ height: number;
+ displayMode?: "compact" | "advanced";
+ displayScale: number;
+}) => {
+ let scale = 1;
+ if (displayMode !== "advanced" && Number.isFinite(displayScale) && displayScale > 0) scale = displayScale;
+ const renderedWidth = width * scale;
+ const renderedHeight = height * scale;
+ const compactSurface = renderedWidth < 280 || renderedHeight < 240;
+ return { renderedWidth, renderedHeight, compactSurface, compact: displayMode === "compact" && compactSurface };
+};
+
+export const NotebookSurface = ({
+ compact,
+ onDoubleClick,
+ children,
+}: PropsWithChildren<{
+ compact: boolean;
+ onDoubleClick: ComponentProps<"div">["onDoubleClick"];
+}>) => (
+ <Box
+ className="homarr-notebook"
+ data-notebook-compact={compact || undefined}
+ h="100%"
+ onDoubleClick={onDoubleClick}
+ style={{ display: "flex", flexDirection: "column", minHeight: 0, position: "relative" }}
+ >
+ {children}
+ </Box>
+);
+
+export const NotebookFooter = ({
+ saveError,
+ showDocumentStats,
+ text,
+}: {
+ saveError: string | null;
+ showDocumentStats: boolean;
+ text: string;
+}) => {
+ const t = useI18n("widget.notebook");
+ if (!saveError && !showDocumentStats) return null;
+ const trimmed = text.trim();
+ const stats = { characters: trimmed.length, words: trimmed.length === 0 ? 0 : trimmed.split(/\s+/).length };
+ return (
+ <Group
+ w="100%"
+ justify="flex-end"
+ gap="xs"
+ px={8}
+ pb={4}
+ style={{ flex: "0 0 auto", pointerEvents: saveError ? undefined : "none" }}
+ >
+ {saveError && (
+ <Tooltip label={saveError} multiline>
+ <Text size="xs" c="red" lineClamp={1} maw={320} tabIndex={0} aria-label={`${t("saveFailed")}. ${saveError}`}>
+ {t("saveFailed")}
+ </Text>
+ </Tooltip>
+ )}
+ {showDocumentStats && (
+ <Text size="xs" c="dimmed">
+ {t("documentStats", stats)}
+ </Text>
+ )}
+ </Group>
+ );
+};
diff --git a/packages/widgets/src/refetch-intervals.ts b/packages/widgets/src/refetch-intervals.ts
index 6a2495b12..e7751e1cb 100644
--- a/packages/widgets/src/refetch-intervals.ts
+++ b/packages/widgets/src/refetch-intervals.ts
@@ -24,6 +24,7 @@ export const widgetQueryRefetchIntervals = [
},
{ queryKey: [["widget", "airQuality", "atLocation"]], intervalSeconds: 900 },
{ queryKey: [["widget", "immich", "getAlbum"]], intervalSeconds: null },
+ { queryKey: [["widget", "immich", "getAlbumPreview"]], intervalSeconds: null },
{ queryKey: [["widget", "immich", "getServerStats"]], intervalSeconds: null },
{ queryKey: [["widget", "immich", "getAlbums"]], intervalSeconds: null },
{ queryKey: [["widget", "indexerManager"]], intervalSeconds: null },
diff --git a/packages/widgets/src/releases/index.ts b/packages/widgets/src/releases/index.ts
index b19e719c5..1f2a33391 100644
--- a/packages/widgets/src/releases/index.ts
+++ b/packages/widgets/src/releases/index.ts
@@ -16,6 +16,7 @@ import {
} from "./release-options";
export const { definition, componentLoader } = createWidgetDefinition("releases", {
+ deferUntilVisible: true,
supportsAdvancedFocus: true,
icon: IconRocket,
queryKeys: [[["widget", "releases", "getLatest"]], [["widget", "releases", "getServiceVersions"]]],
diff --git a/packages/widgets/src/smart-home/entity-state/component.tsx b/packages/widgets/src/smart-home/entity-state/component.tsx
index 8247f19cb..2a04c9efd 100644
--- a/packages/widgets/src/smart-home/entity-state/component.tsx
+++ b/packages/widgets/src/smart-home/entity-state/component.tsx
@@ -2,6 +2,7 @@
import { useCallback } from "react";
import { Badge, Center, Group, Stack, Text, UnstyledButton } from "@mantine/core";
+import { useCallbackRef } from "@mantine/hooks";
import { IconBinaryTree } from "@tabler/icons-react";
import { clientApi } from "@homarr/api/client";
@@ -74,6 +75,7 @@ export default function SmartHomeEntityStateWidget({
integrationId,
});
}, [integrationId, isActionable, mutate, options.entityId]);
+ const handleSpotlightClick = useCallbackRef(handleClick);
useRegisterSpotlightContextActions(
`smartHome-entityState-${options.entityId}`,
@@ -86,14 +88,14 @@ export default function SmartHomeEntityStateWidget({
return {
type: "javaScript",
onSelect() {
- handleClick();
+ handleSpotlightClick();
},
};
},
disabled: !isActionable,
},
],
- [handleClick, isActionable, options.displayName, options.entityId],
+ [handleClick, handleSpotlightClick, isActionable, options.displayName, options.entityId],
);
if (entityError && entity === undefined) throw entityError;
diff --git a/packages/widgets/src/smart-home/execute-automation/component.tsx b/packages/widgets/src/smart-home/execute-automation/component.tsx
index cf2e97e50..6589f7193 100644
--- a/packages/widgets/src/smart-home/execute-automation/component.tsx
+++ b/packages/widgets/src/smart-home/execute-automation/component.tsx
@@ -12,7 +12,7 @@ import {
UnstyledButton,
VisuallyHidden,
} from "@mantine/core";
-import { useDisclosure, useTimeout } from "@mantine/hooks";
+import { useCallbackRef, useDisclosure, useTimeout } from "@mantine/hooks";
import { IconAutomation, IconCheck } from "@tabler/icons-react";
import { clientApi } from "@homarr/api/client";
@@ -62,6 +62,7 @@ export default function SmartHomeTriggerAutomationWidget({
// The mutation exposes the error below and remains retryable.
}
}, [canInteract, integrationId, isEditMode, isPending, mutateAsync, options.automationId]);
+ const handleSpotlightClick = useCallbackRef(handleClick);
const t = useI18n("widget.smartHome-executeAutomation");
const locale = useCurrentIntlLocale();
@@ -77,14 +78,22 @@ export default function SmartHomeTriggerAutomationWidget({
type: "javaScript",
// eslint-disable-next-line no-restricted-syntax
async onSelect() {
- await handleClick();
+ await handleSpotlightClick();
},
};
},
disabled: !integrationId || !canInteract || isPending,
},
],
- [canInteract, handleClick, integrationId, isPending, options.automationId, options.displayName],
+ [
+ canInteract,
+ handleClick,
+ handleSpotlightClick,
+ integrationId,
+ isPending,
+ options.automationId,
+ options.displayName,
+ ],
);
const isTiny = isSmartHomeTiny(width, height);
diff --git a/packages/widgets/src/thingport/featured-model/index.ts b/packages/widgets/src/thingport/featured-model/index.ts
index e85f0ff7f..9a7ee86d3 100644
--- a/packages/widgets/src/thingport/featured-model/index.ts
+++ b/packages/widgets/src/thingport/featured-model/index.ts
@@ -6,6 +6,7 @@ import { createWidgetDefinition, matchesWidgetRuntimeQuery } from "../../definit
import { optionsBuilder } from "../../options";
export const { definition, componentLoader } = createWidgetDefinition("thingport-featuredModel", {
+ deferUntilVisible: true,
icon: IconRotate360,
supportsAdvancedFocus: false,
queryKey: [["widget", "thingport", "getFeaturedModel"]],
diff --git a/packages/widgets/src/wazuh/views/agents.tsx b/packages/widgets/src/wazuh/views/agents.tsx
index f3b588354..b0a50c6ef 100644
--- a/packages/widgets/src/wazuh/views/agents.tsx
+++ b/packages/widgets/src/wazuh/views/agents.tsx
@@ -302,7 +302,7 @@ export function WazuhAgentsView({
];
return all.filter(({ visible }) => visible).map(({ visible: _visible, ...column }) => column);
}, [links, newestVersion, showGroups, showIp, showOs, showVersion, t, width]);
- const { effectiveColumns, storeKey } = usePersistedTableLayout({
+ const { effectiveColumns, storeKey, onColumnLayoutChange } = usePersistedTableLayout({
columns,
columnAccessors: agentColumnAccessors,
columnOrder: options.columnOrder,
@@ -417,6 +417,7 @@ export function WazuhAgentsView({
records={visibleAgents}
columns={effectiveColumns}
storeColumnsKey={storeKey}
+ onColumnLayoutChange={onColumnLayoutChange}
sortStatus={sortStatus}
onSortStatusChange={isEditMode ? undefined : setSortStatus}
idAccessor="id"