Skip to content

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@next

Then 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-server

Routing & Server

PackageDescription
fetch-routerThe core router. Maps URL patterns to request handlers using the Fetch API.
route-patternURL pattern matching, parsing, and generation with type-safe params.
node-fetch-serverAdapts Fetch API handlers to Node.js http.createServer().
fetch-proxyCreates fetch functions that forward requests to another server.

UI & Rendering

PackageDescription
componentJSX components with server-side rendering, client hydration, and animations.
html-templateTagged template literal for safe HTML rendering with auto-escaping.

Data

PackageDescription
data-tableA typed relational query toolkit for defining tables and running queries.
data-table-sqliteSQLite adapter for data-table.
data-table-postgresPostgreSQL adapter for data-table.
data-table-mysqlMySQL adapter for data-table.
data-schemaSchema validation and type coercion for form data and JSON.

Authentication

PackageDescription
authOAuth, OIDC, and credentials authentication with pluggable providers.
auth-middlewareRouter middleware that protects routes with authentication.

Sessions & Cookies

PackageDescription
sessionSession management with pluggable storage backends.
session-middlewareRouter middleware that loads and saves sessions automatically.
session-storage-redisRedis-backed session storage.
session-storage-memcacheMemcache-backed session storage.
cookieCookie parsing, serialization, and cryptographic signing.

Middleware

PackageDescription
compression-middlewareAutomatic gzip/brotli response compression.
cors-middlewareCross-Origin Resource Sharing (CORS) headers.
csrf-middlewareCross-Site Request Forgery (CSRF) protection.
cop-middlewareTokenless cross-origin protection using Sec-Fetch headers.
static-middlewareServes static files with ETags and range requests.
logger-middlewareRequest/response logging.
method-override-middlewareAllows HTML forms to use PUT, PATCH, and DELETE.
form-data-middlewareParses form data and makes it available on the request context.
async-context-middlewareProvides AsyncLocalStorage integration for request context.

File Handling

PackageDescription
multipart-parserLow-level streaming multipart/form-data parser.
form-data-parserHigh-level form data parser with file upload support.
file-storageFile storage abstraction with pluggable backends.
file-storage-s3Amazon S3 file storage backend.
lazy-fileLazy-loaded file objects that defer reading until needed.
fsFilesystem utilities built on web standards.
tar-parserStreaming tar archive parser.

Utilities

PackageDescription
headersTyped HTTP header parsing and serialization.
responseResponse helpers for HTML, files, redirects, and compression.
mimeMIME type detection and content-type utilities.
assertCross-runtime assertion utilities.
testTest runner for Remix applications.

Released under the MIT License.