Package Reference
Remix V3 is composed of 38 single-purpose packages. Each package works independently and can be installed on its own, or you can use the remix meta-package to access everything through a single dependency.
Each package has three documentation pages:
- Overview --- What the package does and when to use it
- Tutorial --- A practical step-by-step guide
- Reference --- Complete API documentation
Installing
The Meta-Package
The easiest way to get started is to install the remix meta-package, which re-exports every package:
bash
npm install remix@nextThen import from any sub-path:
ts
import { createRouter } from 'remix/fetch-router'
import { createRequestListener } from 'remix/node-fetch-server'
import { RoutePattern } from 'remix/route-pattern'Individual Packages
Every package is also available individually as @remix-run/<package-name>:
bash
npm install @remix-run/fetch-router
npm install @remix-run/node-fetch-serverRouting & Server
| Package | Description |
|---|---|
| fetch-router | The core router. Maps URL patterns to request handlers using the Fetch API. |
| route-pattern | URL pattern matching, parsing, and generation with type-safe params. |
| node-fetch-server | Adapts Fetch API handlers to Node.js http.createServer(). |
| fetch-proxy | Creates fetch functions that forward requests to another server. |
UI & Rendering
| Package | Description |
|---|---|
| component | JSX components with server-side rendering, client hydration, and animations. |
| html-template | Tagged template literal for safe HTML rendering with auto-escaping. |
Data
| Package | Description |
|---|---|
| data-table | A typed relational query toolkit for defining tables and running queries. |
| data-table-sqlite | SQLite adapter for data-table. |
| data-table-postgres | PostgreSQL adapter for data-table. |
| data-table-mysql | MySQL adapter for data-table. |
| data-schema | Schema validation and type coercion for form data and JSON. |
Authentication
| Package | Description |
|---|---|
| auth | OAuth, OIDC, and credentials authentication with pluggable providers. |
| auth-middleware | Router middleware that protects routes with authentication. |
Sessions & Cookies
| Package | Description |
|---|---|
| session | Session management with pluggable storage backends. |
| session-middleware | Router middleware that loads and saves sessions automatically. |
| session-storage-redis | Redis-backed session storage. |
| session-storage-memcache | Memcache-backed session storage. |
| cookie | Cookie parsing, serialization, and cryptographic signing. |
Middleware
| Package | Description |
|---|---|
| compression-middleware | Automatic gzip/brotli response compression. |
| cors-middleware | Cross-Origin Resource Sharing (CORS) headers. |
| csrf-middleware | Cross-Site Request Forgery (CSRF) protection. |
| cop-middleware | Tokenless cross-origin protection using Sec-Fetch headers. |
| static-middleware | Serves static files with ETags and range requests. |
| logger-middleware | Request/response logging. |
| method-override-middleware | Allows HTML forms to use PUT, PATCH, and DELETE. |
| form-data-middleware | Parses form data and makes it available on the request context. |
| async-context-middleware | Provides AsyncLocalStorage integration for request context. |
File Handling
| Package | Description |
|---|---|
| multipart-parser | Low-level streaming multipart/form-data parser. |
| form-data-parser | High-level form data parser with file upload support. |
| file-storage | File storage abstraction with pluggable backends. |
| file-storage-s3 | Amazon S3 file storage backend. |
| lazy-file | Lazy-loaded file objects that defer reading until needed. |
| fs | Filesystem utilities built on web standards. |
| tar-parser | Streaming tar archive parser. |
Utilities
| Package | Description |
|---|---|
| headers | Typed HTTP header parsing and serialization. |
| response | Response helpers for HTML, files, redirects, and compression. |
| mime | MIME type detection and content-type utilities. |
| assert | Cross-runtime assertion utilities. |
| test | Test runner for Remix applications. |