README.md

Flare

Solid meta-framework for the web. SSR or CSR, HTML or NDJSON, stream or await. Deploy anywhere JS runs.

Table of Contents

• Why Flare
  • Comparison
  • When to Use Flare
• Overview
  • Architecture
  • Key Features
• Deployment
• Installation
• Configuration
  • Environment Variables
  • Path Aliases
• Entry Points
  • Server Entry
  • Client Entry
• Quick Start
• Build and Development
  • Vite Plugin
  • Dev Server
  • HMR
  • Build Modes
• Core Concepts
  • Virtual Paths
  • Route Factories
    • createRootLayout
    • createLayout
    • createPage
  • Builder Chain
  • Location Object
• Builder Methods
  • options
  • input
  • effects
  • head
  • headers
  • render
  • errorRender
  • notFoundRender
  • response
• Rendering
  • SSR
  • CSR
• Streaming
  • defer Helper
  • Await Component
  • Stream vs Await
• Router
  • Route Matching
  • Router State
• Navigation
  • Hard vs Framework
  • NDJSON Mode
  • HTML Mode
  • Link Component
  • Prefetch Strategies
  • Programmatic Navigation
  • Shallow Navigation
  • View Transitions
  • Scroll Restoration
  • Navigation Blocking
• Authentication and Authorization
  • authorizeFn
  • authorize Method
  • Auth Inheritance
• Data Loading
  • Preloaders
  • Loaders
  • Loader Context
  • Match ID
  • Cache and Staleness
  • Invalidation
• TanStack Query Integration
  • Tracked QueryClient
  • Auto-Serialization
  • Auto-Hydration
• Hydration
  • self.flare State
  • SSR to Client Handoff
  • Match Cache Population
  • QueryClient Hydration
• Server Handler
  • Configuration
  • Router Defaults
• Middleware
  • Built-in Middlewares
• Server Functions
  • createServerFn
  • TanStack Query Helpers
• Contexts
  • MiddlewareContext
  • ServerRequestContext
  • PreloaderContext
  • RouterContext
  • getServerRequest
  • getServerNonce
• Error Handling
  • Error Classes
  • errorRender
  • notFoundRender
  • Unauthenticated
  • Unauthorized
  • Redirect
• Security
  • Nonce
  • CSP
• Type Safety
  • Full Route Tree Types
  • Path Validation
  • Param and Search Inference
  • Preloader Context Chain
  • Generated Types
• Styling
  • css Prop
  • tw Prop
  • Tailwind Integration
  • Page Scoped CSS
  • ResetCSS
  • ThemeScript
  • View Transitions CSS
  • Optimization and Minification
  • styles Function
  • State and Vars
• Head Management
• SEO
  • Meta Tags
  • Open Graph
  • Structured Data
• Lazy Loading
  • lazy
  • clientLazy
  • preload
• Components
  • Link
  • Outlet
  • Await
  • HeadContent
  • Scripts
• Hooks
  • useLocation
  • useParams
  • useSearch
  • useRouter
  • useMatch
  • useMatches
  • useLoaderData
  • usePreloaderContext
  • useHydrated
  • useBlocker
  • useScrollRestore
• Testing
  • Route Segment Testing
  • Mock Utilities
  • Integration Testing
• Bundle Optimization
  • Granular Exports
  • Tree Shaking
  • Bundle Analysis
• Code Generation
  • Route Trees
  • Type Declarations
• License