Merge pull request 'UI/install: bootstrap visuals for {createImage, Installer}' (#4605) from install-ui into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4605
2025-08-05 17:34:14 +00:00
parent 73ab4d2a6e 9e43285ba8
commit 220839598d
9 changed files with 536 additions and 55 deletions
--- a/pkgs/clan-app/ui/src/components/Alert/Alert.tsx
+++ b/pkgs/clan-app/ui/src/components/Alert/Alert.tsx
@@ -4,11 +4,12 @@ import Icon, { IconVariant } from "@/src/components/Icon/Icon";
 import { Typography } from "@/src/components/Typography/Typography";
 import { Button } from "@kobalte/core/button";
 import { Alert as KAlert } from "@kobalte/core/alert";
+import { Show } from "solid-js";

 export interface AlertProps {
  type: "success" | "error" | "warning" | "info";
  title: string;
-  description: string;
+  description?: string;
  icon?: IconVariant;
  onDismiss?: () => void;
 }
@@ -25,9 +26,11 @@ export const Alert = (props: AlertProps) => (
      <Typography hierarchy="body" size="default" weight="bold" color="inherit">
        {props.title}
      </Typography>
-      <Typography hierarchy="body" size="xs" color="inherit">
-        {props.description}
-      </Typography>
+      <Show when={props.description}>
+        <Typography hierarchy="body" size="xs" color="inherit">
+          {props.description}
+        </Typography>
+      </Show>
    </div>
    {props.onDismiss && (
      <Button
--- a/pkgs/clan-app/ui/src/components/LoadingBar/LoadingBar.tsx
+++ b/pkgs/clan-app/ui/src/components/LoadingBar/LoadingBar.tsx
@@ -1,3 +1,8 @@
+import { JSX } from "solid-js";
 import styles from "./LoadingBar.module.css";
+import cx from "classnames";

-export const LoadingBar = () => <div class={styles.loading_bar} />;
+export type LoadingBarProps = JSX.HTMLAttributes<HTMLDivElement> & {};
+export const LoadingBar = (props: LoadingBarProps) => (
+  <div {...props} class={cx(styles.loading_bar, props.class)} />
+);
--- a/pkgs/clan-app/ui/src/components/Modal/Modal.module.css
+++ b/pkgs/clan-app/ui/src/components/Modal/Modal.module.css
@@ -1,6 +1,6 @@
 .modal_content {
  @apply min-w-[320px] max-w-[512px];
-  @apply rounded-md;
+  @apply rounded-md overflow-hidden;

  /* todo replace with a theme() color */
  box-shadow: 0.1875rem 0.1875rem 0 0 rgba(145, 172, 175, 0.32);
@@ -23,6 +23,10 @@

 .modal_body {
  @apply rounded-md p-6 pt-4 bg-def-1;
+
+  &[data-no-padding] {
+    @apply p-0;
+  }
 }

 .header_divider {
--- a/pkgs/clan-app/ui/src/components/Modal/Modal.tsx
+++ b/pkgs/clan-app/ui/src/components/Modal/Modal.tsx
@@ -1,9 +1,10 @@
-import { createSignal, JSX, Show } from "solid-js";
+import { Component, createSignal, JSX, Show } from "solid-js";
 import { Dialog as KDialog } from "@kobalte/core/dialog";
 import styles from "./Modal.module.css";
 import { Typography } from "../Typography/Typography";
 import Icon from "../Icon/Icon";
 import cx from "classnames";
+import { Dynamic } from "solid-js/web";

 export interface ModalContext {
  close(): void;
@@ -16,7 +17,8 @@ export interface ModalProps {
  children: (ctx: ModalContext) => JSX.Element;
  mount?: Node;
  class?: string;
-  metaHeader?: () => JSX.Element;
+  metaHeader?: Component;
+  disablePadding?: boolean;
 }

 export const Modal = (props: ModalProps) => {
@@ -44,15 +46,17 @@ export const Modal = (props: ModalProps) => {
              <Icon icon="Close" size="0.75rem" />
            </KDialog.CloseButton>
          </div>
-          <Show when={props.metaHeader?.()}>
+          <Show when={props.metaHeader}>
            {(metaHeader) => (
              <>
-                {metaHeader()}
+                <div class="flex h-9 items-center px-6 py-2">
+                  <Dynamic component={metaHeader()} />
+                </div>
                <div class={styles.header_divider} />
              </>
            )}
          </Show>
-          <div class={styles.modal_body}>
+          <div class={styles.modal_body} data-no-padding={props.disablePadding}>
            {props.children({
              close: () => {
                setOpen(false);
--- a/pkgs/clan-app/ui/src/workflows/Install/Install.stories.tsx
+++ b/pkgs/clan-app/ui/src/workflows/Install/Install.stories.tsx
@@ -38,3 +38,66 @@ export const CreateInstallerDisk: Story = {
    initialStep: "create:disk",
  },
 };
+export const CreateInstallerProgress: Story = {
+  description: "Showed while the USB stick is being flashed",
+  args: {
+    machineName: "Test Machine",
+    initialStep: "create:progress",
+  },
+};
+export const CreateInstallerDone: Story = {
+  description: "Installation done step",
+  args: {
+    machineName: "Test Machine",
+    initialStep: "create:done",
+  },
+};
+export const InstallConfigureAddress: Story = {
+  description: "Installation configure address step",
+  args: {
+    machineName: "Test Machine",
+    initialStep: "install:address",
+  },
+};
+export const InstallCheckHardware: Story = {
+  description: "Installation check hardware step",
+  args: {
+    machineName: "Test Machine",
+    initialStep: "install:check-hardware",
+  },
+};
+export const InstallSelectDisk: Story = {
+  description: "Select disk to install the system on",
+  args: {
+    machineName: "Test Machine",
+    initialStep: "install:disk",
+  },
+};
+export const InstallVars: Story = {
+  description: "Fill required credentials and data for the installation",
+  args: {
+    machineName: "Test Machine",
+    initialStep: "install:data",
+  },
+};
+export const InstallSummary: Story = {
+  description: "Summary of the installation steps",
+  args: {
+    machineName: "Test Machine",
+    initialStep: "install:summary",
+  },
+};
+export const InstallProgress: Story = {
+  description: "Shown while the installation is in progress",
+  args: {
+    machineName: "Test Machine",
+    initialStep: "install:progress",
+  },
+};
+export const InstallDone: Story = {
+  description: "Shown after the installation is done",
+  args: {
+    machineName: "Test Machine",
+    initialStep: "install:done",
+  },
+};
--- a/pkgs/clan-app/ui/src/workflows/Install/install.tsx
+++ b/pkgs/clan-app/ui/src/workflows/Install/install.tsx
@@ -55,6 +55,16 @@ export const InstallModal = (props: InstallModalProps) => {
    { initialStep: props.initialStep || "init" },
  );

+  const MetaHeader = () => {
+    // @ts-expect-error some steps might not have
+    const HeaderComponent = () => stepper.currentStep()?.title;
+    return (
+      <Show when={HeaderComponent()}>
+        {(C) => <Dynamic component={C()} machineName={props.machineName} />}
+      </Show>
+    );
+  };
+
  return (
    <StepperProvider stepper={stepper}>
      <Modal
@@ -62,17 +72,10 @@ export const InstallModal = (props: InstallModalProps) => {
        onClose={() => {
          console.log("Install aborted");
        }}
-        metaHeader={() => {
-          // @ts-expect-error some steps might not have a title
-          const HeaderComponent = stepper.currentStep()?.title;
-          return (
-            <Show when={HeaderComponent}>
-              {(C) => (
-                <Dynamic component={C()} machineName={props.machineName} />
-              )}
-            </Show>
-          );
-        }}
+        // @ts-expect-error some steps might not have
+        metaHeader={stepper.currentStep()?.title ? <MetaHeader /> : undefined}
+        // @ts-expect-error some steps might not have
+        disablePadding={stepper.currentStep()?.isSplash}
      >
        {(ctx) => <InstallStepper />}
      </Modal>
--- a/pkgs/clan-app/ui/src/workflows/Install/steps/createInstaller.tsx
+++ b/pkgs/clan-app/ui/src/workflows/Install/steps/createInstaller.tsx
@@ -15,6 +15,8 @@ import { BackButton, NextButton, StepFooter, StepLayout } from "../../Steps";
 import { Typography } from "@/src/components/Typography/Typography";
 import { Alert } from "@/src/components/Alert/Alert";
 import { LoadingBar } from "@/src/components/LoadingBar/LoadingBar";
+import { Button } from "@/src/components/Button/Button";
+import Icon from "@/src/components/Icon/Icon";

 const Prose = () => (
  <StepLayout
@@ -26,7 +28,9 @@ const Prose = () => (
              hierarchy="label"
              size="xs"
              weight="medium"
-              color="inherit"
+              color="quaternary"
+              family="mono"
+              inverted
            >
              Create a portable installer
            </Typography>
@@ -35,6 +39,7 @@ const Prose = () => (
              size="default"
              weight="bold"
              color="inherit"
+              class="text-balance"
            >
              Grab a disposable USB stick and plug it in
            </Typography>
@@ -57,16 +62,9 @@ const Prose = () => (

 const CreateHeader = (props: { machineName: string }) => {
  return (
-    <div class="px-6 py-2">
-      <Typography
-        hierarchy="label"
-        size="default"
-        family="mono"
-        weight="medium"
-      >
-        Create installer
-      </Typography>
-    </div>
+    <Typography hierarchy="label" size="default" family="mono" weight="medium">
+      Create installer
+    </Typography>
  );
 };

@@ -246,6 +244,7 @@ const ChooseDisk = () => {
              </Field>
              <Alert
                type="error"
+                icon="Info"
                title="You're about to format this drive"
                description="It will erase all existing data on the target device"
              />
@@ -265,8 +264,55 @@ const ChooseDisk = () => {

 const FlashProgress = () => {
  return (
-    <div>
-      <LoadingBar />
+    <div class="flex h-60 w-full flex-col items-center justify-end bg-inv-4">
+      <div class="mb-6 flex w-full max-w-md flex-col items-center gap-3 fg-inv-1">
+        <Typography
+          hierarchy="title"
+          size="default"
+          weight="bold"
+          color="inherit"
+        >
+          USB stick is being flashed
+        </Typography>
+        <LoadingBar class="" />
+        <Button hierarchy="primary" class="w-fit" size="s">
+          Cancel
+        </Button>
+      </div>
+    </div>
+  );
+};
+const FlashDone = () => {
+  const stepSignal = useStepper<InstallSteps>();
+  return (
+    <div class="flex w-full flex-col items-center bg-inv-4">
+      <div class="flex w-full max-w-md flex-col items-center gap-3 py-6 fg-inv-1">
+        <div class="rounded-full bg-semantic-success-4">
+          <Icon icon="Checkmark" class="size-9" />
+        </div>
+        <Typography
+          hierarchy="title"
+          size="default"
+          weight="bold"
+          color="inherit"
+        >
+          Device has been successfully flashed!
+        </Typography>
+        <Alert
+          type="warning"
+          title="Plug the flashed device into the machine that you want to install."
+          description=""
+        />
+        <div class="mt-3 flex w-full justify-end">
+          <Button
+            hierarchy="primary"
+            endIcon="ArrowRight"
+            onClick={() => stepSignal.next()}
+          >
+            Next
+          </Button>
+        </div>
+      </div>
    </div>
  );
 };
@@ -288,7 +334,12 @@ export const createInstallerSteps = [
  },
  {
    id: "create:progress",
-    title: CreateHeader,
    content: FlashProgress,
+    isSplash: true,
+  },
+  {
+    id: "create:done",
+    content: FlashDone,
+    isSplash: true,
  },
 ] as const;
--- a/pkgs/clan-app/ui/src/workflows/Install/steps/installSteps.tsx
+++ b/pkgs/clan-app/ui/src/workflows/Install/steps/installSteps.tsx
@@ -1,5 +1,22 @@
 import { Typography } from "@/src/components/Typography/Typography";
-import { NextButton } from "../../Steps";
+import { BackButton, NextButton, StepLayout } from "../../Steps";
+import {
+  createForm,
+  getError,
+  SubmitHandler,
+  valiForm,
+} from "@modular-forms/solid";
+import { Fieldset } from "@/src/components/Form/Fieldset";
+import * as v from "valibot";
+import { useStepper } from "@/src/hooks/stepper";
+import { InstallSteps } from "../install";
+import { TextInput } from "@/src/components/Form/TextInput";
+import { Alert } from "@/src/components/Alert/Alert";
+import { createSignal, Show } from "solid-js";
+import { Divider } from "@/src/components/Divider/Divider";
+import { Orienter } from "@/src/components/Form/Orienter";
+import { Button } from "@/src/components/Button/Button";
+import { Select } from "@/src/components/Select/Select";

 export const InstallHeader = (props: { machineName: string }) => {
  return (
@@ -9,26 +26,354 @@ export const InstallHeader = (props: { machineName: string }) => {
  );
 };

+const ConfigureAdressSchema = v.object({
+  targetHost: v.pipe(
+    v.string("Please set a target host."),
+    v.nonEmpty("Please set a target host."),
+  ),
+});
+
+type ConfigureAdressForm = v.InferInput<typeof ConfigureAdressSchema>;
+
+const ConfigureAddress = () => {
+  const [formStore, { Form, Field }] = createForm<ConfigureAdressForm>({
+    validate: valiForm(ConfigureAdressSchema),
+  });
+  const stepSignal = useStepper<InstallSteps>();
+
+  // TODO: push values to the parent form Store
+  const handleSubmit: SubmitHandler<ConfigureAdressForm> = (values, event) => {
+    console.log("ISO creation submitted", values);
+    // Here you would typically trigger the ISO creation process
+    stepSignal.next();
+  };
+
+  return (
+    <Form onSubmit={handleSubmit}>
+      <StepLayout
+        body={
+          <div class="flex flex-col gap-2">
+            <Fieldset>
+              <Field name="targetHost">
+                {(field, props) => (
+                  <TextInput
+                    {...field}
+                    label="IP Address"
+                    description="Hostname of the installation target"
+                    value={field.value}
+                    required
+                    orientation="horizontal"
+                    validationState={
+                      getError(formStore, "targetHost") ? "invalid" : "valid"
+                    }
+                    input={{
+                      ...props,
+                      placeholder: "i.e. flash-installer.local",
+                    }}
+                  />
+                )}
+              </Field>
+            </Fieldset>
+          </div>
+        }
+        footer={
+          <div class="flex justify-between">
+            <BackButton />
+            <NextButton type="submit">Next</NextButton>
+          </div>
+        }
+      />
+    </Form>
+  );
+};
+
+const CheckHardware = () => {
+  const stepSignal = useStepper<InstallSteps>();
+  // TODO: Hook this up with api
+  const [report, setReport] = createSignal<boolean>(true);
+
+  const handleNext = () => {
+    stepSignal.next();
+  };
+
+  return (
+    <StepLayout
+      body={
+        <div class="flex flex-col gap-2">
+          <Fieldset>
+            <Orienter orientation="horizontal">
+              <Typography hierarchy="label" size="xs" weight="bold">
+                Check hardware
+              </Typography>
+              <Button hierarchy="secondary" startIcon="Report">
+                Run hardware report
+              </Button>
+            </Orienter>
+            <Divider orientation="horizontal" />
+            <Show when={report()}>
+              <Alert
+                icon="Checkmark"
+                type="info"
+                title="Hardware report exists"
+              />
+            </Show>
+          </Fieldset>
+        </div>
+      }
+      footer={
+        <div class="flex justify-between">
+          <BackButton />
+          <NextButton onClick={handleNext}>Next</NextButton>
+        </div>
+      }
+    />
+  );
+};
+
+const DiskSchema = v.object({
+  mainDisk: v.pipe(
+    v.string("Please select a disk"),
+    v.nonEmpty("Please select a disk"),
+  ),
+});
+
+type DiskForm = v.InferInput<typeof DiskSchema>;
+
+const ConfigureDisk = () => {
+  const [formStore, { Form, Field }] = createForm<DiskForm>({
+    validate: valiForm(DiskSchema),
+  });
+  const stepSignal = useStepper<InstallSteps>();
+
+  const handleSubmit: SubmitHandler<DiskForm> = (values, event) => {
+    console.log("submitted", values);
+    // Here you would typically trigger the ISO creation process
+    stepSignal.next();
+  };
+
+  return (
+    <Form onSubmit={handleSubmit}>
+      <StepLayout
+        body={
+          <div class="flex flex-col gap-2">
+            <Fieldset>
+              <Field name="mainDisk">
+                {(field, props) => (
+                  <Select
+                    {...props}
+                    value={field.value}
+                    error={field.error}
+                    required
+                    label={{
+                      label: "Main disk",
+                      description: "Select the disk to install the system on",
+                    }}
+                    // TODO: Get from api
+                    options={[{ value: "disk", label: "Disk0" }]}
+                    placeholder="Select a disk"
+                    name={field.name}
+                  />
+                )}
+              </Field>
+            </Fieldset>
+          </div>
+        }
+        footer={
+          <div class="flex justify-between">
+            <BackButton />
+            <NextButton type="submit">Next</NextButton>
+          </div>
+        }
+      />
+    </Form>
+  );
+};
+
+type DynamicForm = Record<string, string>;
+
+const ConfigureData = () => {
+  const [formStore, { Form, Field }] = createForm<DynamicForm>({
+    // TODO: Dynamically validate fields
+  });
+  const stepSignal = useStepper<InstallSteps>();
+
+  const handleSubmit: SubmitHandler<DynamicForm> = (values, event) => {
+    console.log("vars submitted", values);
+    // Here you would typically trigger the ISO creation process
+    stepSignal.next();
+  };
+
+  return (
+    <Form onSubmit={handleSubmit}>
+      <StepLayout
+        body={
+          <div class="flex flex-col gap-2">
+            <Fieldset legend="Root password">
+              <Field name="root-password">
+                {(field, props) => (
+                  <TextInput
+                    {...field}
+                    label="Root password"
+                    description="Set the root password for the machine"
+                    value={field.value}
+                    required
+                    orientation="horizontal"
+                    validationState={
+                      getError(formStore, "root-password") ? "invalid" : "valid"
+                    }
+                    icon="EyeClose"
+                    input={{
+                      ...props,
+                      type: "password",
+                    }}
+                  />
+                )}
+              </Field>
+            </Fieldset>
+            <Fieldset legend="WIFI TU-YAN">
+              <Field name="networkSSID">
+                {(field, props) => (
+                  <TextInput
+                    {...field}
+                    label="ssid"
+                    description="Name of the wifi network"
+                    value={field.value}
+                    required
+                    orientation="horizontal"
+                    validationState={
+                      getError(formStore, "wifi/password") ? "invalid" : "valid"
+                    }
+                    input={{
+                      ...props,
+                    }}
+                  />
+                )}
+              </Field>
+              <Field name="password">
+                {(field, props) => (
+                  <TextInput
+                    {...field}
+                    label="password"
+                    description="Password for the wifi network"
+                    value={field.value}
+                    required
+                    orientation="horizontal"
+                    validationState={
+                      getError(formStore, "wifi/password") ? "invalid" : "valid"
+                    }
+                    icon="EyeClose"
+                    input={{
+                      ...props,
+                      type: "password",
+                    }}
+                  />
+                )}
+              </Field>
+            </Fieldset>
+          </div>
+        }
+        footer={
+          <div class="flex justify-between">
+            <BackButton />
+            <NextButton type="submit">Next</NextButton>
+          </div>
+        }
+      />
+    </Form>
+  );
+};
+
+const Display = (props: { value: string; label: string }) => {
+  return (
+    <>
+      <Typography hierarchy="label" size="xs" color="primary" weight="bold">
+        {props.label}
+      </Typography>
+      <Typography hierarchy="body" size="s" weight="medium">
+        {props.value}
+      </Typography>
+    </>
+  );
+};
+
+const InstallSummary = () => {
+  const stepSignal = useStepper<InstallSteps>();
+
+  const handleInstall = () => {
+    // Here you would typically trigger the installation process
+    console.log("Installation started");
+    stepSignal.setActiveStep("install:progress");
+  };
+  return (
+    <StepLayout
+      body={
+        <div class="flex flex-col gap-4">
+          <Fieldset legend="Deploy to">
+            <Orienter orientation="horizontal">
+              {/* TOOD: Display the values emited from previous steps */}
+              <Display label="Target" value="flash-installer.local" />
+            </Orienter>
+          </Fieldset>
+          <Fieldset legend="Disk Configuration">
+            <Orienter orientation="horizontal">
+              <Display label="Disk Schema" value="Single" />
+            </Orienter>
+            <Divider orientation="horizontal" />
+            <Orienter orientation="horizontal">
+              <Display
+                label="Main Disk"
+                value="nvme-WD_PC_SN740_SDDQNQD-512G"
+              />
+            </Orienter>
+          </Fieldset>
+        </div>
+      }
+      footer={
+        <div class="flex justify-between">
+          <BackButton />
+          <NextButton type="button" onClick={handleInstall} endIcon="Flash">
+            Install
+          </NextButton>
+        </div>
+      }
+    />
+  );
+};
+
 export const installSteps = [
  {
-    id: "install:machine-0",
+    id: "install:address",
    title: InstallHeader,
-    content: () => (
-      <div>
-        Enter the targetHost
-        <NextButton />
-      </div>
-    ),
+    content: ConfigureAddress,
  },
  {
-    id: "install:confirm",
+    id: "install:check-hardware",
    title: InstallHeader,
-    content: (props: { machineName: string }) => (
-      <div>
-        Confirm the installation of {props.machineName}
-        <NextButton />
-      </div>
+    content: CheckHardware,
+  },
+  {
+    id: "install:check-hardware",
+    title: InstallHeader,
+    content: CheckHardware,
+  },
+  {
+    id: "install:disk",
+    title: InstallHeader,
+    content: ConfigureDisk,
+  },
+  {
+    id: "install:data",
+    title: InstallHeader,
+    content: ConfigureData,
+  },
+  {
+    id: "install:summary",
+    title: () => (
+      <Typography hierarchy="label" size="default">
+        Summary
+      </Typography>
    ),
+    content: InstallSummary,
  },
  {
    id: "install:progress",
@@ -40,4 +385,9 @@ export const installSteps = [
      </div>
    ),
  },
+  {
+    id: "install:done",
+    title: InstallHeader,
+    content: () => <div>Done</div>,
+  },
 ] as const;
--- a/pkgs/clan-app/ui/src/workflows/Steps.tsx
+++ b/pkgs/clan-app/ui/src/workflows/Steps.tsx
@@ -40,13 +40,11 @@ export const BackButton = () => {
    <Button
      hierarchy="secondary"
      disabled={!stepSignal.hasPrevious()}
-      startIcon="ArrowLeft"
+      icon="ArrowLeft"
      onClick={() => {
        stepSignal.previous();
      }}
-    >
-      Back
-    </Button>
+    ></Button>
  );
 };

@@ -62,7 +60,7 @@ export const BackButton = () => {
 export const StepFooter = () => {
  const stepper = useStepper<InstallSteps>();
  return (
-    <div class="flex justify-between">
+    <div class="flex justify-between py-4">
      <BackButton />
      <NextButton type="button" onClick={() => stepper.next()} />
    </div>