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
Index
Edit on GitHub
Index