关于 react-composition-patterns
这是一组用于构建灵活、易维护 React 组件的指南,面向设计或评审组件 API 的开发者。内容侧重组合、共享上下文和将状态放入 Provider,而非不断增加布尔属性。
主要功能
- 01避免布尔属性膨胀
- 02构建复合组件
- 03解耦状态实现
- 04将状态提升至 Provider
- 05优先使用 children 组合
适用场景
- 01重构布尔属性过多的组件
- 02设计可复用组件库
- 03评审组件架构
- 04使用上下文构建复合组件
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ secondsky/ claude-skills --skill react-composition-patterns安装后在 Claude Code 中输入/react-composition-patterns确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
AGENTS.mdmetadata.jsonrules/_sections.md_template.mdarchitecture-avoid-boolean-props.mdarchitecture-compound-components.mdpatterns-children-over-render-props.mdpatterns-explicit-variants.mdstate-context-interface.mdstate-decouple-implementation.mdstate-lift-state.md详细介绍
React 组合模式
用于构建灵活、易于维护的 React 组件的组合模式。通过使用复合组件、提升状态和组合内部实现,避免布尔属性泛滥。这些模式让代码库在规模增长时更易于人类和 AI Agent 使用。
适用场景
在以下情况下参考这些指南:
- 重构具有许多布尔属性的组件
- 构建可复用的组件库
- 设计灵活的组件 API
- 审查组件架构
- 使用复合组件或上下文提供程序
按优先级划分的规则类别
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | 组件架构 | HIGH | architecture- |
| 2 | 状态管理 | MEDIUM | state- |
| 3 | 实现模式 | MEDIUM | patterns- |
快速参考
1. 组件架构(HIGH)
architecture-avoid-boolean-props- 不要通过添加布尔属性来自定义行为;应使用组合architecture-compound-components- 使用共享上下文构建复杂组件
2. 状态管理(MEDIUM)
state-decouple-implementation- 只有 Provider 知道状态如何管理state-context-interface- 定义包含状态、操作和元数据的通用接口,以便进行依赖注入state-lift-state- 将状态移至 Provider 组件中,以便同级组件访问
3. 实现模式(MEDIUM)
patterns-explicit-variants- 创建明确的变体组件,而非布尔模式patterns-children-over-render-props- 使用 children 进行组合,而非 renderX 属性
使用方法
阅读各规则文件,了解详细说明和代码示例:
rules/architecture-avoid-boolean-props.md
rules/state-context-interface.md
每个规则文件都包含:
- 简要说明其重要性
- 错误代码示例及说明
- 正确代码示例及说明
- 补充背景信息和参考资料
完整汇编文档
如需查看包含所有规则完整内容的指南:AGENTS.md
评论
支持 Markdown