react-composition-patterns
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseReact Composition Patterns
React组合模式
Composition patterns for building flexible, maintainable React components. Avoid
boolean prop proliferation by using compound components, lifting state, and
composing internals. These patterns make codebases easier for both humans and AI
agents to work with as they scale.
用于构建灵活、可维护的React组件的组合模式。通过使用复合组件、提升状态和组合内部逻辑,避免出现大量布尔型props的问题。这些模式能让代码库在规模扩大时,无论是人类开发者还是AI Agent都能更轻松地协作。
When to Apply
适用场景
Reference these guidelines when:
- Refactoring components with many boolean props
- Building reusable component libraries
- Designing flexible component APIs
- Reviewing component architecture
- Working with compound components or context providers
在以下场景中可以参考这些指南:
- 重构包含大量布尔型props的组件
- 构建可复用组件库
- 设计灵活的组件API
- 评审组件架构
- 处理复合组件或Context Provider
Rule Categories by Priority
按优先级划分的规则类别
| Priority | Category | Impact | Prefix |
|---|---|---|---|
| 1 | Component Architecture | HIGH | |
| 2 | State Management | MEDIUM | |
| 3 | Implementation Patterns | MEDIUM | |
| 优先级 | 类别 | 影响程度 | 前缀 |
|---|---|---|---|
| 1 | 组件架构 | 高 | |
| 2 | 状态管理 | 中 | |
| 3 | 实现模式 | 中 | |
Quick Reference
快速参考
1. Component Architecture (HIGH)
1. 组件架构(高优先级)
- - Don't add boolean props to customize behavior; use composition
architecture-avoid-boolean-props - - Structure complex components with shared context
architecture-compound-components
- - 不要通过添加布尔型props来定制行为;应使用组合方式
architecture-avoid-boolean-props - - 使用共享Context构建复杂组件结构
architecture-compound-components
2. State Management (MEDIUM)
2. 状态管理(中优先级)
- - Provider is the only place that knows how state is managed
state-decouple-implementation - - Define generic interface with state, actions, meta for dependency injection
state-context-interface - - Move state into provider components for sibling access
state-lift-state
- - 只有Provider知晓状态的管理方式
state-decouple-implementation - - 定义包含state、actions、meta的通用接口,用于依赖注入
state-context-interface - - 将状态移至Provider组件中,供同级组件访问
state-lift-state
3. Implementation Patterns (MEDIUM)
3. 实现模式(中优先级)
- - Create explicit variant components instead of boolean modes
patterns-explicit-variants - - Use children for composition instead of renderX props
patterns-children-over-render-props
- - 创建明确的变体组件,而非使用布尔型模式
patterns-explicit-variants - - 使用children进行组合,而非renderX类型的props
patterns-children-over-render-props
How to Use
使用方法
Read individual rule files for detailed explanations and code examples:
rules/architecture-avoid-boolean-props.md
rules/state-context-interface.mdEach rule file contains:
- Brief explanation of why it matters
- Incorrect code example with explanation
- Correct code example with explanation
- Additional context and references
阅读各个规则文件以获取详细说明和代码示例:
rules/architecture-avoid-boolean-props.md
rules/state-context-interface.md每个规则文件包含:
- 简要说明该规则的重要性
- 错误代码示例及解释
- 正确代码示例及解释
- 额外背景信息和参考资料
Full Compiled Document
完整编译文档
For the complete guide with all rules expanded:
AGENTS.md如需查看包含所有规则的完整指南,请参考:
AGENTS.md