React Component Documenter skill for Claude and Codex
A clear markdown reference for one React component: what it is for, every prop in a table, its state and hooks, and a copy-paste usage example, so the next…
Install it once and Claude or Codex runs it for you. When your request matches, your AI loads the skill, asks for anything it is missing, and works through the template itself. Prefer to fill it in by hand? See the full prompt template.
Download the skill (.zip) · View SKILL.md
When it is used
Use when a React component needs a markdown reference page with a props table, state, hooks, and a usage example for other developers. Do not use for generating the component itself, auditing it for bugs, or documenting a whole design system. Related topics: coding, react.
What it will ask you for
- Component name (free text, e.g. "MyComponent")
- What it does (longer free text)
- Props (longer free text)
- State variables (longer free text)
- Hooks used (choose any: useState, useEffect, useContext, useReducer, useMemo, useCallback)
- Example usage (longer free text)
How it works
- Write a two-sentence overview that says what the component renders and when a developer should reach for it.
- Fill the props table with name, type, required or default value, and a plain-English description for every prop, including callback argument shapes.
- Describe each state variable by what it tracks and what changes it, and each hook by its role in this component.
- Make the usage example runnable as written with the most common props set.
- Read the whole page as the next developer would and remove anything the source already says more clearly.
What you get
One markdown document with Overview, a Props table (name, type, required or default, description), State, Hooks, and Example Usage, in that order.
What it watches out for
- Listing a prop's type without its default, so readers cannot tell what happens when they omit it.
- Explaining what useEffect is instead of what this component's effect does.
- Pasting an example that references props the component does not accept, which fails the first time someone copies it.
How to install
Claude.ai and the Claude desktop app
- Download the skill .zip.
- Open Settings, then Capabilities, and find Skills.
- Choose Upload skill and select the .zip.
- Ask Claude for help with the task. It loads the skill when your request matches.
Claude Code
- Download the skill .zip.
- Unzip it into ~/.claude/skills/ (or .claude/skills/ inside a project).
- Start a new session. Claude Code loads the skill when your request matches.
Codex
- Download the skill .zip.
- Unzip it into ~/.agents/skills/ (or .agents/skills/ inside a project).
- Codex picks it up on its own. Type $ and the skill name to use it, or just ask for the task.
Cursor
- Download the Cursor rule (.mdc).
- Save it in .cursor/rules/ inside your project.
- Cursor's agent applies the rule when your request matches its description.
AGENTS.md (Codex, Cursor, and other coding agents)
- Copy the AGENTS.md section.
- Paste it into AGENTS.md at the root of your repository, creating the file if needed.
- Coding agents that read AGENTS.md follow it when your request fits.