AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.
docs(frontend): document spacing tokens (#10155)
Ubbe5dafc086fba2
diff --git a/autogpt_platform/frontend/src/stories/Spacing.stories.tsx b/autogpt_platform/frontend/src/stories/Spacing.stories.tsxnew file mode 100644index 0000000000..59d97da3af--- /dev/null+++ b/autogpt_platform/frontend/src/stories/Spacing.stories.tsx@@ -0,0 +1,275 @@+import type { Meta, StoryObj } from "@storybook/react";+import { Text } from "@/components/_new/Text/Text";+import { StoryCode } from "@/stories/helpers/StoryCode";+import { SquareArrowOutUpRight } from "lucide-react";++const meta: Meta = {+ title: "Design System/ Tokens /Spacing",+ parameters: {+ layout: "fullscreen",+ controls: { disable: true },+ },+};++export default meta;++// Spacing scale data with rem and px values+// https://tailwindcss.com/docs/spacing+const spacingScale = [+ { name: "0", value: "0", rem: "0rem", px: "0px", class: "m-0" },+ { name: "px", value: "1px", rem: "0.0625rem", px: "1px", class: "m-px" },+ {+ name: "0.5",+ value: "0.125rem",+ rem: "0.125rem",+ px: "2px",+ class: "m-0.5",+ },+ { name: "1", value: "0.25rem", rem: "0.25rem", px: "4px", class: "m-1" },+ {+ name: "1.5",+ value: "0.375rem",+ rem: "0.375rem",+ px: "6px",+ class: "m-1.5",+ },+ { name: "2", value: "0.5rem", rem: "0.5rem", px: "8px", class: "m-2" },+ {+ name: "2.5",+ value: "0.625rem",+ rem: "0.625rem",+ px: "10px",+ class: "m-2.5",+ },+ { name: "3", value: "0.75rem", rem: "0.75rem", px: "12px", class: "m-3" },+ {+ name: "3.5",+ value: "0.875rem",+ rem: "0.875rem",+ px: "14px",+ class: "m-3.5",+ },+ { name: "4", value: "1rem", rem: "1rem", px: "16px", class: "m-4" },+ { name: "5", value: "1.25rem", rem: "1.25rem", px: "20px", class: "m-5" },+ { name: "6", value: "1.5rem", rem: "1.5rem", px: "24px", class: "m-6" },+ { name: "7", value: "1.75rem", rem: "1.75rem", px: "28px", class: "m-7" },+ { name: "8", value: "2rem", rem: "2rem", px: "32px", class: "m-8" },+ { name: "9", value: "2.25rem", rem: "2.25rem", px: "36px", class: "m-9" },+ { name: "10", value: "2.5rem", rem: "2.5rem", px: "40px", class: "m-10" },+ { name: "11", value: "2.75rem", rem: "2.75rem", px: "44px", class: "m-11" },+ { name: "12", value: "3rem", rem: "3rem", px: "48px", class: "m-12" },+ { name: "14", value: "3.5rem", rem: "3.5rem", px: "56px", class: "m-14" },+ { name: "16", value: "4rem", rem: "4rem", px: "64px", class: "m-16" },+ { name: "20", value: "5rem", rem: "5rem", px: "80px", class: "m-20" },+ { name: "24", value: "6rem", rem: "6rem", px: "96px", class: "m-24" },+ { name: "28", value: "7rem", rem: "7rem", px: "112px", class: "m-28" },+ { name: "32", value: "8rem", rem: "8rem", px: "128px", class: "m-32" },+ { name: "36", value: "9rem", rem: "9rem", px: "144px", class: "m-36" },+ { name: "40", value: "10rem", rem: "10rem", px: "160px", class: "m-40" },+ { name: "44", value: "11rem", rem: "11rem", px: "176px", class: "m-44" },+ { name: "48", value: "12rem", rem: "12rem", px: "192px", class: "m-48" },+ { name: "52", value: "13rem", rem: "13rem", px: "208px", class: "m-52" },+ { name: "56", value: "14rem", rem: "14rem", px: "224px", class: "m-56" },+ { name: "60", value: "15rem", rem: "15rem", px: "240px", class: "m-60" },+ { name: "64", value: "16rem", rem: "16rem", px: "256px", class: "m-64" },+ { name: "72", value: "18rem", rem: "18rem", px: "288px", class: "m-72" },+ { name: "80", value: "20rem", rem: "20rem", px: "320px", class: "m-80" },+ { name: "96", value: "24rem", rem: "24rem", px: "384px", class: "m-96" },+];++export function AllVariants() {+ return (+ <div className="space-y-12">+ {/* Spacing System Documentation */}+ <div className="space-y-8">+ <div>+ <Text variant="h1" className="mb-4 text-zinc-800">+ Spacing System+ </Text>+ <Text variant="large" className="text-zinc-600">+ Our spacing system uses a consistent scale based on rem units to+ ensure proper spacing relationships across all components and+ layouts. The spacing tokens are identical for both margin and+ padding utilities.+ </Text>+ </div>++ <div className="grid gap-8 md:grid-cols-2">+ <div>+ <Text+ variant="h2"+ className="mb-2 text-xl font-semibold text-zinc-800"+ >+ Tailwind utilities+ </Text>+ <div className="space-y-4">+ <div className="rounded-lg border border-gray-200 p-4">+ <a+ href="https://tailwindcss.com/docs/margin"+ target="_blank"+ rel="noopener noreferrer"+ className="mb-2 inline-flex flex-row items-center gap-1 text-base font-semibold text-blue-600 hover:underline"+ >+ Margin Classes{" "}+ <SquareArrowOutUpRight className="inline-block h-3 w-3" />+ </a>+ <Text variant="body" className="mb-2 text-zinc-600">+ Used for external spacing between elements+ </Text>+ <div className="font-mono text-sm text-zinc-800">+ m-4 → margin: 1rem (16px)+ </div>+ </div>+ <div className="rounded-lg border border-gray-200 p-4">+ <a+ href="https://tailwindcss.com/docs/padding"+ target="_blank"+ rel="noopener noreferrer"+ className="mb-2 inline-flex flex-row items-center gap-1 text-base font-semibold text-blue-600 hover:underline"+ >+ Padding Classes+ <SquareArrowOutUpRight className="inline-block h-3 w-3" />+ </a>++ <Text variant="body" className="mb-2 text-zinc-600">+ Used for internal spacing within elements (same scale as+ margin)+ </Text>+ <div className="font-mono text-sm text-zinc-800">+ p-4 → padding: 1rem (16px)+ </div>+ </div>+ <Text variant="body" className="mb-4 text-zinc-600">+ We follow Tailwind CSS spacing system, which means you can use+ any spacing token available in the default Tailwind theme for+ margins and padding.+ </Text>+ </div>+ </div>++ <div>+ <Text+ variant="h2"+ className="mb-2 text-xl font-semibold text-zinc-800"+ >+ FAQ+ </Text>+ <div className="space-y-4">+ <Text+ variant="h3"+ className="mb-2 text-base font-semibold text-zinc-800"+ >+ 🤔 Why use spacing tokens?+ </Text>+ <div className="space-y-3 text-zinc-600">+ <Text variant="body">+ Always use spacing classes instead of arbitrary values.+ Reasons:+ </Text>+ <ul className="ml-4 list-disc space-y-1 text-sm">+ <li>Ensures consistent spacing relationships</li>+ <li>Makes responsive design easier with consistent ratios</li>+ <li>Provides a harmonious visual rhythm</li>+ <li>Easier to maintain and update globally</li>+ <li>Prevents spacing inconsistencies across the app</li>+ </ul>+ </div>+ <div>+ <Text+ variant="h3"+ className="mb-2 text-base font-semibold text-zinc-800"+ >+ 📏 How to choose spacing values?+ </Text>+ <div className="space-y-2 text-zinc-600">+ <Text variant="body">+ • <strong>1-2:</strong> Tight spacing, form elements+ </Text>+ <Text variant="body">+ • <strong>3-4:</strong> Default component spacing+ </Text>+ <Text variant="body">+ • <strong>6-8:</strong> Section spacing+ </Text>+ <Text variant="body">+ • <strong>12+:</strong> Major layout divisions+ </Text>+ </div>+ </div>+ </div>+ </div>+ </div>+ </div>++ {/* Complete Spacing Scale */}+ <div className="space-y-8">+ <div>+ <Text+ variant="h2"+ className="mb-2 text-xl font-semibold text-zinc-800"+ >+ Complete Spacing Scale+ </Text>+ <Text variant="body" className="mb-6 text-zinc-600">+ All available spacing values in our design system. Each value works+ for both margin and padding.+ </Text>+ </div>++ <div className="space-y-4">+ {spacingScale.map((space) => (+ <div+ key={space.name}+ className="flex items-center rounded-lg border border-gray-200 p-4"+ >+ <div className="flex w-32 flex-col">+ <Text variant="body-medium" className="font-mono text-zinc-800">+ {space.name}+ </Text>+ <Text variant="small" className="font-mono text-zinc-500">+ {space.class}+ </Text>+ </div>+ <div className="flex w-32 flex-col text-right">+ <p className="font-mono text-xs text-zinc-500">{space.rem}</p>+ <p className="font-mono text-xs text-zinc-500">{space.px}</p>+ </div>+ <div className="ml-8 flex-1">+ <div className="relative h-6 bg-gray-50">+ <div+ className="absolute left-0 top-0 h-full bg-blue-500"+ style={{ width: space.value }}+ ></div>+ </div>+ </div>+ </div>+ ))}+ </div>++ <StoryCode+ code={`// Spacing scale examples+<div className="m-0">No margin (0px)</div>+<div className="m-px">1px margin</div>+<div className="m-1">0.25rem margin (4px)</div>+<div className="m-2">0.5rem margin (8px)</div>+<div className="m-4">1rem margin (16px)</div>+<div className="m-8">2rem margin (32px)</div>+<div className="m-16">4rem margin (64px)</div>++// Directional spacing+<div className="mt-4">Margin top</div>+<div className="mr-4">Margin right</div>+<div className="mb-4">Margin bottom</div>+<div className="ml-4">Margin left</div>+<div className="mx-4">Margin horizontal</div>+<div className="my-4">Margin vertical</div>++// Padding uses identical values+<div className="p-4 pt-8 px-6">Mixed padding</div>`}+ />+ </div>+ </div>+ );+}++type Story = StoryObj<typeof meta>;diff --git a/autogpt_platform/frontend/src/stories/Typography.stories.tsx b/autogpt_platform/frontend/src/stories/Typography.stories.tsxindex cf31899f59..493cab98c4 100644--- a/autogpt_platform/frontend/src/stories/Typography.stories.tsx+++ b/autogpt_platform/frontend/src/stories/Typography.stories.tsx@@ -7,6 +7,7 @@ const meta: Meta<typeof Text> = {component: Text,parameters: {layout: "fullscreen",+ controls: { disable: true },},};