shadcn-ui-conventions

Enforce shadcn/ui conventions for React components with defined imports, types, refs, and lint exclusions.

2.0k|117|Updated Mar 27, 2025
One-click install
npx skills add https://github.com/TheOrcDev/8bitcn-ui --skill shadcn-ui-conventions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: shadcn-ui-conventions
Source: https://github.com/TheOrcDev/8bitcn-ui/tree/main/.claude/skills/shadcn-ui-conventions
Command: npx skills add https://github.com/TheOrcDev/8bitcn-ui --skill shadcn-ui-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill establishes consistent conventions for shadcn/ui styled components used in 8-bit retro UI, ensuring uniform structure, imports, and linting norms across the UI library.

Core Features & Use Cases

  • Conventions for import patterns: Guidance on how to import base vs 8bit components.
  • Type definitions and ref handling: Standardized props and ref patterns for both base and 8bit components.
  • Linting and tooling: Instructions to exclude shadcn/ui from Biome/Ultracite linting and recommended commands.
  • Use Case: When creating a new button, follow these conventions to maintain consistency with existing shadcn/ui integration.

Quick Start

Apply the shadcn-ui-conventions skill to new or updated components to ensure they follow the defined patterns and lint rules. For example, structure a new 8bit component with the retro CSS import path and alias patterns described.

Frequently Asked Questions about shadcn-ui-conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce consistent shadcn-ui component conventions across my React project?

Enforce consistent shadcn-ui conventions by applying standardized import patterns, type definitions, and ref handling across all components. This Skill provides linting rules and structural guidance to maintain uniformity in your 8-bit retro UI library, ensuring new and existing components follow the same conventions.

What import patterns should I use for shadcn-ui base and 8-bit components?

Import patterns differ between base shadcn/ui components and 8-bit styled variants. This Skill defines specific guidance on which imports to use for each type, including alias patterns and path conventions, so all team members structure imports consistently.

How do I handle props and refs in shadcn-ui components following best practices?

Type definitions and ref handling need standardization across shadcn-ui components. This Skill specifies the patterns for props and refs in both base and 8-bit components, ensuring predictable interfaces and proper React ref forwarding throughout your component library.

Why should I exclude shadcn-ui from my linter configuration?

Linting shadcn-ui dependencies can cause unnecessary noise and false positives. This Skill recommends excluding shadcn/ui from Biome or Ultracite linting, with specific commands and tooling instructions, so your linter focuses on your own code quality.

Can I apply these conventions to an existing shadcn-ui project?

Yes. This Skill applies to both new and existing components in React projects using shadcn/ui patterns. Apply the defined conventions when creating new buttons or updating existing components to gradually align your entire library with the standardized structure and imports.

What's the best way to maintain UI consistency across retro-styled shadcn components?

Establish and enforce consistent conventions for component structure, imports, and linting across your 8-bit retro UI library. This Skill provides the complete ruleset—import guidance, type patterns, ref handling, and linting configuration—to keep all components uniform as your project scales.