Vue Component Documenter skill for Claude and Codex
Produces the reference page for a Vue component: props with types and defaults, emitted events with payloads, slots with their scope, exposed methods, and a…
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 Vue component needs a reference page with its props, events, slots, and exposed methods for the people who consume it. Do not use for documenting a Svelte store or TypeScript types, or explaining a component's internal implementation. Related topics: coding, vue.
What it will ask you for
- Component file path (free text, e.g. "src/components/DataTable.vue")
- Component name (free text, e.g. "DataTable")
- Component source (longer free text)
- What it does (longer free text)
- Props definition if not in the source (longer free text)
- Emitted events (longer free text)
- Slots (longer free text)
- Include a usage example (choose one: Yes, No)
How it works
- Extract every prop with type, required flag, default, and validator from the source and write a meaning for each that states its effect.
- Extract every emitted event from the emits declaration and the template, with its payload type and trigger.
- List the default slot and each named slot with the scope props it exposes.
- Include methods only when exposed with defineExpose or public on the Options API, and skip the section otherwise.
- Write a runnable parent-template example using common props, one handler, and one slot when requested, then assemble the sections in order.
What you get
One markdown document with Overview, Props table, Emits table, Slots table, Methods when exposed, and Example when requested, in that order.
What it watches out for
- Listing internal methods and refs as API, which invites parents to call things that will change.
- Missing events emitted directly from the template with $emit because only defineEmits was read.
- Writing a prop meaning that restates its name (disabled: whether it is disabled) instead of the effect of changing 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.