overview — правило для Claude Code: что делает и как установить
Правило overview для Claude Code задаёт принципы создания доступных и составных UI-компонентов. Оно подключается при проектировании компонентов и их API.
Apache-2.0 ★ 141 обновлён 2026-11-17
.claude/rules/overview.mdЧто делает overview
Правило overview задаёт рекомендации для компонентов, которые должны сочетаться друг с другом, быть доступными и встраиваться в разные кодовые базы. Оно вводит общие термины и опирается на композицию вместо настройки большого числа параметров.
Основные требования касаются доступности по умолчанию, согласованного поведения, понятного API и возможности менять исходный код. Примеры используют React с JSX и TSX, а сами принципы применимы также к Vue, Svelte и Angular. Правило не заменяет документацию фреймворка и не является учебником по React.
Для Claude Code файл размещается по пути .claude/rules/overview.md без пробела внутри пути.
Какие задачи решает
- спроектировать составной API UI-компонента
- заложить доступность в компонент с самого начала
- согласовать компонент с разными кодовыми базами
- описать общие принципы для библиотеки компонентов
Примеры запросов агенту
- Спроектируй доступный составной компонент Button с настраиваемыми вариантами.
- Проверь API React-компонента и сделай его удобным для встраивания в разные проекты.
- Перепиши компонент так, чтобы его исходный код можно было легко менять и расширять.
Как установить overview
Вручную: положить файлы
.claude/rules/overview.mdПоле paths во frontmatter ограничивает файлы
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.cursor/rules/overview.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.github/instructions/overview.instructions.mdПоле applyTo задаёт, к каким файлам применять
Вручную: положить файлы
.devin/rules/overview.mdВручную: положить файлы
.clinerules/overview.mdПо шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать
Вопросы об overview
Как установить overview в Claude Code?
Разместите файл правила по пути .claude/rules/overview.md.
Что делает overview?
Правило задаёт общие рекомендации по созданию составных, доступных и переносимых UI-компонентов. Оно описывает композицию, понятные API и соответствие современным веб-практикам.
К каким фреймворкам применимо overview?
Примеры ориентированы на React с JSX и TSX, а базовые принципы также применимы к Vue, Svelte и Angular.
Исходный текст
overview.md · Apache-2.0
---
title: Components.build Overview
impact: MEDIUM
impactDescription: Foundation for understanding the specification
tags: overview, introduction, philosophy, goals
---
## Components.build Overview
The components.build specification is an open-source standard for building modern, composable, and accessible UI components. It provides high-level guidelines, best practices, and common terminology for designing UI components that integrate smoothly into any codebase.
**What This Specification Is:**
This spec is **not**:
- A tutorial or course on React
- A promotion for any specific component library or registry
- A replacement for framework documentation
This spec **is**:
- A set of high-level guidelines and best practices
- A common terminology for designing UI components
- A standard for ensuring components meet modern expectations
- A framework for creating components that integrate smoothly across projects
**Who This Is For:**
This specification is written for:
- **Open-source maintainers** building and distributing component libraries
- **Senior front-end engineers** designing component APIs and design systems
- **Developers** familiar with JavaScript/TypeScript and React
**Framework Scope:**
While examples use React (with JSX/TSX) for concreteness, the fundamental concepts apply to other frameworks (Vue, Svelte, Angular). The philosophy is **framework-agnostic**.
**Core Goals:**
The specification aims to help developers create components that are:
1. **Composable** - Components combine and nest to create complex UIs
2. **Accessible** - Usable by everyone, including users with disabilities
3. **Easy to adopt** - Integrate smoothly into any codebase
4. **Consistent** - Follow modern expectations and patterns
5. **Well-documented** - Clear guidelines and terminology
**Key Philosophy:**
- **Composition over configuration** - Build flexible, composable APIs
- **Accessibility by default** - Not an afterthought, but a requirement
- **Developer experience** - Components should be easy to understand, customize, and integrate
- **Transparency** - Source code should be inspectable and modifiable
- **Standards alignment** - Follow web standards and modern best practices
**Example:**
The following examples illustrate the difference between components that don't follow the specification and those that do:
**Incorrect:**
```tsx
// Hard-coded styles, no accessibility, not composable
function Button() {
return (
<button
style={{ backgroundColor: "#007bff", color: "white", padding: "10px" }}
>
Click me
</button>
);
}
```
**Correct:**
```tsx
// Composable, accessible, customizable
import { cn } from "@/lib/utils";
interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
variant?: "default" | "outline";
}
export function Button({
className,
variant = "default",
children,
...props
}: ButtonProps) {
return (
<button
className={cn(
"inline-flex items-center justify-center rounded-md px-4 py-2",
"focus-visible:outline-none focus-visible:ring-2",
variant === "default" && "bg-primary text-primary-foreground",
variant === "outline" && "border border-input bg-background",
className
)}
{...props}
>
{children}
</button>
);
}
```
**Specification Authors:**
Co-authored by:
- **Hayden Bleasel** ([@haydenbleasel](https://x.com/haydenbleasel))
- **shadcn** ([@shadcn](https://x.com/shadcn))
Adapted as an AI skill by:
- **Jordan Gilliam** ([@nolansym](https://x.com/nolansym))
Reference: [https://components.build](https://components.build)
© maxtrigify · Apache-2.0 · maxtrigify/Otto