Skip to content

Guides API Blog Jam Store GitHub

Version

3.0.0-beta.5 (latest)

remix

remix/assert

Interfaces

Classes

Functions

assert deepEqual doesNotMatch doesNotReject doesNotThrow equal fail match notDeepEqual notEqual ok partialDeepEqual rejects throws

Variables

expect

remix/assets

Overview

Interfaces

AssetServer AssetServerOptions

Functions

createAssetServer

remix/auth

Overview

Types

OAuthTokens

Interfaces

AtmosphereAuthorizationServerMetadata AtmosphereAuthProfile AtmosphereAuthProvider AtmosphereAuthProviderMapProfileInput AtmosphereAuthProviderOptions AtmosphereClientAuthentication AtmosphereOAuthTokens AtmosphereTokenAuthorizationServer Auth0AuthProfile Auth0AuthProviderOptions CredentialsAuthProvider CredentialsAuthProviderOptions FacebookAuthProfile FacebookAuthProviderOptions FacebookAuthProviderPicture FinishedExternalAuthResult FinishExternalAuthOptions GitHubAuthProfile GitHubAuthProviderEmail GitHubAuthProviderOptions GoogleAuthProfile GoogleAuthProviderOptions MicrosoftAuthProfile MicrosoftAuthProviderOptions OAuthAccount OAuthDpopBinding OAuthDpopTokens OAuthProvider OAuthResult OAuthStandardTokens OIDCAuthProfile OIDCAuthProviderMetadata OIDCAuthProviderOptions OktaAuthProfile OktaAuthProviderOptions RefreshedExternalAuthResult StartExternalAuthOptions XAuthProfile XAuthProviderOptions

Functions

completeAuth createAtmosphereAuthProvider createAuth0AuthProvider createCredentialsAuthProvider createFacebookAuthProvider createGitHubAuthProvider createGoogleAuthProvider createMicrosoftAuthProvider createOIDCAuthProvider createOktaAuthProvider createXAuthProvider finishExternalAuth refreshExternalAuth startExternalAuth verifyCredentials

remix/cli

Interfaces

Functions

remix/cookie

Interfaces

Classes

Functions

remix/data-schema

Types

Check ErrorMap ErrorMapContext InferInput InferOutput Issue ParseOptions Schema ValidationOptions ValidationResult

Classes

ValidationError

Functions

any array bigint boolean createIssue createSchema defaulted enum_fail instanceof_literal map null_nullable number object optional parse parseSafe record set string symbol tuple undefined_union variant

remix/data-schema/checks

Overview

Functions

email max maxLength min minLength url

remix/data-schema/coerce

Overview

Functions

bigint boolean date number string

remix/data-schema/form-data

Overview

Types

FormDataObjectSchema FormDataSchema FormDataSource ParsedFormData

Interfaces

FormDataEntrySchema FormDataFieldOptions FormDataFieldsOptions FormDataFileOptions FormDataFilesOptions

Functions

field fields file files object

remix/data-schema/lazy

Overview

Functions

lazy

remix/data-table

Overview

Types

AdapterCapabilities AdapterCapabilityOverrides AnyColumn AnyQuery AnyRelation AnyTable BelongsToOptions ColumnCheck ColumnComputed ColumnDefault ColumnDefinition ColumnNamespace ColumnReference ColumnReferenceForQualifiedName ColumnTypeName CountOperation CountOptions CreateManyResultOptions CreateManyRowsOptions CreateResultOptions CreateRowOptions DataManipulationOperation DataManipulationRequest DataManipulationResult DeleteManyOptions DeleteOperation ExistsOperation FindManyOptions FindOneOptions ForeignKeyAction HasManyOptions HasManyThroughOptions HasOneOptions IdentityOptions InsertManyOperation InsertOperation JoinClause JoinType KeySelector OrderByClause OrderByInput OrderByTuple OrderDirection Predicate PrimaryKeyInput QueryColumnTypesForTable QueryForTable QueryTableInput RawOperation Relation RelationCardinality RelationKind RelationMapForTable ReturningSelection SelectColumn SelectOperation SingleTableColumn SingleTableWhere SqlStatement Table TableAfterDelete TableAfterDeleteContext TableAfterRead TableAfterReadContext TableAfterReadResult TableAfterWrite TableAfterWriteContext TableBeforeDelete TableBeforeDeleteContext TableBeforeDeleteResult TableBeforeWrite TableBeforeWriteContext TableBeforeWriteResult TableColumnInput TableColumnName TableColumns TableColumnsDefinition TableLifecycleOperation TableName TablePrimaryKey TableRef TableReference TableRow TableRowWith TableValidate TableValidationContext TableValidationOperation TableValidationResult TableWriteOperation TimestampConfig TimestampOptions TransactionOptions TransactionToken UpdateManyOptions UpdateOperation UpdateOptions UpsertOperation ValidationFailure ValidationIssue WhereInput WhereObject WriteResult WriteRowResult WriteRowsResult

Interfaces

DatabaseAdapter

Classes

ColumnBuilder Database DataTableAdapterError DataTableConstraintError DataTableError DataTableQueryError DataTableValidationError Query

Functions

and belongsTo between createDatabase eq fail getTableAfterDelete getTableAfterRead getTableAfterWrite getTableBeforeDelete getTableBeforeWrite getTableColumnDefinitions getTableColumns getTableName getTablePrimaryKey getTableReference getTableTimestamps getTableValidator gt gte hasMany hasManyThrough hasOne ilike inList isNull like lt lte ne notInList notNull or query rawSql sql table timestamps

Variables

column columnMetadataKey tableMetadataKey

remix/data-table/migrations

Overview

Types

MigrateOptions MigrateResult MigrationDescriptor MigrationDirection MigrationJournalRow MigrationRegistry MigrationRunner MigrationRunnerOptions MigrationStatus MigrationStatusEntry MigrationTransactionMode

Functions

createMigrationRegistry createMigrationRunner parseMigrationDirectoryName

remix/data-table/migrations/node

Functions

loadMigrations

remix/data-table/mysql

Overview

Classes

MysqlDatabaseAdapter

Functions

createMysqlDatabaseAdapter

remix/data-table/operators

Overview

Functions

and between eq gt gte ilike inList isNull like lt lte ne notInList notNull or

remix/data-table/postgres

Overview

Classes

PostgresDatabaseAdapter

Functions

createPostgresDatabaseAdapter

remix/data-table/sql-helpers

Overview

Types

QuoteIdentifier

Functions

collectColumns normalizeJoinType quoteLiteral quotePath quoteTableRef

remix/data-table/sqlite

Overview

Interfaces

SqliteDatabase SqliteRunResult SqliteStatement

Classes

SqliteDatabaseAdapter

Functions

createSqliteDatabaseAdapter

remix/fetch-proxy

Overview

Interfaces

FetchProxy FetchProxyOptions

Functions

createFetchProxy

remix/file-storage

Overview

Types

FileLike

Interfaces

FileKey FileMetadata FileStorage ListOptions ListResult

remix/file-storage/fs

Overview

Functions

createFsFileStorage

remix/file-storage/memory

Overview

Functions

createMemoryFileStorage

remix/file-storage/s3

Overview

Interfaces

S3FileStorageOptions

Functions

createS3FileStorage

remix/form-data-parser

Overview

Interfaces

FileUploadHandler ParseFormDataOptions

Classes

FileUpload FormDataParseError MaxFilesExceededError MaxFileSizeExceededError MaxHeaderSizeExceededError MaxPartsExceededError MaxTotalSizeExceededError MultipartParseError

Functions

parseFormData

remix/fs

Overview

Interfaces

OpenLazyFileOptions

Functions

openLazyFile writeFile

remix/headers

Overview

Types

SuperHeadersInit

Interfaces

SuperHeadersPropertyInit

Classes

Functions

remix/headers/accept

Types

Classes

remix/headers/accept-encoding

Overview

Types

AcceptEncodingInit

Classes

AcceptEncoding

remix/headers/accept-language

Overview

Types

AcceptLanguageInit

Classes

AcceptLanguage

remix/headers/cache-control

Overview

Interfaces

CacheControlInit

Classes

CacheControl

remix/headers/content-disposition

Overview

Interfaces

ContentDispositionInit

Classes

ContentDisposition

remix/headers/content-range

Overview

Interfaces

ContentRangeInit

Classes

ContentRange

remix/headers/content-type

Interfaces

Classes

remix/headers/cookie

Types

Classes

remix/headers/if-match

Overview

Interfaces

IfMatchInit

Classes

IfMatch

remix/headers/if-none-match

Overview

Interfaces

IfNoneMatchInit

Classes

IfNoneMatch

remix/headers/if-range

Classes

remix/headers/range

Interfaces

Classes

remix/headers/raw-headers

Overview

Functions

parse stringify

remix/headers/set-cookie

Overview

Interfaces

CookieProperties SetCookieInit

Classes

remix/headers/vary

Interfaces

Classes

remix/html-template

Types

Interfaces

Functions

Variables

remix/lazy-file

Interfaces

ByteRange LazyBlobOptions LazyContent LazyFileOptions

Classes

LazyBlob LazyFile

Functions

getByteLength getIndexes

remix/middleware/async-context

Overview

Types

AsyncRequestContext

Functions

asyncContext getContext

remix/middleware/auth

Overview

Types

AuthSchemeAuthenticateResult AuthSchemeResult AuthState

Interfaces

APIAuthSchemeOptions AuthFailure AuthOptions AuthScheme AuthSchemeFailure AuthSchemeSuccess BadAuth BearerTokenAuthSchemeOptions GoodAuth RequireAuthOptions SessionAuthSchemeOptions

Functions

auth createAPIAuthScheme createBearerTokenAuthScheme createSessionAuthScheme requireAuth

Variables

Auth

remix/middleware/compression

Interfaces

Functions

remix/middleware/cop

Types

Interfaces

CopDenyHandler CopOptions

Functions

cop

remix/middleware/cors

Overview

Types

CorsAllowedHeadersResolverResult CorsOrigin CorsOriginResolverResult

Interfaces

CorsAllowedHeadersResolver CorsOptions CorsOriginResolver

Functions

cors

remix/middleware/csrf

Overview

Types

CsrfFailureReason CsrfOrigin CsrfOriginResolverResult CsrfTokenResolverResult

Interfaces

CsrfOptions CsrfOriginResolver CsrfTokenResolver

Functions

csrf getCsrfToken

remix/middleware/form-data

Overview

Interfaces

FileUpload FileUploadHandler FormDataOptions

Classes

FormDataParseError

Functions

formData

remix/middleware/logger

Overview

Interfaces

LoggerFunction LoggerOptions

Functions

logger

Variables

Logger

remix/middleware/method-override

Overview

Interfaces

MethodOverrideOptions

Functions

methodOverride

remix/middleware/render

Types

Functions

Variables

remix/middleware/session

Overview

Functions

session

remix/middleware/static

Interfaces

Functions

remix/mime

Interfaces

Functions

defineMimeType detectContentType detectMimeType isCompressibleMimeType mimeTypeToContentType

remix/multipart-parser

Overview

Types

MultipartParserOptions

Interfaces

MultipartHeaders ParseMultipartOptions

Classes

MaxFileSizeExceededError MaxHeaderSizeExceededError MaxPartsExceededError MaxTotalSizeExceededError MultipartParseError MultipartParser MultipartPart

Functions

getMultipartBoundary isMultipartRequest parseMultipart parseMultipartRequest parseMultipartStream

remix/multipart-parser/node

Overview

Functions

getMultipartBoundary isMultipartRequest parseMultipart parseMultipartRequest parseMultipartStream

remix/node-fetch-server

Overview

Types

RequestOptions

Interfaces

ClientAddress ErrorHandler FetchHandler RequestListenerOptions

Functions

createHeaders createRequest createRequestListener sendResponse

remix/node-fetch-server/test

Interfaces

Functions

remix/node-tsx

remix/node-tsx/load-module

Overview

remix/response

Overview

remix/response/compress

Types

Encoding

Interfaces

CompressResponseOptions

Functions

compressResponse

remix/response/file

Types

FileDigestFunction

Interfaces

FileResponseOptions

Functions

createFileResponse

remix/response/html

Functions

createHtmlResponse

remix/response/redirect

Functions

createRedirectResponse

remix/route-pattern

Overview

Interfaces

RoutePatternCapture RoutePatternJSON

Classes

ParseError RoutePattern

Functions

getRoutePatternCaptures

remix/route-pattern/href

Overview

Types

CreateHrefArgs CreateHrefErrorDetails

Classes

CreateHrefError

Functions

createHref

remix/route-pattern/join

Overview

Types

JoinPatterns

Functions

joinPatterns

remix/route-pattern/match

Overview

Types

Match Matcher MatcherOptions MatchParamMeta MatchParams MultiMatcher

Functions

createMatcher createMultiMatcher

remix/route-pattern/specificity

Overview

Functions

ascending compare descending equal greaterThan lessThan

remix/router

Overview

Types

Action AnyParams ContextEntries ContextValue ContextWithEntries ContextWithEntry ContextWithParams Controller GetContextValue MatchData Middleware MiddlewareContext NextFunction RequestMethod RouterContext

Interfaces

ContextEntry RequestHandler RouteBuilder RouteEntry RouteInstaller Router RouterOptions RouterTypes

Classes

RequestContext

Functions

createAction createContextKey createController createMiddleware createRouter isRequestMethod

Variables

RequestMethods

remix/routes

Overview

Types

BuildRoute RequestBodyMethod ResourceMethod ResourceOptions ResourcesMethod ResourcesOptions RouteDef

Interfaces

FormOptions RouteDefs RouteMap

Classes

Route

Functions

createDeleteRoute createFormRoutes createGetRoute createHeadRoute createOptionsRoute createPatchRoute createPostRoute createPutRoute createResourceRoutes createResourcesRoutes createRoutes form resource resources route

Variables

remix/session

Interfaces

Classes

Functions

createSession createSessionId

remix/session-storage/cookie

Overview

Functions

createCookieSessionStorage

remix/session-storage/fs

Overview

Interfaces

FsSessionStorageOptions

Functions

createFsSessionStorage

remix/session-storage/memcache

Overview

Interfaces

MemcacheSessionStorageOptions

Functions

createMemcacheSessionStorage

remix/session-storage/memory

Overview

Functions

createMemorySessionStorage

remix/session-storage/redis

Overview

Interfaces

RedisSessionStorageClient RedisSessionStorageOptions

Functions

createRedisSessionStorage

remix/tar-parser

Overview

Types

ParseTarOptions TarParserOptions

Interfaces

ParseTarHeaderOptions TarHeader

Classes

TarEntry TarParseError TarParser

Functions

parseTar parseTarHeader

remix/terminal

Overview

Types

AnsiStyleCodes TerminalBackgroundColorName TerminalEnvironment TerminalForegroundColorName TerminalModifierName TerminalStyle TerminalStyleName

Interfaces

Ansi ColorSupportOptions CreateStylesOptions Terminal TerminalInputStream TerminalOptions TerminalOutputStream TerminalStyles

Functions

createStyles createTerminal shouldUseColors stripAnsi

Variables

ansi

remix/test

Overview

Types

RemixTestPool

Interfaces

FakeTimers RemixTestConfig TestContext

Functions

after afterAll afterEach before beforeAll beforeEach describe it suite test

Variables

mock

remix/test/cli

Overview

Interfaces

RunRemixTestOptions

Functions

getRemixTestHelpText runRemixTest

remix/ui

Overview

Types

AppRuntime AppRuntimeEventMap ComponentErrorEvent CSSMixinDescriptor Dispatched EntryComponent FrameContent FrameHandle FrameHandleEventMap LoadModule MixinDescriptor MixinFactory MixinHandle MixInput MixinType MixValue NavigationOptions RefCallback ResolveFrame SerializableArray SerializableObject SerializablePrimitive SerializableProps SerializableValue Task VirtualRoot VirtualRootEventMap VirtualRootOptions

Interfaces

Context FrameProps Handle HostProps LayoutAnimationConfig RunInit Scheduler

Classes

TypedEventTarget

Functions

addEventListeners attrs clientEntry createElement createMixin createRangeRoot createRoot createScheduler Fragment Frame navigate on run

Variables

css link ref

remix/ui/accordion

Overview

Examples

Accordion Overview Accordion Multiple Open Accordion in a Card Accordion Primitives

Types

AccordionContentProps AccordionItemProps AccordionMultipleProps AccordionProps AccordionSingleProps AccordionTriggerProps

remix/ui/accordion/primitives

Overview

Types

AccordionContentProps AccordionContextProps AccordionHeadingLevel AccordionItemProps AccordionMultipleValue AccordionProps AccordionSingleValue AccordionTriggerProps AccordionType AccordionValue

Interfaces

AccordionBaseContextProps AccordionContentOptions AccordionItemOptions AccordionMultipleContextProps AccordionRootOptions AccordionSingleContextProps AccordionTriggerOptions

remix/ui/anchor

Overview

Examples

Anchor

Types

AnchorOptions AnchorPlacement AnchorTarget

Interfaces

AnchorPoint

remix/ui/animation

Overview

Examples

Animation Gallery Spring Drag Release

Types

SpringPreset

Interfaces

BezierCurve SpringIterator SpringOptions TweenOptions

Functions

animateEntrance animateExit animateLayout tween

Variables

easings spring

remix/ui/breadcrumbs

Overview

Examples

Breadcrumbs Basic Breadcrumbs with Separator

Types

BreadcrumbItem BreadcrumbsProps

remix/ui/button

Overview

Examples

Button Basic

Types

ButtonSize ButtonTone

Interfaces

ButtonOptions

remix/ui/checkbox

Overview

Examples

Checkbox Basic

Types

CheckboxSize CheckboxState

Interfaces

CheckboxOptions

remix/ui/combobox

Overview

Examples

Combobox Overview Combobox Primitives

Interfaces

ComboboxOptionProps ComboboxProps

remix/ui/combobox/primitives

Overview

Types

ComboboxOpenStrategy

Interfaces

ComboboxContextProps ComboboxHandle ComboboxOptionOptions ComboboxOptionProps ComboboxProps

remix/ui/input

Examples

Types

Interfaces

remix/ui/jsx-dev-runtime

Overview

Types

ElementProps ElementType Props RemixNode Renderable

Interfaces

RemixElement

Functions

Fragment jsx jsxDEV jsxs

remix/ui/jsx-runtime

Overview

Functions

Fragment jsx jsxDEV jsxs

remix/ui/listbox

Overview

Examples

Listbox

Types

ListboxValue

Interfaces

ListboxContext ListboxOption ListboxProviderProps ListboxRef ListboxRegisteredOption

remix/ui/menu

Overview

Examples

Context Menu Trigger Menu Event Bubbling Menu Overview Menu Primitives

Interfaces

MenuItemProps MenuListProps MenuProps SubmenuProps

remix/ui/menu/primitives

Overview

Interfaces

MenuContextTriggerOptions MenuItemOptions MenuProviderProps MenuSelectItem MenuTriggerOptions SubmenuTriggerOptions

remix/ui/popover

Overview

Examples

Popover

Interfaces

PopoverContext PopoverHideRequest PopoverProps PopoverSurfaceOptions

remix/ui/radio

Examples

Types

Interfaces

remix/ui/runtime

Examples

Basic Counter Controlled and Uncontrolled Values Keyed List README Examples

remix/ui/select

Overview

Examples

Select Overview Select Primitives

Types

SelectOptionProps

Interfaces

SelectProps

remix/ui/select/primitives

Overview

Types

SelectOptionProps

Interfaces

SelectContextProps SelectProps

remix/ui/server

Overview

Interfaces

RenderToStreamOptions ResolveFrameContext

Functions

renderToStream renderToString

remix/ui/tabs

Overview

Examples

Tabs Basic

Types

TabsSize

Interfaces

TabListProps TabPanelProps TabProps TabsProps

remix/ui/tabs/primitives

Overview

Types

TabsActivationDirection

Interfaces

TabListOptions TabOptions TabPanelOptions TabsContextProps TabsContextValue TabsRegisteredTab TabsRootOptions

remix/ui/test

Overview

Interfaces

RenderOptions RenderResult

Functions

remix/ui/toggle

Examples

Types

Interfaces

remix/ui/toggle/primitives

Overview

Interfaces

ToggleControlOptions

remix/ui/toggle · Interface

View Source

ToggleOptions

Signature

interface ToggleOptions {
  size?: ToggleSize
}