Track HiveGrid Cloud planning reference

This commit is contained in:
david committed 2026-06-26 20:48:01 +02:00
1 parent b3d5ea6764
commit e341c5938a
5784 files changed
+1104929 -3

No files matched your search

@@ -0,0 +1,199 @@
import { useFetcher, useNavigate, useParams } from "react-router";
import { useEffect, useRef, useState } from "react";
import { useTranslation } from "react-i18next";
import ErrorModal, { RefErrorModal } from "~/components/ui/modals/ErrorModal";
import { OnboardingSessionWithDetails } from "~/modules/onboarding/db/onboardingSessions.db.server";
import { OnboardingSessionActionDto } from "~/modules/onboarding/dtos/OnboardingSessionActionDto";
import { useAppOrAdminData } from "~/utils/data/useAppOrAdminData";
import { useRootData } from "~/utils/data/useRootData";
import { OnboardingBlockDto } from "./OnboardingBlockUtils";
import { resolveOnboardingHref } from "./OnboardingLinkUtils";
import OnboardingVariantModal from "./OnboardingVariantModal";
export default function OnboardingBlock({
session,
item,
open,
onClose,
}: {
session?: OnboardingSessionWithDetails | null;
item: OnboardingBlockDto;
open: boolean;
onClose: () => void;
}) {
const { t } = useTranslation();
const fetcher = useFetcher();
const navigate = useNavigate();
const params = useParams();
const appOrAdminData = useAppOrAdminData();
const rootData = useRootData();
const errorModal = useRef<RefErrorModal>(null);
const [block, setBlock] = useState<OnboardingBlockDto>(item);
const [currentStepIdx, setCurrentStepIdx] = useState(0);
useEffect(() => {
setBlock(item);
}, [item]);
useEffect(() => {
if (session) {
const stepIdx = session.sessionSteps.findIndex((f) => !f.completedAt);
if (stepIdx !== undefined && stepIdx !== -1 && stepIdx < item.steps.length) {
setCurrentStepIdx(stepIdx);
}
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);
const [stepStates, setStepStates] = useState<{ idx: number; state: { [key: string]: string } }[]>([]);
useEffect(() => {
if (session && !session.startedAt) {
const form = new FormData();
form.set("action", "started");
submitSessionForm(form);
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, []);
function onUpdateCurrentStepState(state: { [key: string]: string }) {
setStepStates((prev) => {
const idx = prev.findIndex((x) => x.idx === currentStepIdx);
if (idx === -1) {
return [...prev, { idx: currentStepIdx, state }];
}
return [...prev.slice(0, idx), { idx: currentStepIdx, state }, ...prev.slice(idx + 1)];
});
}
function submitSessionForm(form: FormData, actions?: OnboardingSessionActionDto[]) {
if (session) {
if (rootData.csrf && !form.has("csrf")) {
form.set("csrf", rootData.csrf);
}
if (actions) {
actions
.filter((f) => f.value)
.forEach((action) => {
form.append("actions[]", JSON.stringify(action));
});
}
fetcher.submit(form, {
action: "/onboarding/" + session.id,
method: "post",
});
}
}
function onDismiss() {
if (validInput()) {
if (session && !session.dismissedAt) {
const form = new FormData();
form.set("action", "dismissed");
submitSessionForm(form);
}
onClose();
}
}
function setStep(idx: number) {
const form = new FormData();
form.set("action", "set-step");
form.set("fromIdx", currentStepIdx.toString());
form.set("toIdx", idx.toString());
const currentState = stepStates.find((x) => x.idx === currentStepIdx);
const keyValuePairs = Object.entries(currentState?.state || {});
submitSessionForm(
form,
keyValuePairs.map(([key, value]) => {
return { type: "input", name: key, value };
})
);
const currentStep = block.steps[currentStepIdx];
currentStep.completedAt = new Date();
setBlock({ ...block, steps: [...block.steps.slice(0, currentStepIdx), currentStep, ...block.steps.slice(currentStepIdx + 1)] });
if (validInput()) {
setCurrentStepIdx(idx);
}
}
function validInput() {
const missingFields = getMissingFields();
if (missingFields.length === 0) {
return true;
} else {
errorModal.current?.show(t("shared.error"), t("onboarding.errors.missingInput", { 0: missingFields.join(", ") }));
}
}
function onComplete() {
if (session && !session.completedAt) {
const form = new FormData();
form.set("action", "complete");
form.set("fromIdx", currentStepIdx.toString());
submitSessionForm(form);
}
if (validInput()) {
onClose();
}
}
function onLinkClick(item: { text: string; href: string }) {
const form = new FormData();
form.set("action", "add-actions");
submitSessionForm(form, [
{
type: "click",
name: item.text,
value: item.href,
},
]);
const linkWithVariables = resolveOnboardingHref(item.href, params, appOrAdminData?.user?.id);
navigate(linkWithVariables);
onClose();
}
function getMissingFields() {
const step = block.steps[currentStepIdx];
const fields: string[] = [];
step.input.forEach((input) => {
if (input.isRequired) {
const currentState = stepStates.find((x) => x.idx === currentStepIdx);
if (!currentState?.state[input.name]) {
fields.push(t(input.title));
}
}
});
return fields;
}
function onClosing() {
if (validInput()) {
onClose();
}
}
return (
<>
{item.style === "modal" && (
<OnboardingVariantModal
block={block}
currentStepIdx={currentStepIdx}
setStep={setStep}
open={open}
onClose={onClosing}
onDismiss={onDismiss}
onComplete={onComplete}
onLinkClick={onLinkClick}
onUpdateCurrentStepState={onUpdateCurrentStepState}
/>
)}
<ErrorModal ref={errorModal} />
</>
);
}
@@ -0,0 +1,438 @@
import { useEffect, useState } from "react";
import { useTranslation } from "react-i18next";
import EntityIcon from "~/components/layouts/icons/EntityIcon";
import ButtonTertiary from "~/components/ui/buttons/ButtonTertiary";
import InputGroup from "~/components/ui/forms/InputGroup";
import QuestionMarkFilledIcon from "~/components/ui/icons/QuestionMarkFilledIcon";
import XIcon from "~/components/ui/icons/XIcon";
import InputCheckbox from "~/components/ui/input/InputCheckbox";
import InputRadioGroup from "~/components/ui/input/InputRadioGroup";
import InputSelect from "~/components/ui/input/InputSelect";
import InputSelector from "~/components/ui/input/InputSelector";
import InputText from "~/components/ui/input/InputText";
import CollapsibleRow from "~/components/ui/tables/CollapsibleRow";
import OnboardingStepUtils from "~/modules/onboarding/utils/OnboardingStepUtils";
import OnboardingGridForm from "./grid/OnboardingGridForm";
import StringUtils from "~/utils/shared/StringUtils";
import { defaultOnboardingStepBlocks } from "./defaultOnboarding/defaultOnboardingStepBlocks";
import {
defaultOnboardingBlock,
defaultOnboardingStepBlock,
OnboardingBlockDto,
OnboardingBlockStyle,
OnboardingBlockStyles,
OnboardingInputOptionDto,
OnboardingStepBlockDto,
} from "./OnboardingBlockUtils";
import ReactSortablePkg from "react-sortablejs";
const { ReactSortable } = ReactSortablePkg;
export default function OnboardingBlockForm({ item, onUpdate }: { item?: OnboardingBlockDto; onUpdate: (item: OnboardingBlockDto) => void }) {
const { t } = useTranslation();
const [state, setState] = useState<OnboardingBlockDto>(item || defaultOnboardingBlock);
useEffect(() => {
onUpdate(state);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [state]);
return (
<div className="space-y-4">
<InputGroup title={t("onboarding.block.design")}>
<div className="grid grid-cols-2 gap-2">
<InputSelector
withSearch={false}
className="col-span-2"
title={t("onboarding.block.style")}
value={state.style}
setValue={(value) => setState({ ...state, style: value as OnboardingBlockStyle })}
options={OnboardingBlockStyles.map((f) => f)}
/>
<InputSelector
withSearch={false}
title={t("onboarding.block.height")}
value={state.height}
disabled={state.style !== "modal"}
setValue={(value) => setState({ ...state, height: value as any })}
options={[
{ value: "xs", name: "xs" },
{ value: "sm", name: "sm" },
{ value: "md", name: "md" },
{ value: "lg", name: "lg" },
{ value: "xl", name: "xl" },
{ value: "auto", name: "auto" },
]}
/>
<InputSelector
withSearch={false}
title={t("onboarding.block.canBeDismissed")}
value={state.canBeDismissed ? "true" : "false"}
disabled={state.style !== "modal"}
setValue={(value) => setState({ ...state, canBeDismissed: value === "true" })}
options={[
{ value: "true", name: t("shared.yes") },
{ value: "false", name: t("shared.no") },
]}
/>
</div>
</InputGroup>
<InputGroup title={t("onboarding.step.plural")} description={t("onboarding.block.stepsDescription")}>
<div className="space-y-2">
<ReactSortable className="flex flex-col space-y-2" animation={200} list={state.steps} setList={(steps) => setState({ ...state, steps })}>
{state.steps.map((item, index) => (
<CollapsibleRow
draggable
key={item.id}
title={item.title || t("onboarding.block.untitledStep")}
value={OnboardingStepUtils.getStepDescription(item)}
initial={!item.title}
onRemove={() => {
const steps = state.steps ?? [];
const index = steps.findIndex((e) => e.id === item.id);
if (index > -1) {
steps.splice(index, 1);
setState({ ...state, steps });
}
}}
>
<StepForm
item={item}
onUpdate={(item) => {
const steps = state.steps ?? [];
steps[index] = item;
setState({ ...state, steps });
}}
/>
</CollapsibleRow>
))}
</ReactSortable>
<div className="flex justify-between space-x-2">
<ButtonTertiary
onClick={() =>
setState({
...state,
steps: [
...(state.steps ?? []),
{
id: Math.floor(Math.random() * 10000).toString(),
// ...defaultOnboardingStepBlock,
title: "",
description: "",
links: [],
gallery: [],
input: [],
},
],
})
}
>
{t("onboarding.block.actions.addStep")}
</ButtonTertiary>
<div>
{state.steps.length > 0 ? (
<ButtonTertiary
destructive
onClick={() => {
if (prompt(t("onboarding.block.confirmClearPrompt")) === "yes") setState({ ...state, steps: [] });
}}
>
{t("shared.clear")}
</ButtonTertiary>
) : (
<ButtonTertiary onClick={() => setState({ ...state, steps: defaultOnboardingStepBlocks })}>{t("onboarding.block.actions.loadSampleSteps")}</ButtonTertiary>
)}
</div>
</div>
</div>
</InputGroup>
</div>
);
}
function StepForm({ item, onUpdate }: { item: OnboardingStepBlockDto; onUpdate: (item: OnboardingStepBlockDto) => void }) {
const { t } = useTranslation();
const [state, setState] = useState<OnboardingStepBlockDto>(item || defaultOnboardingStepBlock);
useEffect(() => {
onUpdate(state);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [state]);
return (
<div className="grid grid-cols-1 gap-4 p-2">
<InputText title={t("onboarding.step.title")} value={state.title} setValue={(e) => setState({ ...state, title: e?.toString() })} required />
<InputText
title={t("shared.description")}
value={state.description}
setValue={(e) => setState({ ...state, description: e?.toString() })}
rows={5}
hint={t("onboarding.block.markdownSupported")}
/>
<InputText
title={t("shared.icon")}
value={state.icon}
setValue={(e) => setState({ ...state, icon: e?.toString() })}
hint={<div className="text-muted-foreground">{t("onboarding.block.iconHint")}</div>}
button={
<div className="absolute inset-y-0 right-0 flex py-0.5 pr-0.5 ">
<kbd className="border-border text-muted-foreground bg-secondary inline-flex w-10 items-center justify-center rounded border px-1 text-center font-sans text-xs font-medium">
{state.icon ? (
<EntityIcon className="text-muted-foreground h-7 w-7" icon={state.icon} title={state.title} />
) : (
<QuestionMarkFilledIcon className="text-muted-foreground h-5 w-5" aria-hidden="true" />
)}
</kbd>
</div>
}
/>
<InputGroup title={t("onboarding.block.links")}>
<div className="flex flex-col space-y-2">
{state.links.map((link, index) => (
<div key={index} className="group relative grid grid-cols-4 gap-2">
<button
onClick={() => {
const links = state.links;
links.splice(index, 1);
setState({ ...state, links });
}}
type="button"
className="bg-background text-muted-foreground absolute right-0 top-0 -mt-3 hidden origin-top-right justify-center rounded-full hover:text-red-500 group-hover:flex"
>
<XIcon className="h-6 w-6" />
</button>
<InputText
title={t("shared.link")}
value={link.text}
setValue={(e) => setState({ ...state, links: state.links.map((step, i) => (i === index ? { ...step, text: e.toString() } : step)) })}
/>
<InputText
title={t("onboarding.block.href")}
value={link.href}
setValue={(e) => setState({ ...state, links: state.links.map((step, i) => (i === index ? { ...step, href: e.toString() } : step)) })}
/>
<InputCheckbox
title={t("onboarding.block.isPrimary")}
value={link.isPrimary}
setValue={(e) => setState({ ...state, links: state.links.map((link, i) => (i === index ? { ...link, isPrimary: Boolean(e) } : link)) })}
/>
<InputCheckbox
title={t("onboarding.block.targetBlank")}
value={link.target === "_blank"}
setValue={(e) => setState({ ...state, links: state.links.map((link, i) => (i === index ? { ...link, target: e ? "_blank" : "" } : link)) })}
/>
</div>
))}
<ButtonTertiary onClick={() => setState({ ...state, links: [...state.links, { text: t("shared.link"), href: "#", isPrimary: false }] })}>
{t("onboarding.block.actions.addLink")}
</ButtonTertiary>
</div>
</InputGroup>
<InputGroup title={t("onboarding.block.gallery")}>
<div className="flex flex-col space-y-2">
<ReactSortable className="flex flex-col space-y-2" animation={200} list={state.gallery} setList={(gallery) => setState({ ...state, gallery })}>
{state.gallery.map((item, index) => (
<CollapsibleRow
key={index}
title={item.title || t("onboarding.block.untitledGalleryItem")}
value={item.title || t("onboarding.block.untitledGalleryItem")}
initial={!item.title}
onRemove={() => {
const gallery = state.gallery ?? [];
gallery.splice(index, 1);
setState({ ...state, gallery });
}}
>
<div className="grid grid-cols-1 gap-2">
<InputRadioGroup
title={t("onboarding.step.type")}
value={item.type}
setValue={(e) =>
setState({
...state,
gallery: state.gallery.map((item, i) => (i === index ? { ...item, type: e?.toString() as "image" | "video" } : item)),
})
}
options={[
{ name: t("onboarding.block.mediaTypes.image"), value: "image" },
{ name: t("onboarding.block.mediaTypes.video"), value: "video" },
]}
/>
<InputText
title={t("onboarding.step.title")}
type="text"
value={item.title}
setValue={(e) => setState({ ...state, gallery: state.gallery.map((item, i) => (i === index ? { ...item, title: e.toString() } : item)) })}
/>
<InputText
title={t("onboarding.block.src")}
type="text"
value={item.src}
setValue={(e) => setState({ ...state, gallery: state.gallery.map((item, i) => (i === index ? { ...item, src: e.toString() } : item)) })}
/>
</div>
</CollapsibleRow>
))}
</ReactSortable>
<ButtonTertiary
onClick={() =>
setState({
...state,
gallery: [
...(state.gallery ?? []),
{
id: Math.floor(Math.random() * 10000).toString(),
type: "image",
title: t("onboarding.block.defaultGalleryTitle", { number: state.gallery.length + 1 }),
src: "",
},
],
})
}
>
{t("onboarding.block.actions.addGalleryItem")}
</ButtonTertiary>
</div>
</InputGroup>
<InputGroup title={t("onboarding.block.input")}>
<div className="flex flex-col space-y-2">
<OnboardingGridForm item={state.inputGrid} onUpdate={(item) => setState({ ...state, inputGrid: item })} />
<ReactSortable className="flex flex-col space-y-2" animation={200} list={state.input} setList={(input) => setState({ ...state, input })}>
{state.input.map((item, index) => (
<CollapsibleRow
key={index}
title={item.title || t("onboarding.block.untitledInput")}
value={item.title || t("onboarding.block.untitledInput")}
initial={!item.title}
onRemove={() => {
const input = state.input ?? [];
input.splice(index, 1);
setState({ ...state, input });
}}
>
<div className="grid grid-cols-3 gap-2">
<InputText
title={t("onboarding.step.title")}
type="text"
value={item.title}
setValue={(e) =>
setState({
...state,
input: state.input.map((item, i) =>
i === index ? { ...item, title: e.toString(), name: StringUtils.toCamelCase(e?.toString().toLowerCase()) } : item
),
})
}
/>
<InputText
title={t("shared.name")}
type="text"
value={item.name}
setValue={(e) => setState({ ...state, input: state.input.map((item, i) => (i === index ? { ...item, name: e.toString() } : item)) })}
/>
<InputCheckbox
title={t("onboarding.block.isRequired")}
value={item.isRequired}
setValue={(e) => setState({ ...state, input: state.input.map((item, i) => (i === index ? { ...item, isRequired: Boolean(e) } : item)) })}
/>
<InputSelect
className="col-span-3"
title={t("onboarding.step.type")}
value={item.type}
setValue={(e) =>
setState({
...state,
input: state.input.map((item, i) => (i === index ? { ...item, type: e?.toString() as "text" | "select" } : item)),
})
}
options={[
{ name: t("onboarding.block.inputTypes.text"), value: "text" },
{ name: t("onboarding.block.inputTypes.select"), value: "select" },
]}
/>
{item.type === "select" && (
<div className="col-span-3">
<SelectOptionsForm
options={item.options}
setOptions={(options) => setState({ ...state, input: state.input.map((item, i) => (i === index ? { ...item, options } : item)) })}
/>
</div>
)}
</div>
</CollapsibleRow>
))}
</ReactSortable>
<ButtonTertiary
onClick={() =>
setState({
...state,
input: [
...(state.input ?? []),
{
id: Math.floor(Math.random() * 10000).toString(),
type: "text",
name: "",
title: "",
isRequired: false,
options: [],
},
],
})
}
>
{t("onboarding.block.actions.addInput")}
</ButtonTertiary>
</div>
</InputGroup>
</div>
);
}
function SelectOptionsForm({ options, setOptions }: { options: OnboardingInputOptionDto[]; setOptions: (options: OnboardingInputOptionDto[]) => void }) {
const { t } = useTranslation();
const [state, setState] = useState<OnboardingInputOptionDto[]>(options ?? []);
useEffect(() => {
setOptions(state);
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [state]);
return (
<div className="flex flex-col space-y-2">
{options.map((option, index) => (
<div key={index} className="group relative grid grid-cols-2 gap-2">
<button
onClick={() => {
const options = state ?? [];
options.splice(index, 1);
setState(options);
}}
type="button"
className="bg-background text-muted-foreground absolute right-0 top-0 -mt-3 hidden origin-top-right justify-center rounded-full hover:text-red-500 group-hover:flex"
>
<XIcon className="h-6 w-6" />
</button>
<InputText
title={t("onboarding.step.title")}
value={option.name}
setValue={(e) =>
setState(
options.map((option, i) =>
i === index ? { ...option, name: e.toString(), value: StringUtils.toCamelCase(e?.toString().toLowerCase()) } : option
)
)
}
/>
<InputText
title={t("shared.value")}
value={option.value}
setValue={(e) => setState(options.map((option, i) => (i === index ? { ...option, value: e.toString() } : option)))}
/>
</div>
))}
<ButtonTertiary onClick={() => setState([...options, { value: "", name: "" }])}>{t("onboarding.block.actions.addOption")}</ButtonTertiary>
</div>
);
}
@@ -0,0 +1,121 @@
import { Colors } from "~/application/enums/shared/Colors";
import { t as i18nT } from "i18next";
import { OnboardingGridDto } from "./grid/OnboardingGridUtils";
export type OnboardingBlockDto = {
style: OnboardingBlockStyle;
title: string;
canBeDismissed: boolean;
height: OnboardingHeightDto;
steps: OnboardingStepBlockDto[];
};
export type OnboardingHeightDto = "xs" | "sm" | "md" | "lg" | "xl" | "auto";
export interface OnboardingStepBlockDto {
id: string;
title: string;
description?: string;
links: OnboardingLinkDto[];
gallery: OnboardingGalleryDto[];
input: OnboardingInputDto[];
inputGrid?: OnboardingGridDto;
icon?: string;
completedAt?: Date | null;
}
interface OnboardingLinkDto {
text: string;
href: string;
isPrimary: boolean;
target?: string;
}
interface OnboardingGalleryDto {
id: string;
type: "image" | "video";
title: string;
src: string;
}
export interface OnboardingInputOptionDto {
name: string;
value: string;
color?: Colors;
}
interface OnboardingInputDto {
id: string;
type: "text" | "select";
name: string;
title: string;
isRequired: boolean;
options: OnboardingInputOptionDto[];
}
export const OnboardingBlockStyles = [{ value: "modal", name: "Modal" }] as const;
export type OnboardingBlockStyle = (typeof OnboardingBlockStyles)[number]["value"];
export const defaultOnboardingStepBlock: OnboardingStepBlockDto = {
id: "",
title: i18nT("onboarding.block.defaults.stepTitle"),
description: i18nT("onboarding.block.defaults.stepDescription"),
icon: `<svg fill="currentColor" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" width="32" height="32" viewBox="0 0 32 32"> <path d="M 19 6 L 19 7.4375 L 19.09375 7.625 L 20.125 10 L 11.4375 10 L 11.125 10.4375 L 8.40625 14.28125 C 7.800781 14.09375 7.164063 14 6.5 14 C 2.917969 14 0 16.914063 0 20.5 C 0 24.085938 2.914063 27 6.5 27 C 9.914063 27 12.707031 24.347656 12.96875 21 L 16.40625 21 L 16.71875 20.5625 L 21.59375 13.375 L 22.25 14.875 C 20.308594 16.003906 19 18.109375 19 20.5 C 19 24.070313 21.929688 27 25.5 27 C 29.070313 27 32 24.070313 32 20.5 C 32 16.929688 29.070313 14 25.5 14 C 25.019531 14 24.546875 14.054688 24.09375 14.15625 L 21.40625 8 L 24.5 8 C 24.785156 8 25 8.214844 25 8.5 C 25 8.785156 24.785156 9 24.5 9 L 24.5 11 C 25.867188 11 27 9.867188 27 8.5 C 27 7.132813 25.867188 6 24.5 6 Z M 8 7 L 8 9 L 14 9 L 13 7 Z M 13.46875 12 L 20.125 12 L 16.09375 17.9375 Z M 11.71875 13 L 14.34375 19 L 6 19 L 6 21 L 10.9375 21 C 10.683594 23.242188 8.808594 25 6.5 25 C 4.019531 25 2 22.980469 2 20.5 C 2 18.019531 4.019531 16 6.5 16 C 8.058594 16 9.441406 16.796875 10.25 18 L 12.5 18 C 12.019531 16.847656 11.230469 15.859375 10.21875 15.15625 Z M 25.5 16 C 27.980469 16 30 18.019531 30 20.5 C 30 22.980469 27.980469 25 25.5 25 C 23.019531 25 21 22.980469 21 20.5 C 21 18.925781 21.832031 17.554688 23.0625 16.75 L 25.09375 21.40625 L 26.90625 20.59375 L 24.9375 16.0625 C 25.125 16.039063 25.308594 16 25.5 16 Z"></path> </svg>`,
links: [
{
text: i18nT("onboarding.block.defaults.primaryLink"),
href: "#",
isPrimary: true,
},
{
text: i18nT("onboarding.block.defaults.secondaryLink"),
href: "#",
isPrimary: false,
},
],
gallery: [
{
id: "",
type: "image",
title: i18nT("onboarding.block.defaults.gallery.image1"),
src: "https://placehold.co/1000x600?text=Image%201",
},
{
id: "",
type: "image",
title: i18nT("onboarding.block.defaults.gallery.image2"),
src: "https://placehold.co/1000x600?text=Image%202",
},
],
input: [
{
id: "1",
type: "text",
name: "source",
title: i18nT("onboarding.block.defaults.sourceQuestion"),
isRequired: true,
options: [],
},
{
id: "2",
type: "select",
name: "What will you use it for?",
title: i18nT("onboarding.block.defaults.useCaseSelect"),
isRequired: false,
options: [
{ value: "research", name: i18nT("onboarding.block.defaults.useCases.research"), color: Colors.GRAY },
{ value: "personal", name: i18nT("onboarding.block.defaults.useCases.personal"), color: Colors.BLUE },
{ value: "smallBusiness", name: i18nT("onboarding.block.defaults.useCases.smallBusiness"), color: Colors.INDIGO },
{ value: "largeCompany", name: i18nT("onboarding.block.defaults.useCases.largeCompany"), color: Colors.VIOLET },
],
},
],
};
export const defaultOnboardingBlock: OnboardingBlockDto = {
style: "modal",
title: i18nT("onboarding.block.defaults.title"),
canBeDismissed: true,
height: "md",
steps: [defaultOnboardingStepBlock],
};
@@ -0,0 +1,13 @@
import { describe, expect, it } from "vitest";
import { resolveOnboardingHref } from "./OnboardingLinkUtils";
describe("resolveOnboardingHref", () => {
it("resolves app/admin placeholders without duplicate slashes", () => {
expect(resolveOnboardingHref("$appOrAdmin/settings/profile", { tenant: "acme" }, "user_1")).toBe("/acme/settings/profile");
expect(resolveOnboardingHref("$appOrAdmin/settings/profile", {}, "user_1")).toBe("/settings/profile");
});
it("replaces tenant and user placeholders consistently", () => {
expect(resolveOnboardingHref("/$tenant/users/$user/:tenant/{user}", { tenant: "acme" }, "user_1")).toBe("/acme/users/user_1/acme/user_1");
});
});
@@ -0,0 +1,18 @@
import type { Params } from "react-router";
import { adminPath } from "~/utils/app/CanonicalUrlUtils";
import UrlUtils from "~/utils/app/UrlUtils";
const replaceTokens = (href: string, tokens: string[], value: string) => tokens.reduce((next, token) => next.split(token).join(value), href);
const getAppOrAdminBasePath = (params: Params) => {
const basePath = params.tenant ? UrlUtils.currentTenantUrl(params) : adminPath(undefined, { mode: "host-aware" });
return UrlUtils.stripTrailingSlash(basePath);
};
export function resolveOnboardingHref(href: string, params: Params, userId?: string) {
let resolved = href;
resolved = replaceTokens(resolved, [":tenant", "{tenant}", "$tenant"], params.tenant ?? "");
resolved = replaceTokens(resolved, [":user", "{user}", "$user"], userId ?? "");
resolved = replaceTokens(resolved, [":appOrAdmin", "{appOrAdmin}", "$appOrAdmin"], getAppOrAdminBasePath(params));
return resolved;
}
@@ -0,0 +1,315 @@
import clsx from "clsx";
import { Fragment, useEffect, useState } from "react";
import { useTranslation } from "react-i18next";
import ButtonPrimary from "~/components/ui/buttons/ButtonPrimary";
import ButtonSecondary from "~/components/ui/buttons/ButtonSecondary";
import CustomCarousel from "~/components/ui/images/CustomCarousel";
import InputSelect from "~/components/ui/input/InputSelect";
import InputText from "~/components/ui/input/InputText";
import Modal from "~/components/ui/modals/Modal";
import Tabs from "~/components/ui/tabs/Tabs";
import { renderSanitizedMarkdown } from "~/utils/html-sanitizer";
import { OnboardingBlockDto, OnboardingStepBlockDto } from "./OnboardingBlockUtils";
import OnboardingGridUtils from "./grid/OnboardingGridUtils";
export default function OnboardingVariantModal({
block,
currentStepIdx,
setStep,
open,
onClose,
onDismiss,
onComplete,
onLinkClick,
onUpdateCurrentStepState,
}: {
block: OnboardingBlockDto;
currentStepIdx: number;
open: boolean;
setStep: (idx: number) => void;
onClose: () => void;
onDismiss: () => void;
onComplete: () => void;
onLinkClick: (item: { text: string; href: string }) => void;
onUpdateCurrentStepState: (state: { [key: string]: string }) => void;
}) {
const { t } = useTranslation();
function dismiss() {
onDismiss();
}
function onNext() {
const nextStep = block.steps[currentStepIdx + 1];
if (nextStep) {
setStep(currentStepIdx + 1);
} else {
onComplete();
}
}
return (
<Modal
open={open}
setOpen={() => {
if (block.canBeDismissed) {
onClose();
}
}}
padding="none"
>
<div>
<div className="border-border flex items-center justify-between space-x-2 border-b px-2 py-2">
<div className="truncate text-lg font-bold">{t(block.title)}</div>
<div className="hidden items-center space-x-1 sm:flex">
{block.steps.map((step, idx) => {
return (
<button
key={idx}
type="button"
onClick={() => setStep(idx)}
aria-label={t(step.title)}
aria-current={idx === currentStepIdx ? "step" : undefined}
className={clsx(
"flex min-h-10 min-w-10 items-center justify-center focus:outline-hidden focus-visible:ring-2 focus-visible:ring-teal-500 focus-visible:ring-offset-1",
step.completedAt
? "text-teal-500 hover:text-teal-600"
: idx === currentStepIdx
? "text-teal-600 hover:text-teal-700"
: "hover:text-muted-foreground text-gray-300"
)}
>
<svg
aria-hidden="true"
className={clsx("h-4 w-4")}
fill="currentColor"
xmlns="http://www.w3.org/2000/svg"
x="0px"
y="0px"
width="50"
height="50"
viewBox="0 0 50 50"
>
{" "}
<path d="M 41 42 L 9 42 C 5.132813 42 2 38.867188 2 35 L 2 15 C 2 11.132813 5.132813 8 9 8 L 41 8 C 44.867188 8 48 11.132813 48 15 L 48 35 C 48 38.867188 44.867188 42 41 42 Z"></path>{" "}
</svg>
</button>
);
})}
</div>
<Tabs
className="sm:hidden"
onSelected={(e) => setStep(e)}
tabs={block.steps.map((step) => {
return { name: step.title };
})}
/>
</div>
<div
className={clsx(
"bg-secondary",
block.height === "xs" && "h-20",
block.height === "sm" && "h-40",
block.height === "md" && "h-60",
block.height === "lg" && "h-80",
block.height === "xl" && "h-96",
block.height === "auto" && "h-auto",
block.height !== "auto" && "overflow-y-auto"
)}
>
<div className="relative flex h-full">
{block.steps.length > 0 && (
<div className="divide-border bg-secondary/90 hidden w-1/2 divide-y-2 overflow-y-scroll sm:block">
{block.steps.map((step, idx) => {
return (
<Fragment key={idx}>
<button
type="button"
aria-current={idx === currentStepIdx ? "step" : undefined}
className={clsx(
"w-full truncate px-3 py-3 text-left text-base font-medium focus:outline-hidden focus-visible:ring-2 focus-visible:ring-teal-500 focus-visible:ring-inset",
idx === currentStepIdx ? "text-foreground bg-background" : "border-border text-muted-foreground border-r-2"
)}
onClick={() => setStep(idx)}
>
<div className="flex items-center space-x-2">
{step.icon && (
<>
{step.icon.startsWith("<svg") ? (
<div dangerouslySetInnerHTML={{ __html: step.icon.replace("<svg", `<svg class='${"h-5 w-5"}'`) ?? "" }} />
) : step.icon.startsWith("http") ? (
<img className="h-5 w-5" src={step.icon} alt={step.title} />
) : (
<div className="w-5">{step.icon}</div>
)}
</>
)}
<div>{t(step.title)}</div>
</div>
</button>
</Fragment>
);
})}
<div className="border-border h-full border-r-2 p-2"></div>
</div>
)}
{block.steps.length > 0 && (
<div className={clsx("bg-background w-full overflow-y-auto px-4 pb-4")}>
{block.steps.length > currentStepIdx && (
<OnboardingStep step={block.steps[currentStepIdx]} onLinkClick={onLinkClick} onUpdate={onUpdateCurrentStepState} />
)}
</div>
)}
</div>
</div>
<div className="border-border bg-secondary flex items-center justify-between space-x-2 border-t px-2 py-2">
<div className="flex items-center space-x-2 truncate px-2 py-2">
<ButtonSecondary type="button" disabled={currentStepIdx === 0} onClick={() => setStep(currentStepIdx - 1)} className="sm:hidden">
{t("shared.back")}
</ButtonSecondary>
{block.canBeDismissed && (
<button
type="button"
className="text-muted-foreground rounded-md px-2 py-2 text-xs hover:underline focus:underline focus:outline-hidden"
onClick={dismiss}
>
{t("shared.dontShowThisAgain")}
</button>
)}
</div>
<div className="flex items-center justify-end space-x-2 truncate px-2 py-2">
<ButtonSecondary type="button" disabled={currentStepIdx === 0} onClick={() => setStep(currentStepIdx - 1)} className="hidden sm:block">
{t("shared.back")}
</ButtonSecondary>
<ButtonSecondary
disabled={block.steps.length === currentStepIdx + 1}
type="button"
onClick={onNext}
className={clsx(block.steps.length === currentStepIdx + 1 && "hidden sm:block")}
>
{t("shared.next")}
</ButtonSecondary>
<ButtonPrimary
disabled={block.steps.length !== currentStepIdx + 1}
type="button"
onClick={onComplete}
className={clsx(block.steps.length !== currentStepIdx + 1 && "hidden sm:block")}
>
{t("shared.complete")}
</ButtonPrimary>
</div>
</div>
</div>
</Modal>
);
}
function OnboardingStep({
step,
onLinkClick,
onUpdate,
}: {
step: OnboardingStepBlockDto;
onLinkClick: (link: { text: string; href: string }) => void;
onUpdate: (state: { [key: string]: string }) => void;
}) {
const { t } = useTranslation();
const [state, setState] = useState<{ [key: string]: string }>({});
useEffect(() => {
if (onUpdate) {
onUpdate(state);
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [state]);
return (
<div className="space-y-2">
{step.description && (
<div className="prose">
<div
dangerouslySetInnerHTML={{
__html: renderSanitizedMarkdown(step.description),
}}
/>
</div>
)}
{step.links && step.links.length > 0 && (
<div className="-mx-0.5 flex flex-wrap items-center">
{step.links.map((link, idx) => {
return (
<div key={idx} className="p-0.5">
<button
type="button"
onClick={() => onLinkClick(link)}
className={clsx(
"rounded-md px-2 py-1 text-sm",
link.isPrimary ? "bg-theme-700 text-white" : "border-border text-foreground bg-secondary/90 border"
)}
>
{t(link.text)}
</button>
</div>
);
})}
</div>
)}
{step.gallery && step.gallery.length > 0 && (
<div className="flex flex-col justify-center space-y-2">
<CustomCarousel items={step.gallery} />
{/* {step.gallery.map((galleryItem, idx) => {
return (
<Fragment key={idx}>
{galleryItem.type === "image" && (
<img
alt={galleryItem.title && t(galleryItem.title)}
className="rounded-md border border-dashed border-border object-cover shadow-md"
src={galleryItem.src}
/>
)}
{galleryItem.type === "video" && (
<iframe
src={galleryItem?.src}
title={galleryItem?.title ?? ""}
frameBorder="0"
loading="lazy"
className="rounded-md border border-dashed border-border object-cover shadow-md"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
></iframe>
)}
</Fragment>
);
})} */}
</div>
)}
{step.input && step.input.length > 0 && (
<div className={clsx("truncate p-1", OnboardingGridUtils.getClasses(step.inputGrid ?? { columns: "2", gap: "sm" }))}>
{step.input.map((input, idx) => {
return (
<div key={idx}>
{input.type === "text" && (
<InputText
name={input.name}
title={t(input.title)}
required={input.isRequired}
value={state?.[input.name] ?? ""}
setValue={(e) => setState({ ...state, [input.name]: e.toString() })}
/>
)}
{input.type === "select" && (
<InputSelect
name={input.name}
title={t(input.title)}
required={input.isRequired}
options={
input.options?.map((f) => {
return { value: f.value, name: t(f.name) };
}) ?? []
}
value={state?.[input.name] ?? ""}
setValue={(e) => setState({ ...state, [input.name]: e?.toString() ?? "" })}
/>
)}
</div>
);
})}
</div>
)}
</div>
);
}
@@ -0,0 +1,6 @@
import { useTranslation } from "react-i18next";
export default function OnboardingVariantPage() {
const { t } = useTranslation();
return <div>{t("onboarding.block.variantPageFallback")}</div>;
}
@@ -0,0 +1,118 @@
import { OnboardingStepBlockDto } from "../OnboardingBlockUtils";
import { t as i18nT } from "i18next";
export const defaultOnboardingStepBlocks: OnboardingStepBlockDto[] = [
{
id: "1",
title: i18nT("onboarding.block.samples.welcome.title"),
description: i18nT("onboarding.block.samples.welcome.description"),
links: [],
gallery: [],
input: [],
icon: '<svg className={className} fill="currentColor" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" width="32" height="32" viewBox="0 0 32 32"> <path d="M 19 6 L 19 7.4375 L 19.09375 7.625 L 20.125 10 L 11.4375 10 L 11.125 10.4375 L 8.40625 14.28125 C 7.800781 14.09375 7.164063 14 6.5 14 C 2.917969 14 0 16.914063 0 20.5 C 0 24.085938 2.914063 27 6.5 27 C 9.914063 27 12.707031 24.347656 12.96875 21 L 16.40625 21 L 16.71875 20.5625 L 21.59375 13.375 L 22.25 14.875 C 20.308594 16.003906 19 18.109375 19 20.5 C 19 24.070313 21.929688 27 25.5 27 C 29.070313 27 32 24.070313 32 20.5 C 32 16.929688 29.070313 14 25.5 14 C 25.019531 14 24.546875 14.054688 24.09375 14.15625 L 21.40625 8 L 24.5 8 C 24.785156 8 25 8.214844 25 8.5 C 25 8.785156 24.785156 9 24.5 9 L 24.5 11 C 25.867188 11 27 9.867188 27 8.5 C 27 7.132813 25.867188 6 24.5 6 Z M 8 7 L 8 9 L 14 9 L 13 7 Z M 13.46875 12 L 20.125 12 L 16.09375 17.9375 Z M 11.71875 13 L 14.34375 19 L 6 19 L 6 21 L 10.9375 21 C 10.683594 23.242188 8.808594 25 6.5 25 C 4.019531 25 2 22.980469 2 20.5 C 2 18.019531 4.019531 16 6.5 16 C 8.058594 16 9.441406 16.796875 10.25 18 L 12.5 18 C 12.019531 16.847656 11.230469 15.859375 10.21875 15.15625 Z M 25.5 16 C 27.980469 16 30 18.019531 30 20.5 C 30 22.980469 27.980469 25 25.5 25 C 23.019531 25 21 22.980469 21 20.5 C 21 18.925781 21.832031 17.554688 23.0625 16.75 L 25.09375 21.40625 L 26.90625 20.59375 L 24.9375 16.0625 C 25.125 16.039063 25.308594 16 25.5 16 Z"></path> </svg>',
},
{
id: "2",
title: i18nT("onboarding.block.samples.filters.title"),
description: i18nT("onboarding.block.samples.filters.description"),
links: [],
gallery: [],
input: [],
icon: '<svg className={className} xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" strokeWidth={2}> <path strokeLinecap="round" strokeLinejoin="round" d="M3 4a1 1 0 011-1h16a1 1 0 011 1v2.586a1 1 0 01-.293.707l-6.414 6.414a1 1 0 00-.293.707V17l-4 4v-6.586a1 1 0 00-.293-.707L3.293 7.293A1 1 0 013 6.586V4z" /> </svg>',
},
{
id: "3",
title: i18nT("onboarding.block.samples.steps.title"),
description: i18nT("onboarding.block.samples.steps.description"),
links: [],
gallery: [],
input: [],
icon: '<svg className={className} xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" strokeWidth={2}> <path strokeLinecap="round" strokeLinejoin="round" d="M13 10V3L4 14h7v7l9-11h-7z" /> </svg>',
},
{
id: "4",
title: i18nT("onboarding.block.samples.links.title"),
description: i18nT("onboarding.block.samples.links.description"),
links: [
{
text: i18nT("onboarding.block.samples.links.profileLink"),
href: "$appOrAdmin/settings/profile",
isPrimary: true,
},
{
text: i18nT("onboarding.block.samples.links.newTabLink"),
href: "https://example.com",
isPrimary: false,
target: "_blank",
},
],
gallery: [],
input: [],
icon: '<svg xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" width="50" height="50" viewBox="0 0 50 50" className={className} fill="currentColor"> {" "} <path d="M 37 4 C 34.596 4 32.336719 4.9367188 30.636719 6.6367188 L 25.636719 11.636719 C 24.191719 13.081719 23.2985 14.930688 23.0625 16.929688 C 23.0215 17.281688 23 17.64 23 18 C 23 19.368 23.313672 20.686766 23.888672 21.884766 L 25.414062 20.357422 C 25.147062 19.609422 25 18.817 25 18 C 25 16.13 25.728781 14.373781 27.050781 13.050781 L 32.050781 8.0507812 C 33.373781 6.7287812 35.13 6 37 6 C 38.87 6 40.626219 6.7287812 41.949219 8.0507812 C 43.272219 9.3727813 44 11.13 44 13 C 44 14.87 43.271219 16.626219 41.949219 17.949219 L 36.949219 22.949219 C 35.626219 24.271219 33.87 25 32 25 C 31.183 25 30.390578 24.852938 29.642578 24.585938 L 28.115234 26.111328 C 29.313234 26.686328 30.632 27 32 27 C 34.404 27 36.663281 26.063281 38.363281 24.363281 L 43.363281 19.363281 C 45.063281 17.663281 46 15.404 46 13 C 46 10.596 45.063281 8.3367187 43.363281 6.6367188 C 41.663281 4.9367187 39.404 4 37 4 z M 30.980469 17.990234 A 1.0001 1.0001 0 0 0 30.292969 18.292969 L 18.292969 30.292969 A 1.0001 1.0001 0 1 0 19.707031 31.707031 L 31.707031 19.707031 A 1.0001 1.0001 0 0 0 30.980469 17.990234 z M 18 23 C 15.596 23 13.336719 23.936719 11.636719 25.636719 L 6.6367188 30.636719 C 5.0727187 32.199719 4.1545781 34.236828 4.0175781 36.423828 C 4.0055781 36.614828 4 36.807 4 37 C 4 39.404 4.9367188 41.663281 6.6367188 43.363281 C 8.3367187 45.063281 10.596 46 13 46 C 15.404 46 17.663281 45.063281 19.363281 43.363281 L 24.363281 38.363281 C 26.063281 36.663281 27 34.404 27 32 C 27 30.632 26.686328 29.313234 26.111328 28.115234 L 24.585938 29.642578 C 24.852938 30.390578 25 31.183 25 32 C 25 33.87 24.271219 35.626219 22.949219 36.949219 L 17.949219 41.949219 C 16.626219 43.271219 14.87 44 13 44 C 11.13 44 9.3737813 43.271219 8.0507812 41.949219 C 6.7277812 40.627219 6 38.87 6 37 C 6 35.13 6.7287812 33.373781 8.0507812 32.050781 L 13.050781 27.050781 C 14.373781 25.728781 16.13 25 18 25 C 18.817 25 19.609422 25.147062 20.357422 25.414062 L 21.884766 23.888672 C 20.686766 23.313672 19.368 23 18 23 z"></path> </svg>',
},
{
id: "5",
title: i18nT("onboarding.block.samples.media.title"),
description: i18nT("onboarding.block.samples.media.description"),
links: [],
gallery: [
{
id: "1",
type: "video",
title: i18nT("onboarding.block.samples.media.pageBlockBuilder"),
src: "https://www.loom.com/embed/eccf927d35cd4ad3b4a1d512257cea53",
},
{
id: "2",
type: "image",
title: i18nT("onboarding.block.samples.media.adminPortal"),
src: "https://placehold.co/1200x800?text=Admin+Portal",
},
],
input: [],
icon: '<svg className={className} xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke="currentColor" strokeWidth={2}> <path strokeLinecap="round" strokeLinejoin="round" d="M15.172 7l-6.586 6.586a2 2 0 102.828 2.828l6.414-6.586a4 4 0 00-5.656-5.656l-6.415 6.585a6 6 0 108.486 8.486L20.5 13" /> </svg>',
},
{
id: "6",
title: i18nT("onboarding.block.samples.inputs.title"),
description: i18nT("onboarding.block.samples.inputs.description"),
links: [],
gallery: [],
input: [
{ id: "1", type: "text", name: "firstName", title: i18nT("onboarding.block.samples.inputs.firstName"), isRequired: true, options: [] },
{ id: "2", type: "text", name: "lastName", title: i18nT("onboarding.block.samples.inputs.lastName"), isRequired: false, options: [] },
{
id: "3",
type: "select",
name: "whereDidYouHearAboutUs",
title: i18nT("onboarding.block.defaults.sourceQuestion"),
isRequired: false,
options: [
{ value: "google", name: i18nT("onboarding.block.samples.inputs.sources.google") },
{ value: "youtube", name: i18nT("onboarding.block.samples.inputs.sources.youtube") },
{ value: "twitter", name: i18nT("onboarding.block.samples.inputs.sources.twitter") },
{ value: "other", name: i18nT("onboarding.block.samples.inputs.sources.other") },
],
},
],
icon: '<svg className={clsx(className, "h-5 w-5 shrink-0")} xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" width="24" height="24" viewBox="0 0 172 172" fill="currentColor" > <g fill="none" fillRule="nonzero" stroke="none" strokeWidth="1" strokeLinecap="butt" strokeLinejoin="miter" strokeMiterlimit="10" strokeDasharray="" strokeDashoffset="0" fontFamily="none" fontWeight="none" fontSize="none" textAnchor="none" > <path d="M0,172v-172h172v172z" fill="none"></path> <g fill="currentColor"> <path d="M146.59473,57.24935c-5.28183,0 -9.90758,1.23715 -13.89941,3.69531c-3.98467,2.451 -7.04629,5.9742 -9.19629,10.56803c-2.14283,4.59384 -3.2194,9.90187 -3.2194,15.92904v3.83528c0,9.44567 2.33353,16.88702 6.9847,22.29785c4.65117,5.41083 11.04261,8.11849 19.16244,8.11849c7.42467,0 13.40816,-1.93175 17.94466,-5.80892c4.5365,-3.87717 7.05009,-9.19203 7.54459,-15.94304v-0.014h-13.03157c-0.29383,3.81983 -1.4442,6.6341 -3.42936,8.45443c-1.98517,1.8275 -4.99348,2.74349 -9.02832,2.74349c-4.46483,0 -7.74101,-1.5573 -9.81218,-4.68913c-2.07117,-3.12467 -3.10742,-8.08556 -3.10742,-14.86523v-4.73112c0.05733,-6.48583 1.16705,-11.2725 3.33138,-14.36133c2.16433,-3.08883 5.40602,-4.63314 9.75618,-4.63314c4.00617,0 6.98784,0.92316 8.94434,2.74349c1.96367,1.82033 3.10686,4.7552 3.42936,8.80436h13.04557c-0.69517,-7.009 -3.27573,-12.4438 -7.74056,-16.32096c-4.46483,-3.87717 -10.36871,-5.82292 -17.67871,-5.82292zM23.58561,58.11719l-23.58561,62.70833h13.88542l4.35319,-12.91959h22.87174l4.40918,12.91959h13.87142l-23.71159,-62.70833zM65.31185,58.11719v62.70833h24.63542c7.19533,-0.05733 12.73058,-1.64195 16.61491,-4.74511c3.8915,-3.10317 5.83691,-7.66229 5.83691,-13.68946c0,-3.53317 -0.94298,-6.52167 -2.81348,-8.95833c-1.8705,-2.43667 -4.43807,-4.06842 -7.68457,-4.87109c2.84517,-1.08933 5.06459,-2.79355 6.66276,-5.13705c1.59816,-2.3435 2.39355,-5.04399 2.39355,-8.11849c0,-5.62583 -1.98539,-9.90478 -5.96289,-12.82161c-3.9775,-2.91683 -9.80692,-4.36719 -17.49675,-4.36719zM78.35742,68.58724h9.1403c3.59767,0 6.2247,0.61465 7.89453,1.86165c1.66983,1.247 2.50553,3.29969 2.50553,6.14486c0,5.08117 -3.29599,7.68189 -9.88216,7.79655h-9.6582zM29.63249,73.96224l7.96452,23.47364h-15.84505zM78.35742,93.5306h11.96777c6.00567,0.086 9.00032,2.99387 9.00032,8.73438c0,2.55133 -0.86235,4.55722 -2.58952,6.00489c-1.72717,1.44767 -4.12016,2.16959 -7.19466,2.16959h-11.18392z"></path> </g> </g> </svg>',
},
{
id: "7",
title: i18nT("onboarding.block.samples.activity.title"),
description: i18nT("onboarding.block.samples.activity.description"),
links: [],
gallery: [],
input: [],
icon: '<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" strokeWidth="1.5" stroke="currentColor" class="w-6 h-6"> <path strokeLinecap="round" strokeLinejoin="round" d="M19.5 14.25v-2.625a3.375 3.375 0 00-3.375-3.375h-1.5A1.125 1.125 0 0113.5 7.125v-1.5a3.375 3.375 0 00-3.375-3.375H8.25m0 12.75h7.5m-7.5 3H12M10.5 2.25H5.625c-.621 0-1.125.504-1.125 1.125v17.25c0 .621.504 1.125 1.125 1.125h12.75c.621 0 1.125-.504 1.125-1.125V11.25a9 9 0 00-9-9z" /> </svg>',
},
{
id: "8",
title: i18nT("onboarding.block.samples.end.title"),
description: "",
links: [],
gallery: [{ id: "1", type: "image", title: "", src: "https://www.gifcen.com/wp-content/uploads/2021/05/the-end-gif-13.gif" }],
input: [],
icon: '<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" strokeWidth={1.5} stroke="currentColor" className="w-6 h-6"> <path strokeLinecap="round" strokeLinejoin="round" d="M9 12.75L11.25 15 15 9.75M21 12c0 1.268-.63 2.39-1.593 3.068a3.745 3.745 0 01-1.043 3.296 3.745 3.745 0 01-3.296 1.043A3.745 3.745 0 0112 21c-1.268 0-2.39-.63-3.068-1.593a3.746 3.746 0 01-3.296-1.043 3.745 3.745 0 01-1.043-3.296A3.745 3.745 0 013 12c0-1.268.63-2.39 1.593-3.068a3.745 3.745 0 011.043-3.296 3.746 3.746 0 013.296-1.043A3.746 3.746 0 0112 3c1.268 0 2.39.63 3.068 1.593a3.746 3.746 0 013.296 1.043 3.746 3.746 0 011.043 3.296A3.745 3.745 0 0121 12z" /> </svg>',
},
];
@@ -0,0 +1,50 @@
import { useEffect, useState } from "react";
import { useTranslation } from "react-i18next";
import InputSelector from "~/components/ui/input/InputSelector";
import { onboardingGridCols, OnboardingGridDto, onboardingGridGaps } from "./OnboardingGridUtils";
export default function OnboardingGridForm({ item, onUpdate }: { item?: OnboardingGridDto; onUpdate: (item: OnboardingGridDto) => void }) {
const { t } = useTranslation();
const [columns, setColumns] = useState(item?.columns);
const [gap, setGap] = useState(item?.gap);
useEffect(() => {
onUpdate({ columns, gap });
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [columns, gap]);
return (
<div className="space-y-1">
<label className="text-muted-foreground flex w-full justify-between gap-2 text-xs font-medium">
<div className="flex items-center gap-1">{t("onboarding.block.grid.title")}</div>
{(gap || columns) && (
<button
type="button"
onClick={() => {
setGap(undefined);
setColumns(undefined);
}}
>
{t("shared.remove")}
</button>
)}
</label>
<div className="grid grid-cols-2 gap-2">
<InputSelector
withSearch={false}
value={columns}
options={onboardingGridCols.map((value) => ({ name: t("onboarding.block.grid.columnsOption", { count: Number(value) }), value }))}
setValue={(value) => setColumns((value as OnboardingGridDto["columns"]) ?? "4")}
selectPlaceholder={t("onboarding.block.grid.columnsPlaceholder")}
/>
<InputSelector
withSearch={false}
value={gap}
options={onboardingGridGaps.map((value) => ({ name: t("onboarding.block.grid.gapOption", { value }), value }))}
setValue={(value) => setGap((value as OnboardingGridDto["gap"]) ?? "sm")}
selectPlaceholder={t("onboarding.block.grid.gapPlaceholder")}
/>
</div>
</div>
);
}
@@ -0,0 +1,35 @@
import clsx from "clsx";
export const onboardingGridCols = ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12"] as const;
export const onboardingGridGaps = ["none", "xs", "sm", "md", "lg"] as const;
export interface OnboardingGridDto {
columns?: (typeof onboardingGridCols)[number];
gap?: (typeof onboardingGridGaps)[number];
}
function getClasses(grid?: OnboardingGridDto) {
return clsx(
"grid",
grid?.gap === "none" && "gap-0",
(!grid?.gap || grid?.gap === "sm") && "gap-4",
grid?.gap === "xs" && "gap-2",
grid?.gap === "md" && "gap-8",
grid?.gap === "lg" && "gap-12",
grid?.columns === "2" && "grid-cols-1 sm:grid-cols-2",
grid?.columns === "3" && "grid-cols-1 sm:grid-cols-2 lg:grid-cols-3",
(!grid?.columns || grid?.columns === "4") && "grid-cols-1 sm:grid-cols-2 lg:grid-cols-4",
grid?.columns === "5" && "grid-cols-1 sm:grid-cols-2 lg:grid-cols-5",
grid?.columns === "6" && "grid-cols-2 sm:grid-cols-3 lg:grid-cols-6",
grid?.columns === "7" && "grid-cols-2 sm:grid-cols-3 lg:grid-cols-7",
grid?.columns === "8" && "grid-cols-2 sm:grid-cols-3 lg:grid-cols-8",
grid?.columns === "9" && "grid-cols-4 sm:grid-cols-4 lg:grid-cols-9",
grid?.columns === "10" && "grid-cols-4 sm:grid-cols-5 lg:grid-cols-10",
grid?.columns === "11" && "grid-cols-4 sm:grid-cols-5 lg:grid-cols-11",
grid?.columns === "12" && "grid-cols-3 sm:grid-cols-4 md:grid-cols-6 lg:grid-cols-8 xl:grid-cols-12"
);
}
export default {
getClasses,
};
@@ -0,0 +1,74 @@
import fs from "node:fs";
import path from "node:path";
import { describe, expect, it } from "vitest";
const sourcePaths = [
"apps/web/app/modules/onboarding/blocks/OnboardingBlockForm.tsx",
"apps/web/app/modules/onboarding/blocks/OnboardingBlockUtils.ts",
"apps/web/app/modules/onboarding/blocks/OnboardingVariantPage.tsx",
"apps/web/app/modules/onboarding/blocks/defaultOnboarding/defaultOnboardingStepBlocks.ts",
"apps/web/app/modules/onboarding/utils/OnboardingStepUtils.tsx",
].map((file) => path.resolve(process.cwd(), file));
describe("onboarding block form i18n", () => {
it("uses semantic translation keys for visible block editor labels and defaults", () => {
const source = sourcePaths.map((sourcePath) => fs.readFileSync(sourcePath, "utf8")).join("\n");
expect(source).toContain("onboarding.block.canBeDismissed");
expect(source).toContain("onboarding.block.stepsDescription");
expect(source).toContain("onboarding.block.actions.addGalleryItem");
expect(source).toContain("onboarding.block.defaultGalleryTitle");
expect(source).toContain("onboarding.block.targetBlank");
expect(source).toContain("onboarding.block.defaults.title");
expect(source).toContain("onboarding.block.defaults.stepTitle");
expect(source).toContain("onboarding.block.defaults.stepDescription");
expect(source).toContain("onboarding.block.defaults.sourceQuestion");
expect(source).toContain("onboarding.block.defaults.primaryLink");
expect(source).toContain("onboarding.block.defaults.secondaryLink");
expect(source).toContain("onboarding.block.defaults.gallery.image1");
expect(source).toContain("onboarding.block.defaults.gallery.image2");
expect(source).toContain("onboarding.block.defaults.useCaseSelect");
expect(source).toContain("onboarding.block.defaults.useCases.research");
expect(source).toContain("onboarding.block.defaults.useCases.personal");
expect(source).toContain("onboarding.block.defaults.useCases.smallBusiness");
expect(source).toContain("onboarding.block.defaults.useCases.largeCompany");
expect(source).toContain("onboarding.block.samples.welcome.title");
expect(source).toContain("onboarding.block.samples.welcome.description");
expect(source).toContain("onboarding.block.samples.filters.title");
expect(source).toContain("onboarding.block.samples.filters.description");
expect(source).toContain("onboarding.block.samples.steps.title");
expect(source).toContain("onboarding.block.samples.steps.description");
expect(source).toContain("onboarding.block.samples.links.title");
expect(source).toContain("onboarding.block.samples.links.description");
expect(source).toContain("onboarding.block.samples.links.profileLink");
expect(source).toContain("onboarding.block.samples.links.newTabLink");
expect(source).toContain("onboarding.block.samples.media.title");
expect(source).toContain("onboarding.block.samples.media.description");
expect(source).toContain("onboarding.block.samples.media.pageBlockBuilder");
expect(source).toContain("onboarding.block.samples.media.adminPortal");
expect(source).toContain("onboarding.block.samples.inputs.title");
expect(source).toContain("onboarding.block.samples.inputs.description");
expect(source).toContain("onboarding.block.samples.inputs.firstName");
expect(source).toContain("onboarding.block.samples.inputs.lastName");
expect(source).toContain("onboarding.block.samples.inputs.sources.google");
expect(source).toContain("onboarding.block.samples.inputs.sources.youtube");
expect(source).toContain("onboarding.block.samples.inputs.sources.twitter");
expect(source).toContain("onboarding.block.samples.inputs.sources.other");
expect(source).toContain("onboarding.block.samples.activity.title");
expect(source).toContain("onboarding.block.samples.activity.description");
expect(source).toContain("onboarding.block.samples.end.title");
expect(source).toContain("onboarding.block.variantPageFallback");
expect(source).toContain("onboarding.stepSummary.linksCount");
expect(source).toContain("onboarding.stepSummary.galleryItemsCount");
expect(source).toContain("onboarding.stepSummary.inputFieldsCount");
expect(source).toContain("shared.notSet");
expect(source).toContain("QuestionMarkFilledIcon");
expect(source).not.toContain("ui.autogenerated");
expect(source).not.toContain('text-red-600">?</span>');
expect(source).not.toContain('title="target=_blank"');
expect(source).not.toContain('"Item "');
expect(source).not.toContain("{block.links.length} links");
expect(source).not.toContain("{block.gallery.length} gallery items");
expect(source).not.toContain("{block.input.length} input fields");
});
});