Brisa Framework logoBrisa
  • Docs
  • Playground
  • Examples
  • Blog
  • 0.2.13
  1. API Reference
Content to learn
๐Ÿš€ Getting started
  • What is Brisa?
  • Quick Start
  • Project structure
๐Ÿ› ๏ธ Building your application
  • ๐Ÿ›ฃ๏ธ Routing
    • Pages and Layouts
    • Dynamic Routes
    • Linking and Navigating
    • Custom error
    • Api Routes
    • Middleware
    • Internationalization
    • Suspense and streaming
    • Websockets
    • Static assets
    • Sitemap
  • ๐Ÿงพ Components details
    • Server components
    • Web components
    • Reactivity
    • Context
    • Forms
    • External libraries
  • ๐Ÿ“’ Data management
    • Fetching data
    • Server actions (mutations)
  • ๐Ÿ’… Styling
    • Global styles
    • CSS Template literal
    • CSS Modules
    • CSS inlined in JSX
    • Tailwind CSS
    • Panda CSS
    • Styling Web Components
  • โš™๏ธ Configuring
    • brisa.config.js options
    • Typescript
    • Environment variables
    • TLS
    • Zig Rust C files
    • Trailing slash
    • Asset compression
    • Asset prefix
    • Base path
    • Plugins
    • Output
    • Output Adapter
    • Integrations
    • External dependencies
    • Idle timeout
    • Static pages
    • Clustering
    • Filter runtime dev errors
    • Content Security Policy
    • Custom Server
    • Debugging
  • ๐Ÿงช Testing
    • Introduction
    • Matchers
    • Test API
  • ๐Ÿ” Authentication
    • Authentication
    • Authorization
    • Session tracking
  • ๐Ÿงฉ Integrations
    • Tauri
    • MDX
    • Tailwind CSS
    • Panda CSS
  • ๐Ÿ”จ Building
    • Bun Server (default)
    • Static Site App
    • Node.js Server
    • Deno Server
    • Desktop app
    • Android app
    • iOS app
    • Web Component Compiler
  • ๐Ÿš€ Deploying
    • Fly io
    • AWS
    • Render com
    • Vercel
    • Writing a custom adapter
    • Docker
โš™๏ธ API Reference
  • ๐Ÿงฉ Components
    • Request context
    • Web context
    • Context provider
  • ๐Ÿ—œ๏ธ Functions
    • createContext
    • createPortal
    • dangerHTML
    • navigate
    • notFound
    • throwable
  • ๐Ÿ“š Extended HTML Attributes
    • debounceEvent
    • indicateEvent
    • key
    • ref
    • skipSSR
    • renderOn
    • renderMode
  • ๐ŸŒ Server APIs
    • renderPage
    • renderComponent
    • renderToReadableStream
    • renderToString
    • getServeOptions
    • fileSystemRouter
    • Initiator
    • serve
    • encrypt
    • decrypt
    • SSRWebComponent
    • getServer
    • Node.js APIs
      • serve
      • handler
    • Deno APIs
      • serve
      • handler
  • ๐Ÿ› ๏ธ Compiler APIs
    • compileWC
  • ๐ŸŽฎ Brisa CLI
    • brisa dev
    • brisa build
    • brisa start
    • brisa add

API Reference

The Brisa API reference is divided into the following sections:

Components

  • Context Provider

Functions

  • createContext
  • createPortal
  • dangerHTML
  • navigate
  • notFound

Extended Properties

  • debounceEvent
  • indicateEvent
  • key
  • ref
  • skipSSR
  • renderOn
  • renderMode

Server APIs

  • renderPage
  • renderComponent
  • renderToReadableStream
  • renderToString
  • getServeOptions
  • fileSystemRouter
  • Initator
  • serve
  • encrypt
  • decrypt
  • SSRWebComponent
  • Node.js APIs
    • serve
    • handler

Compiler APIs

  • compileWC
Edit this page on GitHub On this page

Let's keep in touch

Enter your email to stay up to date with the latest updates from Brisa.

Content
  • Docs
  • Playground
  • Examples
  • Blog
  • Visit our Shop
Social
  • Twitter (x)
  • Discord
  • GitHub
  • YouTube
Legal
  • Privacy Policy
  • Terms of Service

MIT License ยฉ 2025 Brisa Framework

contact@brisa.build