component.template.md 1.4 KB
[Component Name] [[component-id]]
Type: [Interactive/Form/Layout/Content/Feedback/Navigation] Category: [Specific category] Purpose: [Brief description]
Overview
[Component description and when to use it]
Variants
[List variants if any, or state "This component has no variants"]
States
Required States:
- default
- [other required states]
Optional States:
- [optional states if any]
State Descriptions: [Describe each state]
Styling
Visual Properties
Size: [values] Shape: [values] Colors: [values] Typography: [values] Spacing: [values]
Design Tokens
[Token definitions]
Figma Reference
[If Mode B - Custom Design System]
Library Component
[If Mode C - Component Library]
Behavior
Interactions
[Describe interactions]
Animations
[Describe animations if any]
Accessibility
ARIA Attributes: [List ARIA attributes]
Keyboard Support: [List keyboard shortcuts]
Screen Reader: [How screen readers announce this]
Usage
When to Use
[Guidelines]
When Not to Use
[Guidelines]
Best Practices
- [Practice 1]
- [Practice 2]
Used In
Pages: [count]
Examples:
- [Page] - [Usage]
Related Components
[Related components if any]
Version History
Created: [Date] Last Updated: [Date]
Changes:
- [Date]: [Change]
Notes
[Additional notes]