Skills
.Work. You
Rest

fe-component-contract-doc

Community

Document frontend component contracts.

Software Engineering#documentation#frontend#component#events#contract#props
Authorjunchenghuo
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill addresses the ambiguity and potential misuse of frontend components by clearly defining their expected inputs (Props), outputs (Events), and styling behaviors.

Core Features & Use Cases

  • API Specification: Clearly outlines component properties, emitted events, and slot usage.
  • Behavioral Documentation: Details default values, boundary conditions, and expected interactions.
  • Styling Guidance: Provides information on style overrides and theming capabilities.
  • Example Generation: Includes practical usage examples and common pitfalls to avoid.
  • Use Case: A developer needs to integrate a custom DatePicker component. This Skill provides a component-contract.md file detailing all available props like minDate, maxDate, disabledDates, and events like onDateSelect, ensuring correct implementation and preventing integration errors.

Quick Start

Generate the documentation for the Button component, including its props, events, and styling options.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: fe-component-contract-doc
Download link: https://github.com/junchenghuo/openclaw-biz-agent/archive/main.zip#fe-component-contract-doc

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.