feat(boards): add responsive layout system (#2271)

apps/nextjs/src/app/[locale]/boards/(content)/_client.tsx

@@ -5,7 +5,7 @@ import { Box, LoadingOverlay, Stack } from "@mantine/core";
 
 import type { RouterOutputs } from "@homarr/api";
 import { clientApi } from "@homarr/api/client";
-import { useRequiredBoard } from "@homarr/boards/context";
+import { useCurrentLayout, useRequiredBoard } from "@homarr/boards/context";
 
 import { BoardCategorySection } from "~/components/board/sections/category-section";
 import { BoardEmptySection } from "~/components/board/sections/empty-section";
@@ -43,6 +43,7 @@ export const useUpdateBoard = () => {
 
 export const ClientBoard = () => {
   const board = useRequiredBoard();
+  const currentLayoutId = useCurrentLayout();
   const isReady = useIsBoardReady();
 
   const fullWidthSortedSections = board.sections
@@ -63,9 +64,10 @@ export const ClientBoard = () => {
       <Stack ref={ref} h="100%" style={{ visibility: isReady ? "visible" : "hidden" }}>
         {fullWidthSortedSections.map((section) =>
           section.kind === "empty" ? (
-            <BoardEmptySection key={section.id} section={section} />
+            // Unique keys per layout to always reinitialize the gridstack
+            <BoardEmptySection key={`${currentLayoutId}-${section.id}`} section={section} />
           ) : (
-            <BoardCategorySection key={section.id} section={section} />
+            <BoardCategorySection key={`${currentLayoutId}-${section.id}`} section={section} />
           ),
         )}
       </Stack>

apps/nextjs/src/app/[locale]/boards/(content)/_creator.tsx

@@ -13,7 +13,7 @@ import { getI18n } from "@homarr/translation/server";
 import { createMetaTitle } from "~/metadata";
 import { createBoardLayout } from "../_layout-creator";
 import type { Board } from "../_types";
-import { ClientBoard } from "./_client";
+import { DynamicClientBoard } from "./_dynamic-client";
 import { BoardContentHeaderActions } from "./_header-actions";
 
 export type Params = Record<string, unknown>;
@@ -37,7 +37,7 @@ export const createBoardContentPage = <TParams extends Record<string, unknown>>(
 
       return (
         <IntegrationProvider integrations={integrations}>
-          <ClientBoard />
+          <DynamicClientBoard />
         </IntegrationProvider>
       );
     },

apps/nextjs/src/app/[locale]/boards/(content)/_dynamic-client.tsx

@@ -0,0 +1,7 @@
+"use client";
+
+import dynamic from "next/dynamic";
+
+export const DynamicClientBoard = dynamic(() => import("./_client").then((mod) => mod.ClientBoard), {
+  ssr: false,
+});

apps/nextjs/src/app/[locale]/boards/[name]/settings/_layout.tsx

@@ -1,43 +1,109 @@
 "use client";
 
-import { Button, Grid, Group, Input, Slider, Stack } from "@mantine/core";
+import { Button, Fieldset, Grid, Group, Input, NumberInput, Slider, Stack, Text, TextInput } from "@mantine/core";
 
+import { clientApi } from "@homarr/api/client";
+import { createId } from "@homarr/db/client";
 import { useZodForm } from "@homarr/form";
 import { useI18n } from "@homarr/translation/client";
 import { validation } from "@homarr/validation";
 
 import type { Board } from "../../_types";
-import { useSavePartialSettingsMutation } from "./_shared";
 
 interface Props {
   board: Board;
 }
 export const LayoutSettingsContent = ({ board }: Props) => {
   const t = useI18n();
-  const { mutate: savePartialSettings, isPending } = useSavePartialSettingsMutation(board);
-  const form = useZodForm(validation.board.savePartialSettings.pick({ columnCount: true }).required(), {
+  const utils = clientApi.useUtils();
+  const { mutate: saveLayouts, isPending } = clientApi.board.saveLayouts.useMutation({
+    onSettled() {
+      void utils.board.getBoardByName.invalidate({ name: board.name });
+      void utils.board.getHomeBoard.invalidate();
+    },
+  });
+  const form = useZodForm(validation.board.saveLayouts.omit({ id: true }).required(), {
     initialValues: {
-      columnCount: board.columnCount,
+      layouts: board.layouts,
     },
   });
 
   return (
     <form
       onSubmit={form.onSubmit((values) => {
-        savePartialSettings({
+        saveLayouts({
           id: board.id,
           ...values,
         });
       })}
     >
       <Stack>
-        <Grid>
-          <Grid.Col span={{ sm: 12, md: 6 }}>
-            <Input.Wrapper label={t("board.field.columnCount.label")}>
-              <Slider mt="xs" min={1} max={24} step={1} {...form.getInputProps("columnCount")} />
-            </Input.Wrapper>
-          </Grid.Col>
-        </Grid>
+        <Stack gap="sm">
+          <Group justify="space-between" align="center">
+            <Text fw={500}>{t("board.setting.section.layout.responsive.title")}</Text>
+            <Button
+              variant="subtle"
+              onClick={() => {
+                form.setValues({
+                  layouts: [
+                    ...form.values.layouts,
+                    {
+                      id: createId(),
+                      name: "",
+                      columnCount: 10,
+                      breakpoint: 0,
+                    },
+                  ],
+                });
+              }}
+            >
+              {t("board.setting.section.layout.responsive.action.add")}
+            </Button>
+          </Group>
+
+          {form.values.layouts.map((layout, index) => (
+            <Fieldset key={layout.id} legend={layout.name} bg="transparent">
+              <Grid>
+                <Grid.Col span={{ sm: 12, md: 6 }}>
+                  <TextInput {...form.getInputProps(`layouts.${index}.name`)} label={t("layout.field.name.label")} />
+                </Grid.Col>
+
+                <Grid.Col span={{ sm: 12, md: 6 }}>
+                  <Input.Wrapper label={t("layout.field.columnCount.label")}>
+                    <Slider mt="xs" min={1} max={24} step={1} {...form.getInputProps(`layouts.${index}.columnCount`)} />
+                  </Input.Wrapper>
+                </Grid.Col>
+
+                <Grid.Col span={{ sm: 12, md: 6 }}>
+                  <NumberInput
+                    {...form.getInputProps(`layouts.${index}.breakpoint`)}
+                    label={t("layout.field.breakpoint.label")}
+                    description={t("layout.field.breakpoint.description")}
+                  />
+                </Grid.Col>
+              </Grid>
+              {form.values.layouts.length >= 2 && (
+                <Group justify="end">
+                  <Button
+                    variant="subtle"
+                    onClick={() => {
+                      form.setValues((previous) =>
+                        previous.layouts !== undefined && previous.layouts.length >= 2
+                          ? {
+                              layouts: form.values.layouts.filter((filteredLayout) => filteredLayout.id !== layout.id),
+                            }
+                          : previous,
+                      );
+                    }}
+                  >
+                    {t("common.action.remove")}
+                  </Button>
+                </Group>
+              )}
+            </Fieldset>
+          ))}
+        </Stack>
+
         <Group justify="end">
           <Button type="submit" loading={isPending} color="teal">
             {t("common.action.saveChanges")}

apps/nextjs/src/app/[locale]/boards/_types.ts

@@ -3,10 +3,14 @@ import type { WidgetKind } from "@homarr/definitions";
 
 export type Board = RouterOutputs["board"]["getHomeBoard"];
 export type Section = Board["sections"][number];
-export type Item = Section["items"][number];
+export type Item = Board["items"][number];
+export type ItemLayout = Item["layouts"][number];
+export type SectionItem = Omit<Item, "layouts"> & ItemLayout & { type: "item" };
 
 export type CategorySection = Extract<Section, { kind: "category" }>;
 export type EmptySection = Extract<Section, { kind: "empty" }>;
 export type DynamicSection = Extract<Section, { kind: "dynamic" }>;
+export type DynamicSectionLayout = DynamicSection["layouts"][number];
+export type DynamicSectionItem = Omit<DynamicSection, "layouts"> & DynamicSectionLayout & { type: "section" };
 
 export type ItemOfKind<TKind extends WidgetKind> = Extract<Item, { kind: TKind }>;