
resend-design-system
โ 37by resend ยท part of resend/design-skills
Use when building or modifying UI in the Resend codebase. Provides component APIs, variant options, design tokens, composition patterns for all src/ui/ primitives, and the Resend heuristics for UX decisions like dialog-vs-stepper or disable-vs-hide.
This is the playbook your agent receives when the skill activates โ you don't need to read it to use the skill, but it's here to audit before installing.
Resend Design System
Use primitives from src/ui/ for all UI work. Never create custom components when a primitive exists. Check /design/components pages for live examples.
Quick Reference
All primitives use @/ui/{name} imports. Icons in @/ui/icons/icon-{name}.
Core Components
| Component | Import | Key Variants |
|---|---|---|
| Button | @/ui/button | appearance: white, gray, fade-gray, fade, fade-red, red. size: 1, 2 |
| TextField | @/ui/text-field/text-field | Compound: Root > Slot + Input + Slot. state/size on Input. size: 1, 2, 3 |
| Heading | @/ui/heading | size: 1-8. color: white, gray. weight: medium, semibold, bold |
| Text | @/ui/text | size: 1-9. color: white, gray, red, yellow |
| Tag | @/ui/tag | appearance: gray, green, red, yellow, blue, orange, violet, sand |
| Banner | @/ui/banner | Page/section-level messages (role="alert"). Auto icon. green=success, yellow=warning, red=error, blue=info. Use Tag for inline item labels |
| Select | @/ui/select | Namespace: Root > Trigger + Content > Item. For value selection (forms) |
| Dialog | @/ui/dialog | Namespace: Root > Trigger + Content > Title. size: 1, 2, full-screen |
| Switch | @/ui/switch | checked, onCheckedChange, disabled |
| Checkbox | @/ui/checkbox | checked (boolean | 'indeterminate'), onCheckedChange |
| IconButton | @/ui/icon-button | Same variants as Button. Always provide aria-label |
| DropdownMenu | @/ui/dropdown-menu | Namespace: Root > Trigger + Content > Item. For actions, not value selection |
Sizing Scale
| Size | Height | Text | Radius |
|---|---|---|---|
'1' | h-6 | text-xs | rounded-lg |
'2' | h-8 | text-sm | rounded-xl |
'3' | h-10 | text-sm | rounded-xl |
Color Conventions
- Primary action:
appearance="white"(inverted black/white, flips in dark mode) - Secondary:
appearance="gray" - Subtle/ghost:
appearance="fade"orappearance="fade-gray" - Destructive:
appearance="red"orappearance="fade-red"
Key Rules
- Use
cn()from@/lib/cnfor class merging - Use
@/absolute imports everywhere - Prefer Server Components;
'use client'only at lowest interactive leaf โ extract the interactive part into a small leaf component, don't mark the whole page client - Use sentence case for all UI copy
- State via
stateprop, not booleans โstate="loading",state="disabled",state="invalid",state="read-only". Each value is self-sufficient:state="loading"already prevents interaction, so don't also adddisabled={} - Compound TextField:
TextField.Root > TextField.Slot? + TextField.Input + TextField.Slot?โstateandsizego onTextField.Input, not Root. Use<TextField.Error message={msg} id="x" />inside a trailing Slot for validation errors โ it auto-wiresaria-describedby. Don't also passerror=on Input or setaria-describedbymanually. - Radix namespaces:
import * as Select from '@/ui/select' asChildfor links:<Button asChild><Link href="/x">Label</Link></Button>โ also works on Dialog.Trigger, Tooltip.Trigger
Server vs Client
Already client (built-in, no extra 'use client' needed on your part): TextField, Checkbox, Dialog, Drawer, Collapsible, Calendar, BulkActions.
Server-safe: Button, Heading, Text, Tag, Banner, Card, EmptyState, Kbd, IconButton.
Correct pattern โ extract only the interactive leaf:
// page.tsx โ Server Component
export default function Page() {
return <Card><Heading>Title</Heading><DeleteDialog /></Card>;
}
// delete-dialog.tsx โ small Client Component
'use client';
export function DeleteDialog() {
return (
<Dialog.Root>
<Dialog.Trigger asChild><Button appearance="fade-red">Delete</Button></Dialog.Trigger>
<Dialog.Content size="1"><Dialog.Title>Confirm delete</Dialog.Title></Dialog.Content>
</Dialog.Root>
);
}References
For detailed documentation, load these as needed:
design-system/references/components.mdโ Full component catalog with all props and usagedesign-system/references/design-tokens.mdโ Colors, typography, shadows, animationsdesign-system/references/component-conventions.mdโ Code conventions: CVA variants, compound components, asChild / slot systemdesign-system/references/patterns/README.mdโ Documented UI composition patterns (compositions of primitives, not code conventions). Load when asked "what pattern applies to X?"design-system/references/heuristics.mdโ Index of UX heuristics: which pattern fits a task (dialog vs stepper, disable vs hide, error surfaces, etc.). Guidelines, not rules โ escalate to@designwhen a screen has reason to deviate
npx skills add https://github.com/resend/design-skills --skill resend-design-systemRun this in your project โ your agent picks the skill up automatically.
No common issues documented yet. If you hit a problem, the repository's GitHub Issues page is the best place to look.