Logo

Getting Started

  • Installation Guide
    • Package Manager Installation
      • npm
      • yarn
      • pnpm
    • CDN Installation
      • Latest Version
      • Specific Version
      • ES Modules
    • Module Formats
      • ES Modules (ESM)
      • CommonJS (CJS)
      • UMD (Universal Module Definition)
    • TypeScript Support
    • Framework-Specific Installation
      • React
      • Vue 3
      • Angular
    • Verification
      • Basic Test
      • Feature Detection
    • Bundle Size
      • Tree Shaking
    • Next Steps
    • Troubleshooting
  • Quick Start Guide
    • Basic Setup
    • Your First Responsive Component
      • HTML Structure
      • CSS Styles
      • JavaScript Setup
    • Essential Features
      • Container Queries
      • Fluid Typography
      • Accessibility Features
      • Performance Monitoring
    • Complete Example
    • Next Steps
    • Common Patterns
    • Tips for Success
  • ProteusJS v2.0.0 Documentation
    • 🌟 What’s New in v2.0.0
    • 📦 Package Architecture
      • Core Packages
      • Utility Packages
    • 🚀 Quick Start
      • Installation
      • CDN Usage
      • Basic Usage
    • 🔄 Migration from v1.x
      • Automated Migration
      • Manual Migration Steps
    • 📚 Documentation Structure
      • Package Documentation
    • 🌐 Browser Support
    • 🎯 Performance
      • Bundle Sizes (Gzipped)
      • Performance Targets
    • 🧪 Testing
    • 🤝 Contributing
    • 📄 License

Core Features

  • Container Queries
    • Overview
    • Basic Usage
      • Creating a Responsive Container
      • Advanced Configuration
    • Container Units
    • Real-World Examples
      • Responsive Card Component
      • Adaptive Navigation
      • Grid Layouts
    • Browser Support
    • Performance Considerations
    • Troubleshooting
    • API Reference
    • Next Steps
  • Accessibility Features
    • Overview
    • Core Accessibility Features
      • Automatic WCAG Compliance
      • Advanced Configuration
    • Screen Reader Support
      • Live Regions
      • Smart Labeling
    • Keyboard Navigation
      • Focus Management
      • Custom Focus Handling
    • Color and Contrast
      • Contrast Checking
      • Automatic Adjustments
    • Motion and Animation
      • Motion Preferences
      • Custom Motion Handling
    • Cognitive Accessibility
      • Content Simplification
      • Reading Time and Level
    • Error Handling and Messages
      • Form Enhancement
      • Custom Error Messages
    • Accessibility Auditing
      • Automatic Auditing
      • Compliance Reporting
    • Real-World Examples
      • E-commerce Product Page
      • Blog Article
      • Dashboard Interface
    • Testing and Validation
      • Automated Testing
      • Manual Testing Support
    • Performance Impact
    • Best Practices
    • API Reference
    • Resources
    • Next Steps
  • Browser Support - ProteusJS v2.0.0
    • 🌐 Browser Compatibility Matrix
    • 🔧 API Support & Fallbacks
      • Navigation API
      • View Transitions API
      • Popover API
      • CSS Anchor Positioning
      • Scheduler API
      • File System Access API
      • Web Share API
      • Badging API
      • Speculation Rules API
    • 📊 Feature Detection
    • 🎯 Progressive Enhancement Strategy
    • 🔍 Testing Strategy
    • 📱 Mobile Considerations
    • 🚀 Future Compatibility
  • Performance Guide - ProteusJS v2.0.0
    • 🚀 Performance Metrics
    • 📦 Bundle Size Optimization
      • Modular Architecture
      • Tree Shaking
    • ⚡ Runtime Performance
      • Scheduler API Integration
      • Intelligent Task Chunking
    • 🌐 Network Performance
      • Speculation Rules
      • Smart Resource Loading
    • 🎯 Performance Best Practices
      • 1. Use Appropriate Priorities
      • 2. Implement Progressive Loading
      • 3. Optimize Transitions
    • 📊 Performance Monitoring
      • Built-in Metrics
      • Custom Performance Tracking
    • 🔧 Build Optimization
      • Vite Plugin
      • Webpack Configuration
    • 📈 Performance Benchmarks
      • Comparison with Alternatives
      • Real-World Performance

API Reference

  • Core API Reference
    • ProteusJS Class
      • Constructor
      • Configuration Interface
      • Core Methods
        • init()
        • destroy()
        • getConfig()
      • Container Methods
        • container()
        • ContainerOptions Interface
      • Typography Methods
        • fluidType()
        • ScalingConfig Interface
        • createTypeScale()
      • Layout Methods
        • createGrid()
      • Accessibility Methods
        • enableAccessibility()
      • Performance Methods
        • getPerformanceMetrics()
        • optimizePerformance()
      • Utility Methods
        • detectFeatures()
        • version
      • Static Methods
        • getInstance()
      • Subsystem Access
      • Event System
      • Error Handling
      • Best Practices
  • ProteusJS v2.0.0 API Reference
    • 📦 Package APIs
      • Core Packages
      • Utility Packages
    • 🔗 Quick Links
    • 📝 API Conventions
      • Error Handling
      • TypeScript Support
      • Browser Compatibility
      • Performance

Migration & Guides

  • ProteusJS v1→v2 Migration Guide
    • 🎯 Migration Overview
    • 🚀 Quick Migration
      • Automated Migration Tool
      • Manual Migration Checklist
    • 📦 Package Dependencies
      • Before (v1.x)
      • After (v2.0.0)
    • 🔄 Import Changes
      • Navigation & Routing
      • Transitions
      • Popover & UI
      • Performance
    • 🔧 API Changes
      • Constructor Pattern → Functional API
      • Method Name Changes
      • Configuration Changes
    • 🎨 CSS Changes
      • Class Name Updates
      • CSS Custom Properties
    • 📡 Event Changes
      • Event Name Updates
      • Event Data Structure
    • 🔧 Framework Adapters
      • React
      • Vue
    • 🧪 Testing Changes
      • Test Utilities
    • 🚨 Breaking Changes Summary
      • Removed Features
      • Changed Behavior
      • New Requirements
    • 🔄 Step-by-Step Migration
      • 1. Backup Your Project
      • 2. Update Dependencies
      • 3. Run Automated Migration
      • 4. Manual Updates
      • 5. Test Thoroughly
      • 6. Update Documentation
    • 🆘 Troubleshooting
      • Common Issues
      • Getting Help
    • ✅ Migration Checklist
ProteusJS
  • Search

© Copyright 2025, sc4rfurry.

Built with Sphinx using a theme provided by Read the Docs.