Welcome to PyReact Framework’s Documentation!

PyReact Framework is a React-inspired declarative web framework built natively for Python.

Getting Started

• Installation
  • Stable Release
  • Development Version
  • Requirements
  • Verification
  • Next Steps
• Quick Start
  • Create a New Project
  • Start Development Server
  • Your First Component
  • Use the Component
  • Build for Production
  • Next Steps
• Tutorial: Building a Todo App
  • What You’ll Build
  • Prerequisites
  • Step 1: Create the Project
  • Step 2: Create TodoItem Component
  • Step 3: Create TodoList Component
  • Step 4: Create App Component
  • Step 5: Add Styles
  • Step 6: Run and Test
  • What’s Next?

Core Concepts

• Components
  • Component Types
  • Function Components
  • Class Components
  • Component Lifecycle
  • Component Composition
  • Best Practices
  • Next Steps
• Props
  • Basic Usage
  • Props are Read-Only
  • Default Props
  • Children Prop
  • Prop Types
  • Passing Functions as Props
  • Best Practices
  • Next Steps
• State
  • Initializing State
  • Updating State
  • State Updates are Merged
  • Functional Updates
  • State is Local
  • Lifting State Up
  • State vs Props
  • Best Practices
  • Next Steps
• Events
  • Event Handling
  • Event Types
  • Event Object
  • Passing Arguments
  • Conditional Event Handlers
  • Event Pooling
  • Best Practices
  • Next Steps
• Lifecycle Methods
  • Mounting
  • Updating
  • Unmounting
  • Error Handling
  • Lifecycle Diagram
  • Best Practices
  • Next Steps

Advanced

• Server-Side Rendering (SSR)
  • What is SSR?
  • Enabling SSR
  • SSR Configuration
  • Hydration
  • Data Fetching
  • SSR Best Practices
  • SSR Limitations
  • Next Steps
• Routing
  • Basic Routing
  • Route Parameters
  • Query Parameters
  • Nested Routes
  • Programmatic Navigation
  • Route Guards
  • 404 Not Found
  • Best Practices
  • Next Steps
• Styling
  • Inline Styles
  • CSS Classes
  • CSS Modules
  • Styled Components
  • Theming
  • Responsive Design
  • Best Practices
  • Next Steps
• Testing
  • Unit Testing
  • Testing State
  • Testing Props
  • Testing Events
  • Testing Async Components
  • Integration Testing
  • Test Configuration
  • Best Practices
  • Next Steps

API Reference

• Element API
  • Function Signature
  • Basic Usage
  • HTML Elements
  • Component Elements
  • Fragments
  • Children
  • Special Props
  • Event Handlers
  • Boolean Attributes
  • Data Attributes
  • Best Practices
  • Next Steps
• Component API
  • Component Class
  • State Management
  • Lifecycle Methods
  • Render Method
  • Force Update
  • Function Components
  • Best Practices
  • Next Steps
• Hooks API
  • useState
  • useEffect
  • useContext
  • useRef
  • useMemo
  • useCallback
  • useReducer
  • Custom Hooks
  • Best Practices
  • Next Steps
• CLI API
  • Installation
  • Commands
  • Configuration
  • Project Structure
  • Environment Variables
  • Best Practices
  • Next Steps

Resources

• Frequently Asked Questions
• Changelog
• Contributing Guide
• PyReact execution and testing guide
• Automatic publishing to PyPI
• PyReact 1.0.5 correction and test report
• PyReact documentation structure

Indices and tables

• Index

• Module Index

• Search Page