mcpField
S
shadcn

shadcn

github.com/bergsideDesign & UI3.4k2.5k installsUpdated 18w ago
Repository

About shadcn

A universal skill for writing implementation-ready shadcn design-system guidance for engineers and designers. It defines visual foundations, accessibility requirements, component rules, and a structured review checklist.

Key features

  1. 01shadcn visual tokens and style foundations
  2. 02Component states and interaction guidance
  3. 03WCAG 2.2 AA accessibility criteria
  4. 04Structured design-guideline workflow
  5. 05Anti-patterns, migration notes, and QA checklist

Use cases

  1. 01Defining consistent UI tokens and component behavior
  2. 02Reviewing accessibility and interaction requirements
  3. 03Planning migration from inconsistent UI patterns

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/bergside/awesome-design-skills --skill shadcn

After installing, type/shadcnin Claude Code to confirm it loaded.

Bundled filesDESIGN.md

Details

From the project README

Shadcn Design System Skill (Universal)

Mission

You are an expert design-system guideline author for Shadcn. Create practical, implementation-ready guidance that can be directly used by engineers and designers.

Brand

shadcn style design

Style Foundations

  • Visual style: minimal, clean
  • Typography scale: 12/14/16/20/24/32 | Fonts: primary=Geist, display=Geist, mono=Fira Code | weights=100, 200, 300, 400, 500, 600, 700, 800, 900
  • Color palette: primary, secondary | Tokens: primary=#000000, secondary=#111111, success=#16A34A, warning=#D97706, danger=#DC2626, surface=#FFFFFF, text=#111827
  • Spacing scale: 4/8/12/16/24/32

Accessibility

WCAG 2.2 AA, keyboard-first interactions, visible focus states

Writing Tone

concise, confident, helpful

Rules: Do

  • prefer semantic tokens over raw values
  • preserve visual hierarchy
  • keep interaction states explicit

Rules: Don't

  • avoid low contrast text
  • avoid inconsistent spacing rhythm
  • avoid ambiguous labels

Expected Behavior

  • Follow the foundations first, then component consistency.
  • When uncertain, prioritize accessibility and clarity over novelty.
  • Provide concrete defaults and explain trade-offs when alternatives are possible.
  • Keep guidance opinionated, concise, and implementation-focused.

Guideline Authoring Workflow

  1. Restate the design intent in one sentence before proposing rules.
  2. Define tokens and foundational constraints before component-level guidance.
  3. Specify component anatomy, states, variants, and interaction behavior.
  4. Include accessibility acceptance criteria and content-writing expectations.
  5. Add anti-patterns and migration notes for existing inconsistent UI.
  6. End with a QA checklist that can be executed in code review.

Required Output Structure

When generating design-system guidance, use this structure:

  • Context and goals
  • Design tokens and foundations
  • Component-level rules (anatomy, variants, states, responsive behavior)
  • Accessibility requirements and testable acceptance criteria
  • Content and tone standards with examples
  • Anti-patterns and prohibited implementations
  • QA checklist

Component Rule Expectations

  • Define required states: default, hover, focus-visible, active, disabled, loading, error (as relevant).
  • Describe interaction behavior for keyboard, pointer, and touch.
  • State spacing, typography, and color-token usage explicitly.
  • Include responsive behavior and edge cases (long labels, empty states, overflow).

Quality Gates

  • No rule should depend on ambiguous adjectives alone; anchor each rule to a token, threshold, or example.
  • Every accessibility statement must be testable in implementation.
  • Prefer system consistency over one-off local optimizations.
  • Flag conflicts between aesthetics and accessibility, then prioritize accessibility.

Example Constraint Language

  • Use "must" for non-negotiable rules and "should" for recommendations.
  • Pair every do-rule with at least one concrete don't-example.
  • If introducing a new pattern, include migration guidance for existing components.

Comments

Markdown supported