Color
Display color swatches with hex values and click-to-copy capability using the color component for design system and branding documentation.
Use the Color component to showcase color palettes in your documentation. Display colors in a compact grid or organize them in a table with labeled rows.
Compact variant
Display colors in a simple grid layout with color names and values.
<Color variant="compact">
<Color.Item name="blue-500" value="#3B82F6" />
<Color.Item name="blue-600" value="#2563EB" />
<Color.Item name="blue-700" value="#1D4ED8" />
<Color.Item name="blue-800" value="#1E40AF" />
</Color>Table variant
Organize colors into labeled rows for design system documentation.
<Color variant="table">
<Color.Row title="Primary">
<Color.Item name="primary-500" value="#3B82F6" />
<Color.Item name="primary-600" value="#2563EB" />
<Color.Item name="primary-700" value="#1D4ED8" />
</Color.Row>
<Color.Row title="Secondary">
<Color.Item name="secondary-500" value="#8B5CF6" />
<Color.Item name="secondary-600" value="#7C3AED" />
</Color.Row>
</Color>Color formats
The component supports all CSS color formats including hex, rgb, rgba, hsl, and oklch.
<Color variant="compact">
<Color.Item name="hex" value="#FF5733" />
<Color.Item name="rgb" value="rgb(51, 255, 87)" />
<Color.Item name="rgba" value="rgba(51, 87, 255, 0.7)" />
<Color.Item name="hsl" value="hsl(180, 70%, 55%)" />
<Color.Item name="oklch" value="oklch(70% 0.2 145)" />
</Color>Theme-aware colors
Define different colors for light and dark modes using an object with light and dark properties.
<Color variant="compact">
<Color.Item name="bg-primary" value={{ light: "#FFFFFF", dark: "#000000" }} />
<Color.Item name="bg-secondary" value={{ light: "#F9FAFB", dark: "#0A0A0A" }} />
<Color.Item name="text-primary" value={{ light: "#111827", dark: "#F9FAFB" }} />
</Color>Properties
Color
variantstringrequiredDisplay style for the color palette. Options: compact or table.
childrenColor.Item | Color.RowrequiredColor items or rows to display.
Color.Row
titlestringLabel for the row of colors.
childrenColor.ItemrequiredColor items to display in the row.
Color.Item
namestringName or label for the color.
valuestring | { light: string, dark: string }requiredColor value in any CSS format, or an object with light and dark mode values.