playbooks

home / skills / trsoliu / mini-wiki / composition-patterns

composition-patterns skill

/plugins/agent-skills-main/skills/composition-patterns

This skill helps you refactor React components by applying scalable composition patterns to reduce boolean props and clarify APIs.

npx playbooks add skill trsoliu/mini-wiki --skill composition-patterns

Review the files below or copy the command above to add this skill to your agents.

Files (13)
SKILL.md
2.5 KB
---
name: vercel-composition-patterns
description:
  React composition patterns that scale. Use when refactoring components with
  boolean prop proliferation, building flexible component libraries, or
  designing reusable APIs. Triggers on tasks involving compound components,
  render props, context providers, or component architecture.
license: MIT
metadata:
  author: vercel
  version: '1.0.0'
---

# React Composition Patterns

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.

## 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

## Rule Categories by Priority

| Priority | Category                | Impact | Prefix          |
| -------- | ----------------------- | ------ | --------------- |
| 1        | Component Architecture  | HIGH   | `architecture-` |
| 2        | State Management        | MEDIUM | `state-`        |
| 3        | Implementation Patterns | MEDIUM | `patterns-`     |

## Quick Reference

### 1. Component Architecture (HIGH)

- `architecture-avoid-boolean-props` - Don't add boolean props to customize
  behavior; use composition
- `architecture-compound-components` - Structure complex components with shared
  context

### 2. State Management (MEDIUM)

- `state-decouple-implementation` - Provider is the only place that knows how
  state is managed
- `state-context-interface` - Define generic interface with state, actions, meta
  for dependency injection
- `state-lift-state` - Move state into provider components for sibling access

### 3. Implementation Patterns (MEDIUM)

- `patterns-explicit-variants` - Create explicit variant components instead of
  boolean modes
- `patterns-children-over-render-props` - Use children for composition instead
  of renderX props

## How to Use

Read individual rule files for detailed explanations and code examples:

```
rules/architecture-avoid-boolean-props.md
rules/state-context-interface.md
```

Each rule file contains:

- Brief explanation of why it matters
- Incorrect code example with explanation
- Correct code example with explanation
- Additional context and references

## Full Compiled Document

For the complete guide with all rules expanded: `AGENTS.md`

Overview

This skill provides a concise guide to React composition patterns that scale. It focuses on avoiding boolean prop proliferation and designing flexible, maintainable component APIs for component libraries and applications. Use it to refactor complex components, introduce compound components, or standardize provider-based state management.

How this skill works

The skill inspects tasks involving component architecture, state management, and implementation patterns, and recommends concrete alternatives such as compound components, lifted state in providers, and explicit variant components. It maps issues to prioritized rule categories (architecture, state, patterns) and points to focused rule files that include incorrect/correct examples and implementation notes. Apply the rules to refactor boolean-heavy props, define context interfaces, and convert render-prop patterns into clearer composition.

When to use it

  • Refactoring components that rely on many boolean props or mode flags
  • Designing or expanding a reusable component library with clear APIs
  • Implementing compound components that share context and behavior
  • Lifting state into providers so siblings can access and coordinate state
  • Reviewing component architecture for scalability and clarity

Best practices

  • Avoid boolean props; prefer explicit variant components or subcomponents
  • Centralize state logic inside provider components and expose a clear interface
  • Use context with a documented state/actions/meta shape for dependency injection
  • Prefer children composition over scattered render props when possible
  • Create small, focused rule files with incorrect and corrected examples for onboarding

Example use cases

  • Refactor a Modal that has isOpen, isClosable, and destructiveMode booleans into a Modal provider and explicit Modal.Close and Modal.Action components
  • Build a Tabs library using compound components where TabList, Tab, and TabPanel share context and avoid prop drilling
  • Convert a Button component with many mode flags into distinct PrimaryButton, GhostButton, and IconButton components
  • Lift form state into a Form provider so nested inputs and controls can access validation and submission actions
  • Replace ad-hoc render props with children-based composition for clearer markup and predictable lifecycles

FAQ

When should I prefer compound components over simple props?

Prefer compound components when multiple related elements must coordinate behavior or share state; they scale better than adding more boolean props.

How do I expose provider state safely?

Define a minimal public interface (state, actions, meta) and keep implementation details private to allow future refactors without breaking consumers.