Skip to content

PatternFly 6 Frontend Development Guide

Important: This guide is the authoritative source for PatternFly 6 frontend development practices. It focuses exclusively on React component development with PatternFly 6.

Essential rules and guidelines for developing React applications with PatternFly 6 components and design system.

Quick Navigation

๐Ÿš€ Frontend Setup

๐Ÿ“š Development Guidelines

๐Ÿงฉ Component Rules

๐Ÿ“Š Specialized Rules

๐Ÿงช Testing Patterns

๐Ÿ”ง Troubleshooting

๐Ÿ“– Resources

Core Development Principles

  1. PatternFly 6 Only - Use pf-v6- prefixed classes exclusively
  2. Design Token System - Use semantic tokens, never hardcode values
  3. Component-First - Always use PatternFly components before custom solutions
  4. Accessibility Required - WCAG 2.1 AA compliance is mandatory
  5. Consult documentation - Reference PatternFly.org for examples
  6. Follow accessibility - Implement proper ARIA labels and keyboard navigation
  7. Use utility classes - Prefer PatternFly utilities over custom CSS
  8. Handle states - Always implement loading, error, and empty states
  9. Theme Support - Test in both light and dark themes
  10. Responsive Design - Use rem units for breakpoints (px รท 16)
  11. TypeScript - Maintain type safety in all components
  12. Performance - Implement code splitting and optimize bundle size

What's Covered

This guide provides comprehensive PatternFly 6 frontend development guidance:

  • โœ… Component Development - PatternFly 6 React component patterns
  • โœ… Design Token System - Complete token documentation and usage
  • โœ… Styling Standards - CSS guidelines and utility classes
  • โœ… Migration Support - Codemods and breaking changes from v5 to v6
  • โœ… Quality Checklists - Development and code review checklists
  • โœ… Troubleshooting - Common frontend issues and solutions

Scope and Authority

What This Guide Covers

  • โœ… PatternFly 6 React components and patterns
  • โœ… Frontend styling and design tokens
  • โœ… Accessibility requirements
  • โœ… Component architecture
  • โœ… Frontend build and development with Vite

What This Guide Does NOT Cover

  • โŒ Backend development
  • โŒ Deployment and CI/CD
  • โŒ Database or API design
  • โŒ Container orchestration
  • โŒ Full-stack architecture

Authority

This guide is the authoritative source for PatternFly 6 frontend patterns. When current implementation conflicts with this guide, follow the guide.

External Resources

For non-frontend concerns, see the main project documentation:

  • Backend Development: docs/development/
  • API Documentation: docs/api/
  • Deployment: docs/deployment/
  • Architecture: docs/architecture/