Get the FREE Ultimate OpenClaw Setup Guide →

vercel-design-guidelines

Scanned
npx machina-cli add skill tylergibbs1/codewarden/vercel-design-guidelines --openclaw
Files (1)
SKILL.md
4.0 KB

Vercel Design Guidelines

Review web interfaces against Vercel's comprehensive design guidelines and propose fixes.

How It Works

  1. Read the user's code (components, CSS, HTML)
  2. Check against Vercel design guidelines (interactions, animations, layout, content, forms, performance, design, copywriting)
  3. Report violations with specific line references
  4. Propose concrete fixes with code examples

Usage

When a user asks to review their UI or check against design guidelines:

  1. Fetch the live guidelines from https://vercel.com/design/guidelines
  2. Read the relevant source files (components, styles, HTML)
  3. Analyze the code against each applicable guideline category
  4. Report findings grouped by category with severity

Guidelines URL: https://vercel.com/design/guidelines

Always fetch fresh guidelines to ensure you're checking against the latest standards.

Audit Categories

  • Interactions: Keyboard accessibility, focus management, hit targets, loading states, URL persistence
  • Animations: Reduced motion, GPU acceleration, easing, interruptibility
  • Layout: Optical adjustment, alignment, responsive testing, safe areas
  • Content: Inline help, skeletons, empty states, typography, accessibility
  • Forms: Labels, validation, autocomplete, error handling, submit behavior
  • Performance: Re-renders, layout thrashing, virtualization, preloading
  • Design: Shadows, borders, radii, contrast, color accessibility
  • Copywriting: Active voice, title case, clarity, error messaging

Output Format

Present findings as:

## {Category} Issues

### {Severity}: {Guideline Name}
**File:** `path/to/file.tsx:42`
**Issue:** {Description of the violation}
**Guideline:** {Brief guideline reference}
**Fix:**
```{language}
{Proposed code fix}

Severity levels:
- **Critical**: Accessibility violations, broken functionality
- **Warning**: UX issues, performance concerns
- **Suggestion**: Polish, best practices

## Example Review

Interactions Issues

Critical: Keyboard Accessibility

File: components/Modal.tsx:28 Issue: Modal lacks focus trap - keyboard users can tab outside Guideline: Implement focus traps per WAI-ARIA patterns Fix:

// Add focus trap using @radix-ui/react-focus-guards or similar
import { FocusScope } from '@radix-ui/react-focus-scope';

<FocusScope trapped>
  <ModalContent>{children}</ModalContent>
</FocusScope>

Warning: Loading State Duration

File: components/Button.tsx:15 Issue: No minimum loading duration - causes flicker on fast responses Guideline: Add 150-300ms delay and 300-500ms minimum visibility Fix:

const [isLoading, setIsLoading] = useState(false);
const minimumLoadingTime = 300;

async function handleClick() {
  setIsLoading(true);
  const start = Date.now();
  await action();
  const elapsed = Date.now() - start;
  if (elapsed < minimumLoadingTime) {
    await new Promise(r => setTimeout(r, minimumLoadingTime - elapsed));
  }
  setIsLoading(false);
}

## Quick Checklist

For rapid reviews, check these high-impact items first:

- [ ] All interactive elements keyboard accessible
- [ ] Visible focus rings on focusable elements
- [ ] Hit targets ≥24px (44px on mobile)
- [ ] Form inputs have associated labels
- [ ] Loading states don't flicker
- [ ] `prefers-reduced-motion` respected
- [ ] No `transition: all`
- [ ] Errors show how to fix, not just what's wrong
- [ ] Color contrast meets APCA standards
- [ ] No zoom disabled

## Present Results to User

After reviewing:

Design Guidelines Audit

Reviewed {N} files against Vercel design guidelines.

Summary

  • Critical: {N} issues
  • Warning: {N} issues
  • Suggestions: {N} items

{Detailed findings by category}

Recommended Priority

  1. {First critical fix}
  2. {Second critical fix} ...

Source

git clone https://github.com/tylergibbs1/codewarden/blob/main/skills/vercel-design-guidelines/SKILL.mdView on GitHub

Overview

Review web interfaces against Vercel's comprehensive design guidelines and identify violations across interactions, animations, layout, content, forms, performance, design, and copywriting. It reports issues with line references and proposes concrete fixes with code examples to align with the latest standards.

How This Skill Works

Reads the project's code (components, CSS, HTML), fetches the latest guidelines from the vercel design guidelines URL, and analyzes alignment across guideline categories. Results are grouped by category with severity and line references, and include concrete fixes with runnable code samples.

When to Use It

  • review my UI
  • check accessibility
  • audit design
  • review UX
  • apply Vercel design guidelines

Quick Start

  1. Step 1: Fetch the live guidelines from https://vercel.com/design/guidelines.
  2. Step 2: Read relevant source files (components, styles, HTML) for the UI.
  3. Step 3: Analyze against each guideline category, report findings with severity, and propose concrete fixes with code examples.

Best Practices

  • Ensure all interactive elements are keyboard accessible and show visible focus rings.
  • Use hit targets of at least 24px (44px on mobile) and maintain consistent spacing.
  • Respect prefers-reduced-motion and minimize or replace non-essential animations.
  • Avoid transition: all; enforce meaningful properties and ensure sufficient color contrast (APCA).
  • Provide inline help, skeletons for loading, and explicit error messaging with actionable fixes, including labels for all form controls.

Example Use Cases

  • Critical: Keyboard accessibility - Missing focus trap in Modal.tsx:28
  • Warning: Loading state flicker - No minimum loading duration in Button.tsx:15
  • Warning: Low color contrast in NavBar.tsx:10
  • Suggestion: Remove 'transition: all' usage in Card.tsx:42
  • Warning: Form input lacks an associated label in Form.tsx:22

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers