# Table of Contents - [React Router API Reference](#react-router-api-reference) - [React Router API Reference](#react-router-api-reference) - [create-react-router | React Router API Reference](#create-react-router-react-router-api-reference) - [React Router API Reference](#react-router-api-reference) - [UNSAFE_DataWithResponseInit | React Router API Reference](#unsafe-datawithresponseinit-react-router-api-reference) - [NavigationType | React Router API Reference](#navigationtype-react-router-api-reference) - [ActionFunctionArgs | React Router API Reference](#actionfunctionargs-react-router-api-reference) - [UNSAFE_ServerMode | React Router API Reference](#unsafe-servermode-react-router-api-reference) - [ActionFunction | React Router API Reference](#actionfunction-react-router-api-reference) - [react-router | React Router API Reference](#react-router-react-router-api-reference) - [UNSAFE_RemixErrorBoundary | React Router API Reference](#unsafe-remixerrorboundary-react-router-api-reference) - [AppLoadContext | React Router API Reference](#apploadcontext-react-router-api-reference) - [BrowserRouterProps | React Router API Reference](#browserrouterprops-react-router-api-reference) - [AwaitProps | React Router API Reference](#awaitprops-react-router-api-reference) - [CookieSerializeOptions | React Router API Reference](#cookieserializeoptions-react-router-api-reference) - [Cookie | React Router API Reference](#cookie-react-router-api-reference) - [CookieSignatureOptions | React Router API Reference](#cookiesignatureoptions-react-router-api-reference) - [DataRouter | React Router API Reference](#datarouter-react-router-api-reference) - [CookieParseOptions | React Router API Reference](#cookieparseoptions-react-router-api-reference) - [DataRouteMatch | React Router API Reference](#dataroutematch-react-router-api-reference) - [DataStrategyFunction | React Router API Reference](#datastrategyfunction-react-router-api-reference) - [DataStrategyFunctionArgs | React Router API Reference](#datastrategyfunctionargs-react-router-api-reference) - [DataStrategyMatch | React Router API Reference](#datastrategymatch-react-router-api-reference) - [DataStrategyResult | React Router API Reference](#datastrategyresult-react-router-api-reference) - [FetcherSubmitOptions | React Router API Reference](#fetchersubmitoptions-react-router-api-reference) - [EntryContext | React Router API Reference](#entrycontext-react-router-api-reference) - [FetcherSubmitFunction | React Router API Reference](#fetchersubmitfunction-react-router-api-reference) - [GetScrollPositionFunction | React Router API Reference](#getscrollpositionfunction-react-router-api-reference) - [HandleDocumentRequestFunction | React Router API Reference](#handledocumentrequestfunction-react-router-api-reference) - [GetScrollRestorationKeyFunction | React Router API Reference](#getscrollrestorationkeyfunction-react-router-api-reference) - [HandleDataRequestFunction | React Router API Reference](#handledatarequestfunction-react-router-api-reference) - [HandleErrorFunction | React Router API Reference](#handleerrorfunction-react-router-api-reference) - [FetcherFormProps | React Router API Reference](#fetcherformprops-react-router-api-reference) - [HeadersFunction | React Router API Reference](#headersfunction-react-router-api-reference) - [HashRouterProps | React Router API Reference](#hashrouterprops-react-router-api-reference) - [FormProps | React Router API Reference](#formprops-react-router-api-reference) - [HistoryRouterProps | React Router API Reference](#historyrouterprops-react-router-api-reference) - [IndexRouteProps | React Router API Reference](#indexrouteprops-react-router-api-reference) - [IndexRouteObject | React Router API Reference](#indexrouteobject-react-router-api-reference) - [LayoutRouteProps | React Router API Reference](#layoutrouteprops-react-router-api-reference) - [LazyRouteFunction | React Router API Reference](#lazyroutefunction-react-router-api-reference) - [LinksFunction | React Router API Reference](#linksfunction-react-router-api-reference) - [LoaderFunctionArgs | React Router API Reference](#loaderfunctionargs-react-router-api-reference) - [Location | React Router API Reference](#location-react-router-api-reference) - [MemoryRouterProps | React Router API Reference](#memoryrouterprops-react-router-api-reference) - [MetaArgs | React Router API Reference](#metaargs-react-router-api-reference) - [MetaFunction | React Router API Reference](#metafunction-react-router-api-reference) - [NavigateFunction | React Router API Reference](#navigatefunction-react-router-api-reference) - [NavigateProps | React Router API Reference](#navigateprops-react-router-api-reference) - [NavigateOptions | React Router API Reference](#navigateoptions-react-router-api-reference) - [OutletProps | React Router API Reference](#outletprops-react-router-api-reference) - [PageLinkDescriptor | React Router API Reference](#pagelinkdescriptor-react-router-api-reference) - [Path | React Router API Reference](#path-react-router-api-reference) - [PathMatch | React Router API Reference](#pathmatch-react-router-api-reference) - [LinkProps | React Router API Reference](#linkprops-react-router-api-reference) - [Navigator | React Router API Reference](#navigator-react-router-api-reference) - [NavLinkProps | React Router API Reference](#navlinkprops-react-router-api-reference) - [NonIndexRouteObject | React Router API Reference](#nonindexrouteobject-react-router-api-reference) - [PathPattern | React Router API Reference](#pathpattern-react-router-api-reference) - [RouteMatch | React Router API Reference](#routematch-react-router-api-reference) - [PathRouteProps | React Router API Reference](#pathrouteprops-react-router-api-reference) - [RouterInit | React Router API Reference](#routerinit-react-router-api-reference) - [RouterProps | React Router API Reference](#routerprops-react-router-api-reference) - [RouterProviderProps | React Router API Reference](#routerproviderprops-react-router-api-reference) - [RouterState | React Router API Reference](#routerstate-react-router-api-reference) - [RouterSubscriber | React Router API Reference](#routersubscriber-react-router-api-reference) - [RoutesProps | React Router API Reference](#routesprops-react-router-api-reference) - [RoutesTestStubProps | React Router API Reference](#routesteststubprops-react-router-api-reference) - [ServerEntryModule | React Router API Reference](#serverentrymodule-react-router-api-reference) - [ServerBuild | React Router API Reference](#serverbuild-react-router-api-reference) - [ServerRouterProps | React Router API Reference](#serverrouterprops-react-router-api-reference) - [SessionIdStorageStrategy | React Router API Reference](#sessionidstoragestrategy-react-router-api-reference) - [ShouldRevalidateFunction | React Router API Reference](#shouldrevalidatefunction-react-router-api-reference) - [StaticHandlerContext | React Router API Reference](#statichandlercontext-react-router-api-reference) - [ShouldRevalidateFunctionArgs | React Router API Reference](#shouldrevalidatefunctionargs-react-router-api-reference) - [Session | React Router API Reference](#session-react-router-api-reference) - [StaticRouterProps | React Router API Reference](#staticrouterprops-react-router-api-reference) - [SessionData | React Router API Reference](#sessiondata-react-router-api-reference) - [SessionStorage | React Router API Reference](#sessionstorage-react-router-api-reference) - [StaticHandler | React Router API Reference](#statichandler-react-router-api-reference) - [StaticRouterProviderProps | React Router API Reference](#staticrouterproviderprops-react-router-api-reference) - [SubmitFunction | React Router API Reference](#submitfunction-react-router-api-reference) - [SubmitOptions | React Router API Reference](#submitoptions-react-router-api-reference) - [UIMatch | React Router API Reference](#uimatch-react-router-api-reference) - [UNSAFE_AssetsManifest | React Router API Reference](#unsafe-assetsmanifest-react-router-api-reference) - [UNSAFE_RouteModules | React Router API Reference](#unsafe-routemodules-react-router-api-reference) - [Blocker | React Router API Reference](#blocker-react-router-api-reference) - [BlockerFunction | React Router API Reference](#blockerfunction-react-router-api-reference) - [ClientActionFunctionArgs | React Router API Reference](#clientactionfunctionargs-react-router-api-reference) - [ClientLoaderFunctionArgs | React Router API Reference](#clientloaderfunctionargs-react-router-api-reference) - [ClientActionFunction | React Router API Reference](#clientactionfunction-react-router-api-reference) - [DataRouteObject | React Router API Reference](#datarouteobject-react-router-api-reference) - [CookieOptions | React Router API Reference](#cookieoptions-react-router-api-reference) - [ClientLoaderFunction | React Router API Reference](#clientloaderfunction-react-router-api-reference) - [ErrorResponse | React Router API Reference](#errorresponse-react-router-api-reference) - [CreateRequestHandlerFunction | React Router API Reference](#createrequesthandlerfunction-react-router-api-reference) - [Fetcher | React Router API Reference](#fetcher-react-router-api-reference) - [FetcherWithComponents | React Router API Reference](#fetcherwithcomponents-react-router-api-reference) - [FlashSessionData | React Router API Reference](#flashsessiondata-react-router-api-reference) - [FormEncType | React Router API Reference](#formenctype-react-router-api-reference) - [FormMethod | React Router API Reference](#formmethod-react-router-api-reference) - [HeadersArgs | React Router API Reference](#headersargs-react-router-api-reference) - [HTMLFormMethod | React Router API Reference](#htmlformmethod-react-router-api-reference) - [HtmlLinkDescriptor | React Router API Reference](#htmllinkdescriptor-react-router-api-reference) - [HydrationState | React Router API Reference](#hydrationstate-react-router-api-reference) - [InitialEntry | React Router API Reference](#initialentry-react-router-api-reference) - [IsCookieFunction | React Router API Reference](#iscookiefunction-react-router-api-reference) - [IsSessionFunction | React Router API Reference](#issessionfunction-react-router-api-reference) - [LoaderFunction | React Router API Reference](#loaderfunction-react-router-api-reference) - [LinkDescriptor | React Router API Reference](#linkdescriptor-react-router-api-reference) - [MetaDescriptor | React Router API Reference](#metadescriptor-react-router-api-reference) - [Navigation | React Router API Reference](#navigation-react-router-api-reference) - [NavigationStates | React Router API Reference](#navigationstates-react-router-api-reference) - [ParamParseKey | React Router API Reference](#paramparsekey-react-router-api-reference) - [NavLinkRenderProps | React Router API Reference](#navlinkrenderprops-react-router-api-reference) - [ParamKeyValuePair | React Router API Reference](#paramkeyvaluepair-react-router-api-reference) - [PatchRoutesOnNavigationFunction | React Router API Reference](#patchroutesonnavigationfunction-react-router-api-reference) - [Params | React Router API Reference](#params-react-router-api-reference) - [PatchRoutesOnNavigationFunctionArgs | React Router API Reference](#patchroutesonnavigationfunctionargs-react-router-api-reference) - [RedirectFunction | React Router API Reference](#redirectfunction-react-router-api-reference) - [RelativeRoutingType | React Router API Reference](#relativeroutingtype-react-router-api-reference) - [PathParam | React Router API Reference](#pathparam-react-router-api-reference) - [RouteObject | React Router API Reference](#routeobject-react-router-api-reference) - [RevalidationState | React Router API Reference](#revalidationstate-react-router-api-reference) - [RequestHandler | React Router API Reference](#requesthandler-react-router-api-reference) - [RouteProps | React Router API Reference](#routeprops-react-router-api-reference) - [RouterFetchOptions | React Router API Reference](#routerfetchoptions-react-router-api-reference) - [RouterNavigateOptions | React Router API Reference](#routernavigateoptions-react-router-api-reference) - [ScriptsProps | React Router API Reference](#scriptsprops-react-router-api-reference) - [SetURLSearchParams | React Router API Reference](#seturlsearchparams-react-router-api-reference) - [ScrollRestorationProps | React Router API Reference](#scrollrestorationprops-react-router-api-reference) - [SubmitTarget | React Router API Reference](#submittarget-react-router-api-reference) - [To | React Router API Reference](#to-react-router-api-reference) - [IDLE_BLOCKER | React Router API Reference](#idle-blocker-react-router-api-reference) - [URLSearchParamsInit | React Router API Reference](#urlsearchparamsinit-react-router-api-reference) - [IDLE_FETCHER | React Router API Reference](#idle-fetcher-react-router-api-reference) - [IDLE_NAVIGATION | React Router API Reference](#idle-navigation-react-router-api-reference) - [UNSAFE_DataRouterContext | React Router API Reference](#unsafe-dataroutercontext-react-router-api-reference) - [UNSAFE_DataRouterStateContext | React Router API Reference](#unsafe-datarouterstatecontext-react-router-api-reference) - [UNSAFE_NavigationContext | React Router API Reference](#unsafe-navigationcontext-react-router-api-reference) - [UNSAFE_SingleFetchRedirectSymbol | React Router API Reference](#unsafe-singlefetchredirectsymbol-react-router-api-reference) - [UNSAFE_RouteContext | React Router API Reference](#unsafe-routecontext-react-router-api-reference) - [UNSAFE_ViewTransitionContext | React Router API Reference](#unsafe-viewtransitioncontext-react-router-api-reference) - [UNSAFE_LocationContext | React Router API Reference](#unsafe-locationcontext-react-router-api-reference) - [UNSAFE_FrameworkContext | React Router API Reference](#unsafe-frameworkcontext-react-router-api-reference) - [UNSAFE_FetchersContext | React Router API Reference](#unsafe-fetcherscontext-react-router-api-reference) - [Await | React Router API Reference](#await-react-router-api-reference) - [BrowserRouter | React Router API Reference](#browserrouter-react-router-api-reference) - [createCookie | React Router API Reference](#createcookie-react-router-api-reference) - [createBrowserRouter | React Router API Reference](#createbrowserrouter-react-router-api-reference) - [createHashRouter | React Router API Reference](#createhashrouter-react-router-api-reference) - [createCookieSessionStorage | React Router API Reference](#createcookiesessionstorage-react-router-api-reference) - [createMemorySessionStorage | React Router API Reference](#creatememorysessionstorage-react-router-api-reference) - [createRequestHandler | React Router API Reference](#createrequesthandler-react-router-api-reference) - [createMemoryRouter | React Router API Reference](#creatememoryrouter-react-router-api-reference) - [createRoutesFromChildren | React Router API Reference](#createroutesfromchildren-react-router-api-reference) - [createPath | React Router API Reference](#createpath-react-router-api-reference) - [createRoutesStub | React Router API Reference](#createroutesstub-react-router-api-reference) - [Page not found · GitHub Pages](#page-not-found-github-pages) - [createSearchParams | React Router API Reference](#createsearchparams-react-router-api-reference) - [createSession | React Router API Reference](#createsession-react-router-api-reference) - [createStaticRouter | React Router API Reference](#createstaticrouter-react-router-api-reference) - [createSessionStorage | React Router API Reference](#createsessionstorage-react-router-api-reference) - [createStaticHandler | React Router API Reference](#createstatichandler-react-router-api-reference) - [data | React Router API Reference](#data-react-router-api-reference) - [HashRouter | React Router API Reference](#hashrouter-react-router-api-reference) - [Form | React Router API Reference](#form-react-router-api-reference) - [isSession | React Router API Reference](#issession-react-router-api-reference) - [generatePath | React Router API Reference](#generatepath-react-router-api-reference) - [isCookie | React Router API Reference](#iscookie-react-router-api-reference) - [isRouteErrorResponse | React Router API Reference](#isrouteerrorresponse-react-router-api-reference) - [Link | React Router API Reference](#link-react-router-api-reference) - [Links | React Router API Reference](#links-react-router-api-reference) - [matchRoutes | React Router API Reference](#matchroutes-react-router-api-reference) - [MemoryRouter | React Router API Reference](#memoryrouter-react-router-api-reference) - [Meta | React Router API Reference](#meta-react-router-api-reference) - [NavLink | React Router API Reference](#navlink-react-router-api-reference) - [matchPath | React Router API Reference](#matchpath-react-router-api-reference) - [Outlet | React Router API Reference](#outlet-react-router-api-reference) - [Navigate | React Router API Reference](#navigate-react-router-api-reference) - [parsePath | React Router API Reference](#parsepath-react-router-api-reference) - [PrefetchPageLinks | React Router API Reference](#prefetchpagelinks-react-router-api-reference) - [redirect | React Router API Reference](#redirect-react-router-api-reference) - [redirectDocument | React Router API Reference](#redirectdocument-react-router-api-reference) - [replace | React Router API Reference](#replace-react-router-api-reference) - [renderMatches | React Router API Reference](#rendermatches-react-router-api-reference) - [resolvePath | React Router API Reference](#resolvepath-react-router-api-reference) - [Route | React Router API Reference](#route-react-router-api-reference) - [RouterProvider | React Router API Reference](#routerprovider-react-router-api-reference) - [Router | React Router API Reference](#router-react-router-api-reference) - [Routes | React Router API Reference](#routes-react-router-api-reference) - [Scripts | React Router API Reference](#scripts-react-router-api-reference) - [ScrollRestoration | React Router API Reference](#scrollrestoration-react-router-api-reference) - [ServerRouter | React Router API Reference](#serverrouter-react-router-api-reference) - [StaticRouter | React Router API Reference](#staticrouter-react-router-api-reference) - [UNSAFE_createBrowserHistory | React Router API Reference](#unsafe-createbrowserhistory-react-router-api-reference) - [UNSAFE_createClientRoutes | React Router API Reference](#unsafe-createclientroutes-react-router-api-reference) - [StaticRouterProvider | React Router API Reference](#staticrouterprovider-react-router-api-reference) - [UNSAFE_createRouter | React Router API Reference](#unsafe-createrouter-react-router-api-reference) - [UNSAFE_createClientRoutesWithHMRRevalidationOptOut | React Router API Reference](#unsafe-createclientrouteswithhmrrevalidationoptout-react-router-api-reference) - [UNSAFE_decodeViaTurboStream | React Router API Reference](#unsafe-decodeviaturbostream-react-router-api-reference) - [UNSAFE_deserializeErrors | React Router API Reference](#unsafe-deserializeerrors-react-router-api-reference) - [UNSAFE_getPatchRoutesOnNavigationFunction | React Router API Reference](#unsafe-getpatchroutesonnavigationfunction-react-router-api-reference) - [UNSAFE_getSingleFetchDataStrategy | React Router API Reference](#unsafe-getsinglefetchdatastrategy-react-router-api-reference) - [UNSAFE_shouldHydrateRouteLoader | React Router API Reference](#unsafe-shouldhydraterouteloader-react-router-api-reference) - [UNSAFE_useFogOFWarDiscovery | React Router API Reference](#unsafe-usefogofwardiscovery-react-router-api-reference) - [UNSAFE_useScrollRestoration | React Router API Reference](#unsafe-usescrollrestoration-react-router-api-reference) - [unstable_HistoryRouter | React Router API Reference](#unstable-historyrouter-react-router-api-reference) - [unstable_setDevServerHooks | React Router API Reference](#unstable-setdevserverhooks-react-router-api-reference) - [unstable_usePrompt | React Router API Reference](#unstable-useprompt-react-router-api-reference) - [useActionData | React Router API Reference](#useactiondata-react-router-api-reference) - [useAsyncValue | React Router API Reference](#useasyncvalue-react-router-api-reference) - [useAsyncError | React Router API Reference](#useasyncerror-react-router-api-reference) - [useBeforeUnload | React Router API Reference](#usebeforeunload-react-router-api-reference) - [useBlocker | React Router API Reference](#useblocker-react-router-api-reference) - [useFetcher | React Router API Reference](#usefetcher-react-router-api-reference) - [useFetchers | React Router API Reference](#usefetchers-react-router-api-reference) - [useFormAction | React Router API Reference](#useformaction-react-router-api-reference) - [useHref | React Router API Reference](#usehref-react-router-api-reference) - [useInRouterContext | React Router API Reference](#useinroutercontext-react-router-api-reference) - [useLinkClickHandler | React Router API Reference](#uselinkclickhandler-react-router-api-reference) - [useLoaderData | React Router API Reference](#useloaderdata-react-router-api-reference) - [useLocation | React Router API Reference](#uselocation-react-router-api-reference) - [useMatch | React Router API Reference](#usematch-react-router-api-reference) - [useMatches | React Router API Reference](#usematches-react-router-api-reference) - [useNavigate | React Router API Reference](#usenavigate-react-router-api-reference) - [useNavigation | React Router API Reference](#usenavigation-react-router-api-reference) - [useOutlet | React Router API Reference](#useoutlet-react-router-api-reference) - [useOutletContext | React Router API Reference](#useoutletcontext-react-router-api-reference) - [useNavigationType | React Router API Reference](#usenavigationtype-react-router-api-reference) - [useParams | React Router API Reference](#useparams-react-router-api-reference) - [useResolvedPath | React Router API Reference](#useresolvedpath-react-router-api-reference) - [useRevalidator | React Router API Reference](#userevalidator-react-router-api-reference) - [useRouteError | React Router API Reference](#userouteerror-react-router-api-reference) - [useRouteLoaderData | React Router API Reference](#userouteloaderdata-react-router-api-reference) - [useRoutes | React Router API Reference](#useroutes-react-router-api-reference) - [useSearchParams | React Router API Reference](#usesearchparams-react-router-api-reference) - [useSubmit | React Router API Reference](#usesubmit-react-router-api-reference) - [useViewTransitionState | React Router API Reference](#useviewtransitionstate-react-router-api-reference) - [@react-router/architect | React Router API Reference](#-react-router-architect-react-router-api-reference) - [GetLoadContextFunction | React Router API Reference](#getloadcontextfunction-react-router-api-reference) - [createArcTableSessionStorage | React Router API Reference](#createarctablesessionstorage-react-router-api-reference) - [RequestHandler | React Router API Reference](#requesthandler-react-router-api-reference) - [createRequestHandler | React Router API Reference](#createrequesthandler-react-router-api-reference) - [@react-router/cloudflare | React Router API Reference](#-react-router-cloudflare-react-router-api-reference) - [createPagesFunctionHandlerParams | React Router API Reference](#createpagesfunctionhandlerparams-react-router-api-reference) - [RequestHandler | React Router API Reference](#requesthandler-react-router-api-reference) - [GetLoadContextFunction | React Router API Reference](#getloadcontextfunction-react-router-api-reference) - [createPagesFunctionHandler | React Router API Reference](#createpagesfunctionhandler-react-router-api-reference) - [createRequestHandler | React Router API Reference](#createrequesthandler-react-router-api-reference) - [createWorkersKVSessionStorage | React Router API Reference](#createworkerskvsessionstorage-react-router-api-reference) - [@react-router/dev | React Router API Reference](#-react-router-dev-react-router-api-reference) - [config | React Router API Reference](#config-react-router-api-reference) - [BuildManifest | React Router API Reference](#buildmanifest-react-router-api-reference) - [Preset | React Router API Reference](#preset-react-router-api-reference) - [Config | React Router API Reference](#config-react-router-api-reference) - [routes | React Router API Reference](#routes-react-router-api-reference) - [ServerBundlesFunction | React Router API Reference](#serverbundlesfunction-react-router-api-reference) - [RouteConfigEntry | React Router API Reference](#routeconfigentry-react-router-api-reference) - [index | React Router API Reference](#index-react-router-api-reference) - [layout | React Router API Reference](#layout-react-router-api-reference) - [RouteConfig | React Router API Reference](#routeconfig-react-router-api-reference) - [prefix | React Router API Reference](#prefix-react-router-api-reference) - [relative | React Router API Reference](#relative-react-router-api-reference) - [getAppDirectory | React Router API Reference](#getappdirectory-react-router-api-reference) - [route | React Router API Reference](#route-react-router-api-reference) - [vite | React Router API Reference](#vite-react-router-api-reference) - [reactRouter | React Router API Reference](#reactrouter-react-router-api-reference) - [vite/cloudflare | React Router API Reference](#vite-cloudflare-react-router-api-reference) - [cloudflareDevProxy | React Router API Reference](#cloudflaredevproxy-react-router-api-reference) - [@react-router/express | React Router API Reference](#-react-router-express-react-router-api-reference) - [react-router-dom | React Router API Reference](#react-router-dom-react-router-api-reference) - [GetLoadContextFunction | React Router API Reference](#getloadcontextfunction-react-router-api-reference) - [RequestHandler | React Router API Reference](#requesthandler-react-router-api-reference) - [@react-router/fs-routes | React Router API Reference](#-react-router-fs-routes-react-router-api-reference) - [@react-router/node | React Router API Reference](#-react-router-node-react-router-api-reference) - [createRequestHandler | React Router API Reference](#createrequesthandler-react-router-api-reference) - [flatRoutes | React Router API Reference](#flatroutes-react-router-api-reference) --- # React Router API Reference * [React Router API Reference](modules.html) React Router API Reference ========================== ### Index ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # React Router API Reference React Router API Reference ========================== [![npm package](https://img.shields.io/npm/v/react-router-dom.svg?style=flat-square)](https://www.npmjs.org/package/react-router-dom) [![build](https://img.shields.io/github/actions/workflow/status/remix-run/react-router/test.yml?branch=dev&style=square)](https://github.com/remix-run/react-router/actions/workflows/test.yml) React Router is a multi-strategy router for React bridging the gap from React 18 to React 19. You can use it maximally as a React framework or minimally as a library with your own architecture. * [Getting Started - Framework](https://reactrouter.com/start/framework/installation) * [Getting Started - Library](https://reactrouter.com/start/library/installation) * [Upgrade from v6](https://reactrouter.com/upgrading/v6) * [Upgrade from Remix](https://reactrouter.com/upgrading/remix) * [Changelog](https://github.com/remix-run/react-router/blob/main/CHANGELOG.md) Packages[](#md:packages) ------------------------- * [react-router](./modules/react_router) * [@react-router/dev](./modules/_react_router_dev) * [@react-router/node](./modules/_react_router_node) * [@react-router/cloudflare](./modules/_react_router_cloudflare) * [@react-router/serve](./modules/_react_router_serve) * [@react-router/fs-routes](./modules/_react_router_fs_routes) Previous Versions[](#md:previous-versions) ------------------------------------------- * [v6](https://reactrouter.com/v6) * [v5](https://v5.reactrouter.com/) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [Packages](#md:packages) [Previous Versions](#md:previous-versions) --- # create-react-router | React Router API Reference * [React Router API Reference](../modules.html) * [create-react-router](create_react_router.html) Module create-react-router ========================== Create a new React Router app. npm create react-router ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # React Router API Reference React Router API Reference ========================== Class Hierarchy --------------- * [FetcherSubmitOptions](interfaces/react_router.FetcherSubmitOptions.html) * [SubmitOptions](interfaces/react_router.SubmitOptions.html) * [Path](interfaces/react_router.Path.html) * [Location](interfaces/react_router.Location.html) * [PathRouteProps](interfaces/react_router.PathRouteProps.html) * [LayoutRouteProps](interfaces/react_router.LayoutRouteProps.html) * [RouteMatch](interfaces/react_router.RouteMatch.html) * [DataRouteMatch](interfaces/react_router.DataRouteMatch.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # UNSAFE_DataWithResponseInit | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [UNSAFE\_DataWithResponseInit](react_router.UNSAFE_DataWithResponseInit.html) Class UNSAFE\_DataWithResponseInit ===================================== #### Type Parameters * D ##### Index ### Constructors [constructor](react_router.UNSAFE_DataWithResponseInit.html#constructor) ### Properties [data](react_router.UNSAFE_DataWithResponseInit.html#data) [init](react_router.UNSAFE_DataWithResponseInit.html#init) [type](react_router.UNSAFE_DataWithResponseInit.html#type) Constructors ------------ ### constructor[](#constructor) * new UNSAFE\_DataWithResponseInit<[D](react_router.UNSAFE_DataWithResponseInit.html#constructor.new_UNSAFE_DataWithResponseInit.D-1) \>(data, init?): [UNSAFE\_DataWithResponseInit](react_router.UNSAFE_DataWithResponseInit.html) <[D](react_router.UNSAFE_DataWithResponseInit.html#constructor.new_UNSAFE_DataWithResponseInit.D-1) \>[](#constructor.new_UNSAFE_DataWithResponseInit) * #### Type Parameters * D #### Parameters * data: [D](react_router.UNSAFE_DataWithResponseInit.html#constructor.new_UNSAFE_DataWithResponseInit.D-1) * `Optional`init: ResponseInit #### Returns [UNSAFE\_DataWithResponseInit](react_router.UNSAFE_DataWithResponseInit.html) <[D](react_router.UNSAFE_DataWithResponseInit.html#constructor.new_UNSAFE_DataWithResponseInit.D-1) \> Properties ---------- ### data[](#data) data: [D](react_router.UNSAFE_DataWithResponseInit.html#constructor.new_UNSAFE_DataWithResponseInit.D-1) ### init[](#init) init: null | ResponseInit ### type[](#type) type: string = "DataWithResponseInit" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](#constructor) Properties [data](#data) [init](#init) [type](#type) --- # NavigationType | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [NavigationType](react_router.NavigationType.html) Enumeration NavigationType ========================== Actions represent the type of change to a location value. ##### Index ### Enumeration Members [Pop](react_router.NavigationType.html#Pop) [Push](react_router.NavigationType.html#Push) [Replace](react_router.NavigationType.html#Replace) Enumeration Members ------------------- ### Pop[](#Pop) Pop A POP indicates a change to an arbitrary index in the history stack, such as a back or forward navigation. It does not describe the direction of the navigation, only that the current index changed. Note: This is the default action for newly created history objects. ### Push[](#Push) Push A PUSH indicates a new entry being added to the history stack, such as when a link is clicked and a new page loads. When this happens, all subsequent entries in the stack are lost. ### Replace[](#Replace) Replace A REPLACE indicates the entry at the current index in the history stack being replaced by a new one. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Enumeration Members [Pop](#Pop) [Push](#Push) [Replace](#Replace) --- # ActionFunctionArgs | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ActionFunctionArgs](react_router.ActionFunctionArgs.html) Interface ActionFunctionArgs ===================================== Arguments passed to action functions interface ActionFunctionArgs<[Context](react_router.ActionFunctionArgs.html#Context) \> {     [context](react_router.ActionFunctionArgs.html#context-1) ?: [Context](react_router.ActionFunctionArgs.html#Context) ;     [params](react_router.ActionFunctionArgs.html#params) : [Params](../types/react_router.Params.html) ;     [request](react_router.ActionFunctionArgs.html#request) : Request; } #### Type Parameters * Context = any #### Hierarchy * DataFunctionArgs<[Context](react_router.ActionFunctionArgs.html#Context) \> * ActionFunctionArgs ##### Index ### Properties [context?](react_router.ActionFunctionArgs.html#context-1) [params](react_router.ActionFunctionArgs.html#params) [request](react_router.ActionFunctionArgs.html#request) Properties ---------- ### `Optional`context[](#context-1) context?: [Context](react_router.ActionFunctionArgs.html#Context) ### params[](#params) params: [Params](../types/react_router.Params.html) ### request[](#request) request: Request ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [context](#context-1) [params](#params) [request](#request) --- # UNSAFE_ServerMode | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [UNSAFE\_ServerMode](react_router.UNSAFE_ServerMode.html) Enumeration UNSAFE\_ServerMode ============================== The mode to use when running the server. ##### Index ### Enumeration Members [Development](react_router.UNSAFE_ServerMode.html#Development) [Production](react_router.UNSAFE_ServerMode.html#Production) [Test](react_router.UNSAFE_ServerMode.html#Test) Enumeration Members ------------------- ### Development[](#Development) Development ### Production[](#Production) Production ### Test[](#Test) Test ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Enumeration Members [Development](#Development) [Production](#Production) [Test](#Test) --- # ActionFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ActionFunction](react_router.ActionFunction.html) Interface ActionFunction ================================= Route action function signature #### Type Parameters * Context = any * ActionFunction(args, handlerCtx?): DataFunctionReturnValue[](#ActionFunction) * #### Parameters * args: [ActionFunctionArgs](react_router.ActionFunctionArgs.html) <[Context](react_router.ActionFunction.html#Context) \> * `Optional`handlerCtx: unknown #### Returns DataFunctionReturnValue ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # react-router | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](react_router.html) Module react-router =================== `react-router` is the primary package in the React Router project. Installation[](#md:installation) --------------------------------- npm i react-router ##### Index ### Routers [createBrowserRouter](../functions/react_router.createBrowserRouter.html) [createHashRouter](../functions/react_router.createHashRouter.html) [createMemoryRouter](../functions/react_router.createMemoryRouter.html) [createStaticRouter](../functions/react_router.createStaticRouter.html) ### Router Components [BrowserRouter](../functions/react_router.BrowserRouter.html) [HashRouter](../functions/react_router.HashRouter.html) [MemoryRouter](../functions/react_router.MemoryRouter.html) [StaticRouter](../functions/react_router.StaticRouter.html) [StaticRouterProvider](../functions/react_router.StaticRouterProvider.html) [unstable\_HistoryRouter](../functions/react_router.unstable_HistoryRouter.html) ### Components [Await](../functions/react_router.Await.html) [Form](../functions/react_router.Form.html) [Link](../functions/react_router.Link.html) [Links](../functions/react_router.Links.html) [Meta](../functions/react_router.Meta.html) [Navigate](../functions/react_router.Navigate.html) [NavLink](../functions/react_router.NavLink.html) [Outlet](../functions/react_router.Outlet.html) [PrefetchPageLinks](../functions/react_router.PrefetchPageLinks.html) [Route](../functions/react_router.Route.html) [Router](../functions/react_router.Router.html) [Routes](../functions/react_router.Routes.html) [Scripts](../functions/react_router.Scripts.html) [ScrollRestoration](../functions/react_router.ScrollRestoration.html) [ServerRouter](../functions/react_router.ServerRouter.html) ### Hooks [unstable\_usePrompt](../functions/react_router.unstable_usePrompt.html) [useActionData](../functions/react_router.useActionData.html) [useAsyncError](../functions/react_router.useAsyncError.html) [useAsyncValue](../functions/react_router.useAsyncValue.html) [useBeforeUnload](../functions/react_router.useBeforeUnload.html) [useBlocker](../functions/react_router.useBlocker.html) [useFetcher](../functions/react_router.useFetcher.html) [useFetchers](../functions/react_router.useFetchers.html) [useFormAction](../functions/react_router.useFormAction.html) [useHref](../functions/react_router.useHref.html) [useInRouterContext](../functions/react_router.useInRouterContext.html) [useLinkClickHandler](../functions/react_router.useLinkClickHandler.html) [useLoaderData](../functions/react_router.useLoaderData.html) [useLocation](../functions/react_router.useLocation.html) [useMatch](../functions/react_router.useMatch.html) [useMatches](../functions/react_router.useMatches.html) [useNavigate](../functions/react_router.useNavigate.html) [useNavigation](../functions/react_router.useNavigation.html) [useNavigationType](../functions/react_router.useNavigationType.html) [useOutlet](../functions/react_router.useOutlet.html) [useOutletContext](../functions/react_router.useOutletContext.html) [useParams](../functions/react_router.useParams.html) [useResolvedPath](../functions/react_router.useResolvedPath.html) [useRevalidator](../functions/react_router.useRevalidator.html) [useRouteError](../functions/react_router.useRouteError.html) [useRouteLoaderData](../functions/react_router.useRouteLoaderData.html) [useRoutes](../functions/react_router.useRoutes.html) [useSearchParams](../functions/react_router.useSearchParams.html) [useSubmit](../functions/react_router.useSubmit.html) [useViewTransitionState](../functions/react_router.useViewTransitionState.html) ### Utils [createPath](../functions/react_router.createPath.html) [createRoutesFromChildren](../functions/react_router.createRoutesFromChildren.html) [createRoutesStub](../functions/react_router.createRoutesStub.html) [createSearchParams](../functions/react_router.createSearchParams.html) [createStaticHandler](../functions/react_router.createStaticHandler.html) [data](../functions/react_router.data.html) [generatePath](../functions/react_router.generatePath.html) [isRouteErrorResponse](../functions/react_router.isRouteErrorResponse.html) [matchPath](../functions/react_router.matchPath.html) [matchRoutes](../functions/react_router.matchRoutes.html) [parsePath](../functions/react_router.parsePath.html) [redirect](../functions/react_router.redirect.html) [redirectDocument](../functions/react_router.redirectDocument.html) [renderMatches](../functions/react_router.renderMatches.html) [replace](../functions/react_router.replace.html) [resolvePath](../functions/react_router.resolvePath.html) ### Types [AwaitProps](../interfaces/react_router.AwaitProps.html) [BrowserRouterProps](../interfaces/react_router.BrowserRouterProps.html) [FetcherFormProps](../interfaces/react_router.FetcherFormProps.html) [FormProps](../interfaces/react_router.FormProps.html) [HashRouterProps](../interfaces/react_router.HashRouterProps.html) [HistoryRouterProps](../interfaces/react_router.HistoryRouterProps.html) [IndexRouteProps](../interfaces/react_router.IndexRouteProps.html) [LayoutRouteProps](../interfaces/react_router.LayoutRouteProps.html) [LinkProps](../interfaces/react_router.LinkProps.html) [MemoryRouterProps](../interfaces/react_router.MemoryRouterProps.html) [NavigateProps](../interfaces/react_router.NavigateProps.html) [NavLinkProps](../interfaces/react_router.NavLinkProps.html) [OutletProps](../interfaces/react_router.OutletProps.html) [PathRouteProps](../interfaces/react_router.PathRouteProps.html) [RouterProps](../interfaces/react_router.RouterProps.html) [RoutesProps](../interfaces/react_router.RoutesProps.html) [ScriptsProps](../types/react_router.ScriptsProps.html) ### Other [createRoutesFromElements](react_router.html#createRoutesFromElements) [NavigationType](../enums/react_router.NavigationType.html) [UNSAFE\_ServerMode](../enums/react_router.UNSAFE_ServerMode.html) [UNSAFE\_DataWithResponseInit](../classes/react_router.UNSAFE_DataWithResponseInit.html) [UNSAFE\_RemixErrorBoundary](../classes/react_router.UNSAFE_RemixErrorBoundary.html) [ActionFunction](../interfaces/react_router.ActionFunction.html) [ActionFunctionArgs](../interfaces/react_router.ActionFunctionArgs.html) [AppLoadContext](../interfaces/react_router.AppLoadContext.html) [Cookie](../interfaces/react_router.Cookie.html) [CookieParseOptions](../interfaces/react_router.CookieParseOptions.html) [CookieSerializeOptions](../interfaces/react_router.CookieSerializeOptions.html) [CookieSignatureOptions](../interfaces/react_router.CookieSignatureOptions.html) [DataRouteMatch](../interfaces/react_router.DataRouteMatch.html) [DataRouter](../interfaces/react_router.DataRouter.html) [DataStrategyFunction](../interfaces/react_router.DataStrategyFunction.html) [DataStrategyFunctionArgs](../interfaces/react_router.DataStrategyFunctionArgs.html) [DataStrategyMatch](../interfaces/react_router.DataStrategyMatch.html) [DataStrategyResult](../interfaces/react_router.DataStrategyResult.html) [EntryContext](../interfaces/react_router.EntryContext.html) [FetcherSubmitFunction](../interfaces/react_router.FetcherSubmitFunction.html) [FetcherSubmitOptions](../interfaces/react_router.FetcherSubmitOptions.html) [GetScrollPositionFunction](../interfaces/react_router.GetScrollPositionFunction.html) [GetScrollRestorationKeyFunction](../interfaces/react_router.GetScrollRestorationKeyFunction.html) [HandleDataRequestFunction](../interfaces/react_router.HandleDataRequestFunction.html) [HandleDocumentRequestFunction](../interfaces/react_router.HandleDocumentRequestFunction.html) [HandleErrorFunction](../interfaces/react_router.HandleErrorFunction.html) [HeadersFunction](../interfaces/react_router.HeadersFunction.html) [IndexRouteObject](../interfaces/react_router.IndexRouteObject.html) [LazyRouteFunction](../interfaces/react_router.LazyRouteFunction.html) [LinksFunction](../interfaces/react_router.LinksFunction.html) [LoaderFunctionArgs](../interfaces/react_router.LoaderFunctionArgs.html) [Location](../interfaces/react_router.Location.html) [MetaArgs](../interfaces/react_router.MetaArgs.html) [MetaFunction](../interfaces/react_router.MetaFunction.html) [NavigateFunction](../interfaces/react_router.NavigateFunction.html) [NavigateOptions](../interfaces/react_router.NavigateOptions.html) [Navigator](../interfaces/react_router.Navigator.html) [NonIndexRouteObject](../interfaces/react_router.NonIndexRouteObject.html) [PageLinkDescriptor](../interfaces/react_router.PageLinkDescriptor.html) [Path](../interfaces/react_router.Path.html) [PathMatch](../interfaces/react_router.PathMatch.html) [PathPattern](../interfaces/react_router.PathPattern.html) [RouteMatch](../interfaces/react_router.RouteMatch.html) [RouterInit](../interfaces/react_router.RouterInit.html) [RouterProviderProps](../interfaces/react_router.RouterProviderProps.html) [RouterState](../interfaces/react_router.RouterState.html) [RouterSubscriber](../interfaces/react_router.RouterSubscriber.html) [RoutesTestStubProps](../interfaces/react_router.RoutesTestStubProps.html) [ServerBuild](../interfaces/react_router.ServerBuild.html) [ServerEntryModule](../interfaces/react_router.ServerEntryModule.html) [ServerRouterProps](../interfaces/react_router.ServerRouterProps.html) [Session](../interfaces/react_router.Session.html) [SessionData](../interfaces/react_router.SessionData.html) [SessionIdStorageStrategy](../interfaces/react_router.SessionIdStorageStrategy.html) [SessionStorage](../interfaces/react_router.SessionStorage.html) [ShouldRevalidateFunction](../interfaces/react_router.ShouldRevalidateFunction.html) [ShouldRevalidateFunctionArgs](../interfaces/react_router.ShouldRevalidateFunctionArgs.html) [StaticHandler](../interfaces/react_router.StaticHandler.html) [StaticHandlerContext](../interfaces/react_router.StaticHandlerContext.html) [StaticRouterProps](../interfaces/react_router.StaticRouterProps.html) [StaticRouterProviderProps](../interfaces/react_router.StaticRouterProviderProps.html) [SubmitFunction](../interfaces/react_router.SubmitFunction.html) [SubmitOptions](../interfaces/react_router.SubmitOptions.html) [UIMatch](../interfaces/react_router.UIMatch.html) [UNSAFE\_AssetsManifest](../interfaces/react_router.UNSAFE_AssetsManifest.html) [UNSAFE\_RouteModules](../interfaces/react_router.UNSAFE_RouteModules.html) [Blocker](../types/react_router.Blocker.html) [BlockerFunction](../types/react_router.BlockerFunction.html) [ClientActionFunction](../types/react_router.ClientActionFunction.html) [ClientActionFunctionArgs](../types/react_router.ClientActionFunctionArgs.html) [ClientLoaderFunction](../types/react_router.ClientLoaderFunction.html) [ClientLoaderFunctionArgs](../types/react_router.ClientLoaderFunctionArgs.html) [CookieOptions](../types/react_router.CookieOptions.html) [CreateRequestHandlerFunction](../types/react_router.CreateRequestHandlerFunction.html) [DataRouteObject](../types/react_router.DataRouteObject.html) [ErrorResponse](../types/react_router.ErrorResponse.html) [Fetcher](../types/react_router.Fetcher.html) [FetcherWithComponents](../types/react_router.FetcherWithComponents.html) [FlashSessionData](../types/react_router.FlashSessionData.html) [FormEncType](../types/react_router.FormEncType.html) [FormMethod](../types/react_router.FormMethod.html) [HeadersArgs](../types/react_router.HeadersArgs.html) [HTMLFormMethod](../types/react_router.HTMLFormMethod.html) [HtmlLinkDescriptor](../types/react_router.HtmlLinkDescriptor.html) [HydrationState](../types/react_router.HydrationState.html) [InitialEntry](../types/react_router.InitialEntry.html) [IsCookieFunction](../types/react_router.IsCookieFunction.html) [IsSessionFunction](../types/react_router.IsSessionFunction.html) [LinkDescriptor](../types/react_router.LinkDescriptor.html) [LoaderFunction](../types/react_router.LoaderFunction.html) [MetaDescriptor](../types/react_router.MetaDescriptor.html) [Navigation](../types/react_router.Navigation.html) [NavigationStates](../types/react_router.NavigationStates.html) [NavLinkRenderProps](../types/react_router.NavLinkRenderProps.html) [ParamKeyValuePair](../types/react_router.ParamKeyValuePair.html) [ParamParseKey](../types/react_router.ParamParseKey.html) [Params](../types/react_router.Params.html) [PatchRoutesOnNavigationFunction](../types/react_router.PatchRoutesOnNavigationFunction.html) [PatchRoutesOnNavigationFunctionArgs](../types/react_router.PatchRoutesOnNavigationFunctionArgs.html) [PathParam](../types/react_router.PathParam.html) [RedirectFunction](../types/react_router.RedirectFunction.html) [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) [RequestHandler](../types/react_router.RequestHandler.html) [RevalidationState](../types/react_router.RevalidationState.html) [RouteObject](../types/react_router.RouteObject.html) [RouteProps](../types/react_router.RouteProps.html) [RouterFetchOptions](../types/react_router.RouterFetchOptions.html) [RouterNavigateOptions](../types/react_router.RouterNavigateOptions.html) [ScrollRestorationProps](../types/react_router.ScrollRestorationProps.html) [SetURLSearchParams](../types/react_router.SetURLSearchParams.html) [SubmitTarget](../types/react_router.SubmitTarget.html) [To](../types/react_router.To.html) [URLSearchParamsInit](../types/react_router.URLSearchParamsInit.html) [IDLE\_BLOCKER](../variables/react_router.IDLE_BLOCKER.html) [IDLE\_FETCHER](../variables/react_router.IDLE_FETCHER.html) [IDLE\_NAVIGATION](../variables/react_router.IDLE_NAVIGATION.html) [UNSAFE\_DataRouterContext](../variables/react_router.UNSAFE_DataRouterContext.html) [UNSAFE\_DataRouterStateContext](../variables/react_router.UNSAFE_DataRouterStateContext.html) [UNSAFE\_FetchersContext](../variables/react_router.UNSAFE_FetchersContext.html) [UNSAFE\_FrameworkContext](../variables/react_router.UNSAFE_FrameworkContext.html) [UNSAFE\_LocationContext](../variables/react_router.UNSAFE_LocationContext.html) [UNSAFE\_NavigationContext](../variables/react_router.UNSAFE_NavigationContext.html) [UNSAFE\_RouteContext](../variables/react_router.UNSAFE_RouteContext.html) [UNSAFE\_SingleFetchRedirectSymbol](../variables/react_router.UNSAFE_SingleFetchRedirectSymbol.html) [UNSAFE\_ViewTransitionContext](../variables/react_router.UNSAFE_ViewTransitionContext.html) [createCookie](../functions/react_router.createCookie.html) [createCookieSessionStorage](../functions/react_router.createCookieSessionStorage.html) [createMemorySessionStorage](../functions/react_router.createMemorySessionStorage.html) [createRequestHandler](../functions/react_router.createRequestHandler.html) [createSession](../functions/react_router.createSession.html) [createSessionStorage](../functions/react_router.createSessionStorage.html) [isCookie](../functions/react_router.isCookie.html) [isSession](../functions/react_router.isSession.html) [RouterProvider](../functions/react_router.RouterProvider.html) [UNSAFE\_createBrowserHistory](../functions/react_router.UNSAFE_createBrowserHistory.html) [UNSAFE\_createClientRoutes](../functions/react_router.UNSAFE_createClientRoutes.html) [UNSAFE\_createClientRoutesWithHMRRevalidationOptOut](../functions/react_router.UNSAFE_createClientRoutesWithHMRRevalidationOptOut.html) [UNSAFE\_createRouter](../functions/react_router.UNSAFE_createRouter.html) [UNSAFE\_decodeViaTurboStream](../functions/react_router.UNSAFE_decodeViaTurboStream.html) [UNSAFE\_deserializeErrors](../functions/react_router.UNSAFE_deserializeErrors.html) [UNSAFE\_getPatchRoutesOnNavigationFunction](../functions/react_router.UNSAFE_getPatchRoutesOnNavigationFunction.html) [UNSAFE\_getSingleFetchDataStrategy](../functions/react_router.UNSAFE_getSingleFetchDataStrategy.html) [UNSAFE\_shouldHydrateRouteLoader](../functions/react_router.UNSAFE_shouldHydrateRouteLoader.html) [UNSAFE\_useFogOFWarDiscovery](../functions/react_router.UNSAFE_useFogOFWarDiscovery.html) [UNSAFE\_useScrollRestoration](../functions/react_router.UNSAFE_useScrollRestoration.html) [unstable\_setDevServerHooks](../functions/react_router.unstable_setDevServerHooks.html) Other ----- ### createRoutesFromElements[](#createRoutesFromElements) Renames and re-exports [createRoutesFromChildren](../functions/react_router.createRoutesFromChildren.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page [Installation](#md:installation) Other [createRoutesFromElements](#createRoutesFromElements) --- # UNSAFE_RemixErrorBoundary | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [UNSAFE\_RemixErrorBoundary](react_router.UNSAFE_RemixErrorBoundary.html) Class UNSAFE\_RemixErrorBoundary ================================ #### Hierarchy * Component * UNSAFE\_RemixErrorBoundary ##### Index ### Constructors [constructor](react_router.UNSAFE_RemixErrorBoundary.html#constructor) ### Properties [context](react_router.UNSAFE_RemixErrorBoundary.html#context) [props](react_router.UNSAFE_RemixErrorBoundary.html#props) [refs](react_router.UNSAFE_RemixErrorBoundary.html#refs) [state](react_router.UNSAFE_RemixErrorBoundary.html#state) [contextType?](react_router.UNSAFE_RemixErrorBoundary.html#contextType) ### Methods [componentDidCatch?](react_router.UNSAFE_RemixErrorBoundary.html#componentDidCatch) [componentDidMount?](react_router.UNSAFE_RemixErrorBoundary.html#componentDidMount) [componentDidUpdate?](react_router.UNSAFE_RemixErrorBoundary.html#componentDidUpdate) [componentWillMount?](react_router.UNSAFE_RemixErrorBoundary.html#componentWillMount) [componentWillReceiveProps?](react_router.UNSAFE_RemixErrorBoundary.html#componentWillReceiveProps) [componentWillUnmount?](react_router.UNSAFE_RemixErrorBoundary.html#componentWillUnmount) [componentWillUpdate?](react_router.UNSAFE_RemixErrorBoundary.html#componentWillUpdate) [forceUpdate](react_router.UNSAFE_RemixErrorBoundary.html#forceUpdate) [getSnapshotBeforeUpdate?](react_router.UNSAFE_RemixErrorBoundary.html#getSnapshotBeforeUpdate) [render](react_router.UNSAFE_RemixErrorBoundary.html#render) [setState](react_router.UNSAFE_RemixErrorBoundary.html#setState) [shouldComponentUpdate?](react_router.UNSAFE_RemixErrorBoundary.html#shouldComponentUpdate) [UNSAFE\_componentWillMount?](react_router.UNSAFE_RemixErrorBoundary.html#UNSAFE_componentWillMount) [UNSAFE\_componentWillReceiveProps?](react_router.UNSAFE_RemixErrorBoundary.html#UNSAFE_componentWillReceiveProps) [UNSAFE\_componentWillUpdate?](react_router.UNSAFE_RemixErrorBoundary.html#UNSAFE_componentWillUpdate) [getDerivedStateFromError](react_router.UNSAFE_RemixErrorBoundary.html#getDerivedStateFromError) [getDerivedStateFromProps](react_router.UNSAFE_RemixErrorBoundary.html#getDerivedStateFromProps) Constructors ------------ ### constructor[](#constructor) * new UNSAFE\_RemixErrorBoundary(props): [UNSAFE\_RemixErrorBoundary](react_router.UNSAFE_RemixErrorBoundary.html) [](#constructor.new_UNSAFE_RemixErrorBoundary) * #### Parameters * props: RemixErrorBoundaryProps #### Returns [UNSAFE\_RemixErrorBoundary](react_router.UNSAFE_RemixErrorBoundary.html) Properties ---------- ### context[](#context) context: unknown If using the new style context, re-declare this in your class to be the `React.ContextType` of your `static contextType`. Should be used with type annotation or static contextType. static contextType = MyContext// For TS pre-3.7:context!: React.ContextType// For TS 3.7 and above:declare context: React.ContextType #### See[](#See) [https://react.dev/reference/react/Component#context](https://react.dev/reference/react/Component#context) ### `Readonly`props[](#props) props: Readonly ### refs[](#refs) refs: {     \[key: string\]: ReactInstance; } #### Deprecated[](#Deprecated) [https://legacy.reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs](https://legacy.reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs) ### state[](#state) state: Readonly ### `Static` `Optional`contextType[](#contextType) contextType?: Context If set, `this.context` will be set at runtime to the current value of the given Context. Usage: type MyContext = numberconst Ctx = React.createContext(0)class Foo extends React.Component { static contextType = Ctx context!: React.ContextType render () { return <>My context's value: {this.context}; }} #### See[](#See-1) [https://react.dev/reference/react/Component#static-contexttype](https://react.dev/reference/react/Component#static-contexttype) Methods ------- ### `Optional`componentDidCatch[](#componentDidCatch) * componentDidCatch(error, errorInfo): void[](#componentDidCatch.componentDidCatch-1) * Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. #### Parameters * error: Error * errorInfo: ErrorInfo #### Returns void ### `Optional`componentDidMount[](#componentDidMount) * componentDidMount(): void[](#componentDidMount.componentDidMount-1) * Called immediately after a component is mounted. Setting state here will trigger re-rendering. #### Returns void ### `Optional`componentDidUpdate[](#componentDidUpdate) * componentDidUpdate(prevProps, prevState, snapshot?): void[](#componentDidUpdate.componentDidUpdate-1) * Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. #### Parameters * prevProps: Readonly * prevState: Readonly * `Optional`snapshot: any #### Returns void ### `Optional`componentWillMount[](#componentWillMount) * componentWillMount(): void[](#componentWillMount.componentWillMount-1) * Called immediately before mounting occurs, and before `Component#render`. Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. #### Returns void #### Deprecated[](#Deprecated-1) 16.3, use componentDidMount or the constructor instead; will stop working in React 17 #### See[](#See-2) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path) ### `Optional`componentWillReceiveProps[](#componentWillReceiveProps) * componentWillReceiveProps(nextProps, nextContext): void[](#componentWillReceiveProps.componentWillReceiveProps-1) * Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling `Component#setState` generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. #### Parameters * nextProps: Readonly * nextContext: any #### Returns void #### Deprecated[](#Deprecated-2) 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 #### See[](#See-3) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path) ### `Optional`componentWillUnmount[](#componentWillUnmount) * componentWillUnmount(): void[](#componentWillUnmount.componentWillUnmount-1) * Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in `componentDidMount`. #### Returns void ### `Optional`componentWillUpdate[](#componentWillUpdate) * componentWillUpdate(nextProps, nextState, nextContext): void[](#componentWillUpdate.componentWillUpdate-1) * Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call `Component#setState` here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. #### Parameters * nextProps: Readonly * nextState: Readonly * nextContext: any #### Returns void #### Deprecated[](#Deprecated-3) 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 #### See[](#See-4) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path) ### forceUpdate[](#forceUpdate) * forceUpdate(callback?): void[](#forceUpdate.forceUpdate-1) * #### Parameters * `Optional`callback: (() => void) * * (): void * #### Returns void #### Returns void ### `Optional`getSnapshotBeforeUpdate[](#getSnapshotBeforeUpdate) * getSnapshotBeforeUpdate(prevProps, prevState): any[](#getSnapshotBeforeUpdate.getSnapshotBeforeUpdate-1) * Runs before React applies the result of `render` to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before `render` causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. #### Parameters * prevProps: Readonly * prevState: Readonly #### Returns any ### render[](#render) * render():     | undefined     | null     | string     | number     | boolean     | Iterable     | Element[](#render.render-1) * #### Returns     | undefined     | null     | string     | number     | boolean     | Iterable     | Element ### setState[](#setState) * setState<[K](react_router.UNSAFE_RemixErrorBoundary.html#setState.setState-1.K) \>(state, callback?): void[](#setState.setState-1) * #### Type Parameters * K extends keyof RemixErrorBoundaryState #### Parameters * state:     | null     | RemixErrorBoundaryState     | ((prevState: Readonly, props: Readonly) => null | RemixErrorBoundaryState | Pick)     | Pick * `Optional`callback: (() => void) * * (): void * #### Returns void #### Returns void ### `Optional`shouldComponentUpdate[](#shouldComponentUpdate) * shouldComponentUpdate(nextProps, nextState, nextContext): boolean[](#shouldComponentUpdate.shouldComponentUpdate-1) * Called to determine whether the change in props and state should trigger a re-render. `Component` always returns true. `PureComponent` implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, `Component#render`, `componentWillUpdate` and `componentDidUpdate` will not be called. #### Parameters * nextProps: Readonly * nextState: Readonly * nextContext: any #### Returns boolean ### `Optional`UNSAFE\_componentWillMount[](#UNSAFE_componentWillMount) * UNSAFE\_componentWillMount(): void[](#UNSAFE_componentWillMount.UNSAFE_componentWillMount-1) * Called immediately before mounting occurs, and before `Component#render`. Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. #### Returns void #### Deprecated[](#Deprecated-4) 16.3, use componentDidMount or the constructor instead #### See[](#See-5) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path) ### `Optional`UNSAFE\_componentWillReceiveProps[](#UNSAFE_componentWillReceiveProps) * UNSAFE\_componentWillReceiveProps(nextProps, nextContext): void[](#UNSAFE_componentWillReceiveProps.UNSAFE_componentWillReceiveProps-1) * Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling `Component#setState` generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. #### Parameters * nextProps: Readonly * nextContext: any #### Returns void #### Deprecated[](#Deprecated-5) 16.3, use static getDerivedStateFromProps instead #### See[](#See-6) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path) ### `Optional`UNSAFE\_componentWillUpdate[](#UNSAFE_componentWillUpdate) * UNSAFE\_componentWillUpdate(nextProps, nextState, nextContext): void[](#UNSAFE_componentWillUpdate.UNSAFE_componentWillUpdate-1) * Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call `Component#setState` here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. #### Parameters * nextProps: Readonly * nextState: Readonly * nextContext: any #### Returns void #### Deprecated[](#Deprecated-6) 16.3, use getSnapshotBeforeUpdate instead #### See[](#See-7) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update) * [https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path](https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path) ### `Static`getDerivedStateFromError[](#getDerivedStateFromError) * getDerivedStateFromError(error): {     error: Error; }[](#getDerivedStateFromError.getDerivedStateFromError-1) * #### Parameters * error: Error #### Returns {     error: Error; } * ##### error: Error ### `Static`getDerivedStateFromProps[](#getDerivedStateFromProps) * getDerivedStateFromProps(props, state): {     error: null | Error;     location: [Location](../interfaces/react_router.Location.html) ; }[](#getDerivedStateFromProps.getDerivedStateFromProps-1) * #### Parameters * props: RemixErrorBoundaryProps * state: RemixErrorBoundaryState #### Returns {     error: null | Error;     location: [Location](../interfaces/react_router.Location.html) ; } * ##### error: null | Error * ##### location: [Location](../interfaces/react_router.Location.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Constructors [constructor](#constructor) Properties [context](#context) [props](#props) [refs](#refs) [state](#state) [contextType](#contextType) Methods [componentDidCatch](#componentDidCatch) [componentDidMount](#componentDidMount) [componentDidUpdate](#componentDidUpdate) [componentWillMount](#componentWillMount) [componentWillReceiveProps](#componentWillReceiveProps) [componentWillUnmount](#componentWillUnmount) [componentWillUpdate](#componentWillUpdate) [forceUpdate](#forceUpdate) [getSnapshotBeforeUpdate](#getSnapshotBeforeUpdate) [render](#render) [setState](#setState) [shouldComponentUpdate](#shouldComponentUpdate) [UNSAFE\_componentWillMount](#UNSAFE_componentWillMount) [UNSAFE\_componentWillReceiveProps](#UNSAFE_componentWillReceiveProps) [UNSAFE\_componentWillUpdate](#UNSAFE_componentWillUpdate) [getDerivedStateFromError](#getDerivedStateFromError) [getDerivedStateFromProps](#getDerivedStateFromProps) --- # AppLoadContext | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [AppLoadContext](react_router.AppLoadContext.html) Interface AppLoadContext ======================== An object of unknown type for route loaders and actions provided by the server's `getLoadContext()` function. This is defined as an empty interface specifically so apps can leverage declaration merging to augment this type globally: [https://www.typescriptlang.org/docs/handbook/declaration-merging.html](https://www.typescriptlang.org/docs/handbook/declaration-merging.html) #### Indexable * \[key: string\]: unknown ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # BrowserRouterProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [BrowserRouterProps](react_router.BrowserRouterProps.html) Interface BrowserRouterProps ============================ interface BrowserRouterProps {     [basename](react_router.BrowserRouterProps.html#basename) ?: string;     [children](react_router.BrowserRouterProps.html#children) ?: ReactNode;     [window](react_router.BrowserRouterProps.html#window) ?: Window; } ##### Index ### Properties [basename?](react_router.BrowserRouterProps.html#basename) [children?](react_router.BrowserRouterProps.html#children) [window?](react_router.BrowserRouterProps.html#window) Properties ---------- ### `Optional`basename[](#basename) basename?: string ### `Optional`children[](#children) children?: ReactNode ### `Optional`window[](#window) window?: Window ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [basename](#basename) [children](#children) [window](#window) --- # AwaitProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [AwaitProps](react_router.AwaitProps.html) Interface AwaitProps ============================= interface AwaitProps<[Resolve](react_router.AwaitProps.html#Resolve) \> {     [children](react_router.AwaitProps.html#children) : ReactNode | AwaitResolveRenderFunction<[Resolve](react_router.AwaitProps.html#Resolve) \>;     [errorElement](react_router.AwaitProps.html#errorElement) ?: ReactNode;     [resolve](react_router.AwaitProps.html#resolve-1) : [Resolve](react_router.AwaitProps.html#Resolve) ; } #### Type Parameters * Resolve ##### Index ### Properties [children](react_router.AwaitProps.html#children) [errorElement?](react_router.AwaitProps.html#errorElement) [resolve](react_router.AwaitProps.html#resolve-1) Properties ---------- ### children[](#children) children: ReactNode | AwaitResolveRenderFunction<[Resolve](react_router.AwaitProps.html#Resolve) \> When using a function, the resolved value is provided as the parameter. {(resolvedReviews) => } When using React elements, [useAsyncValue](../functions/react_router.useAsyncValue.html) will provide the resolved value: function Reviews() { const resolvedReviews = useAsyncValue() return
...
} ### `Optional`errorElement[](#errorElement) errorElement?: ReactNode The error element renders instead of the children when the promise rejects. Oops} resolve={reviewsPromise}> To provide a more contextual error, you can use the [useAsyncError](../functions/react_router.useAsyncError.html) in a child component } resolve={reviewsPromise}> function ReviewsError() { const error = useAsyncError() return
Error loading reviews: {error.message}
} If you do not provide an errorElement, the rejected value will bubble up to the nearest route-level [ErrorBoundary](react_router.NonIndexRouteObject.html#ErrorBoundary) and be accessible via [useRouteError](../functions/react_router.useRouteError.html) hook. ### resolve[](#resolve-1) resolve: [Resolve](react_router.AwaitProps.html#Resolve) Takes a promise returned from a [loader](../types/react_router.LoaderFunction.html) value to be resolved and rendered. import { useLoaderData, Await } from "react-router" export async function loader() { let reviews = getReviews() // not awaited let book = await getBook() return { book, reviews, // this is a promise } } export default function Book() { const { book, reviews, // this is the same promise } = useLoaderData() return ( {book.title} {book.description} }> ); } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [children](#children) [errorElement](#errorElement) [resolve](#resolve-1) --- # CookieSerializeOptions | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [CookieSerializeOptions](react_router.CookieSerializeOptions.html) Interface CookieSerializeOptions ================================ Serialize options. interface CookieSerializeOptions {     [domain](react_router.CookieSerializeOptions.html#domain) ?: string;     [encode](react_router.CookieSerializeOptions.html#encode) ?: ((str: string) => string);     [expires](react_router.CookieSerializeOptions.html#expires) ?: Date;     [httpOnly](react_router.CookieSerializeOptions.html#httpOnly) ?: boolean;     [maxAge](react_router.CookieSerializeOptions.html#maxAge) ?: number;     [partitioned](react_router.CookieSerializeOptions.html#partitioned) ?: boolean;     [path](react_router.CookieSerializeOptions.html#path) ?: string;     [priority](react_router.CookieSerializeOptions.html#priority) ?: "high" | "low" | "medium";     [sameSite](react_router.CookieSerializeOptions.html#sameSite) ?:         | boolean         | "none"         | "strict"         | "lax";     [secure](react_router.CookieSerializeOptions.html#secure) ?: boolean; } ##### Index ### Properties [domain?](react_router.CookieSerializeOptions.html#domain) [encode?](react_router.CookieSerializeOptions.html#encode) [expires?](react_router.CookieSerializeOptions.html#expires) [httpOnly?](react_router.CookieSerializeOptions.html#httpOnly) [maxAge?](react_router.CookieSerializeOptions.html#maxAge) [partitioned?](react_router.CookieSerializeOptions.html#partitioned) [path?](react_router.CookieSerializeOptions.html#path) [priority?](react_router.CookieSerializeOptions.html#priority) [sameSite?](react_router.CookieSerializeOptions.html#sameSite) [secure?](react_router.CookieSerializeOptions.html#secure) Properties ---------- ### `Optional`domain[](#domain) domain?: string Specifies the value for the [`Domain` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.3) . When no domain is set clients consider the cookie to apply to the current domain only. ### `Optional`encode[](#encode) encode?: ((str: string) => string) Specifies a function that will be used to encode a [cookie-value](https://datatracker.ietf.org/doc/html/rfc6265#section-4.1.1) . Since value of a cookie has a limited character set (and must be a simple string), this function can be used to encode a value into a string suited for a cookie's value, and should mirror `decode` when parsing. #### Default[](#Default) encodeURIComponent ### `Optional`expires[](#expires) expires?: Date Specifies the `Date` object to be the value for the [`Expires` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.1) . When no expiration is set clients consider this a "non-persistent cookie" and delete it the current session is over. The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is possible not all clients by obey this, so if both are set, they should point to the same date and time. ### `Optional`httpOnly[](#httpOnly) httpOnly?: boolean Enables the [`HttpOnly` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.6) . When enabled, clients will not allow client-side JavaScript to see the cookie in `document.cookie`. ### `Optional`maxAge[](#maxAge) maxAge?: number Specifies the `number` (in seconds) to be the value for the [`Max-Age` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.2) . The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states that if both `expires` and `maxAge` are set, then `maxAge` takes precedence, but it is possible not all clients by obey this, so if both are set, they should point to the same date and time. ### `Optional`partitioned[](#partitioned) partitioned?: boolean Enables the [`Partitioned` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-cutler-httpbis-partitioned-cookies/) . When enabled, clients will only send the cookie back when the current domain _and_ top-level domain matches. This is an attribute that has not yet been fully standardized, and may change in the future. This also means clients may ignore this attribute until they understand it. More information about can be found in [the proposal](https://github.com/privacycg/CHIPS) . ### `Optional`path[](#path) path?: string Specifies the value for the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4) . When no path is set, the path is considered the ["default path"](https://tools.ietf.org/html/rfc6265#section-5.1.4) . ### `Optional`priority[](#priority) priority?: "high" | "low" | "medium" Specifies the value for the [`Priority` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-west-cookie-priority-00#section-4.1) . * `'low'` will set the `Priority` attribute to `Low`. * `'medium'` will set the `Priority` attribute to `Medium`, the default priority when not set. * `'high'` will set the `Priority` attribute to `High`. More information about priority levels can be found in [the specification](https://tools.ietf.org/html/draft-west-cookie-priority-00#section-4.1) . ### `Optional`sameSite[](#sameSite) sameSite?:     | boolean     | "none"     | "strict"     | "lax" Specifies the value for the [`SameSite` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-09#section-5.4.7) . * `true` will set the `SameSite` attribute to `Strict` for strict same site enforcement. * `'lax'` will set the `SameSite` attribute to `Lax` for lax same site enforcement. * `'none'` will set the `SameSite` attribute to `None` for an explicit cross-site cookie. * `'strict'` will set the `SameSite` attribute to `Strict` for strict same site enforcement. More information about enforcement levels can be found in [the specification](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-09#section-5.4.7) . ### `Optional`secure[](#secure) secure?: boolean Enables the [`Secure` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.5) . When enabled, clients will only send the cookie back if the browser has a HTTPS connection. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [domain](#domain) [encode](#encode) [expires](#expires) [httpOnly](#httpOnly) [maxAge](#maxAge) [partitioned](#partitioned) [path](#path) [priority](#priority) [sameSite](#sameSite) [secure](#secure) --- # Cookie | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [Cookie](react_router.Cookie.html) Interface Cookie ================ A HTTP cookie. A Cookie is a logical container for metadata about a HTTP cookie; its name and options. But it doesn't contain a value. Instead, it has `parse()` and `serialize()` methods that allow a single instance to be reused for parsing/encoding multiple different values. #### See[](#See) [https://remix.run/utils/cookies#cookie-api](https://remix.run/utils/cookies#cookie-api) interface Cookie {     [expires](react_router.Cookie.html#expires) ?: Date;     [isSigned](react_router.Cookie.html#isSigned) : boolean;     [name](react_router.Cookie.html#name) : string;     [parse](react_router.Cookie.html#parse.parse-1) (cookieHeader: null | string, options?: [CookieParseOptions](react_router.CookieParseOptions.html) ): Promise;     [serialize](react_router.Cookie.html#serialize.serialize-1) (value: any, options?: [CookieSerializeOptions](react_router.CookieSerializeOptions.html) ): Promise; } ##### Index ### Properties [expires?](react_router.Cookie.html#expires) [isSigned](react_router.Cookie.html#isSigned) [name](react_router.Cookie.html#name) ### Methods [parse](react_router.Cookie.html#parse) [serialize](react_router.Cookie.html#serialize) Properties ---------- ### `Optional` `Readonly`expires[](#expires) expires?: Date The Date this cookie expires. Note: This is calculated at access time using `maxAge` when no `expires` option is provided to `createCookie()`. ### `Readonly`isSigned[](#isSigned) isSigned: boolean True if this cookie uses one or more secrets for verification. ### `Readonly`name[](#name) name: string The name of the cookie, used in the `Cookie` and `Set-Cookie` headers. Methods ------- ### parse[](#parse) * parse(cookieHeader, options?): Promise[](#parse.parse-1) * Parses a raw `Cookie` header and returns the value of this cookie or `null` if it's not present. #### Parameters * cookieHeader: null | string * `Optional`options: [CookieParseOptions](react_router.CookieParseOptions.html) #### Returns Promise ### serialize[](#serialize) * serialize(value, options?): Promise[](#serialize.serialize-1) * Serializes the given value to a string and returns the `Set-Cookie` header. #### Parameters * value: any * `Optional`options: [CookieSerializeOptions](react_router.CookieSerializeOptions.html) #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [expires](#expires) [isSigned](#isSigned) [name](#name) Methods [parse](#parse) [serialize](#serialize) --- # CookieSignatureOptions | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [CookieSignatureOptions](react_router.CookieSignatureOptions.html) Interface CookieSignatureOptions ================================ interface CookieSignatureOptions {     [secrets](react_router.CookieSignatureOptions.html#secrets) ?: string\[\]; } ##### Index ### Properties [secrets?](react_router.CookieSignatureOptions.html#secrets) Properties ---------- ### `Optional`secrets[](#secrets) secrets?: string\[\] An array of secrets that may be used to sign/unsign the value of a cookie. The array makes it easy to rotate secrets. New secrets should be added to the beginning of the array. `cookie.serialize()` will always use the first value in the array, but `cookie.parse()` may use any of them so that cookies that were signed with older secrets still work. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [secrets](#secrets) --- # DataRouter | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [DataRouter](react_router.DataRouter.html) Interface DataRouter ==================== A Router instance manages all navigation and data loading/mutations ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CookieParseOptions | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [CookieParseOptions](react_router.CookieParseOptions.html) Interface CookieParseOptions ============================ Parse options. interface CookieParseOptions {     [decode](react_router.CookieParseOptions.html#decode) ?: ((str: string) => undefined | string); } ##### Index ### Properties [decode?](react_router.CookieParseOptions.html#decode) Properties ---------- ### `Optional`decode[](#decode) decode?: ((str: string) => undefined | string) Specifies a function that will be used to decode a [cookie-value](https://datatracker.ietf.org/doc/html/rfc6265#section-4.1.1) . Since the value of a cookie has a limited character set (and must be a simple string), this function can be used to decode a previously-encoded cookie value into a JavaScript string. The default function is the global `decodeURIComponent`, wrapped in a `try..catch`. If an error is thrown it will return the cookie's original value. If you provide your own encode/decode scheme you must ensure errors are appropriately handled. #### Default[](#Default) decode ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [decode](#decode) --- # DataRouteMatch | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [DataRouteMatch](react_router.DataRouteMatch.html) Interface DataRouteMatch ======================== interface DataRouteMatch {     [params](react_router.DataRouteMatch.html#params) : [Params](../types/react_router.Params.html) ;     [pathname](react_router.DataRouteMatch.html#pathname) : string;     [pathnameBase](react_router.DataRouteMatch.html#pathnameBase) : string;     [route](react_router.DataRouteMatch.html#route) : [DataRouteObject](../types/react_router.DataRouteObject.html) ; } #### Hierarchy ([view full](../hierarchy.html#react-router.DataRouteMatch) ) * [RouteMatch](react_router.RouteMatch.html) * DataRouteMatch ##### Index ### Properties [params](react_router.DataRouteMatch.html#params) [pathname](react_router.DataRouteMatch.html#pathname) [pathnameBase](react_router.DataRouteMatch.html#pathnameBase) [route](react_router.DataRouteMatch.html#route) Properties ---------- ### params[](#params) params: [Params](../types/react_router.Params.html) The names and values of dynamic parameters in the URL. ### pathname[](#pathname) pathname: string The portion of the URL pathname that was matched. ### pathnameBase[](#pathnameBase) pathnameBase: string The portion of the URL pathname that was matched before child routes. ### route[](#route) route: [DataRouteObject](../types/react_router.DataRouteObject.html) The route object that was used to match. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [params](#params) [pathname](#pathname) [pathnameBase](#pathnameBase) [route](#route) --- # DataStrategyFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [DataStrategyFunction](react_router.DataStrategyFunction.html) Interface DataStrategyFunction ============================== * DataStrategyFunction(args): Promise\>[](#DataStrategyFunction) * #### Parameters * args: [DataStrategyFunctionArgs](react_router.DataStrategyFunctionArgs.html) #### Returns Promise\> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # DataStrategyFunctionArgs | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [DataStrategyFunctionArgs](react_router.DataStrategyFunctionArgs.html) Interface DataStrategyFunctionArgs =========================================== interface DataStrategyFunctionArgs<[Context](react_router.DataStrategyFunctionArgs.html#Context) \> {     [context](react_router.DataStrategyFunctionArgs.html#context-1) ?: [Context](react_router.DataStrategyFunctionArgs.html#Context) ;     [fetcherKey](react_router.DataStrategyFunctionArgs.html#fetcherKey) : null | string;     [matches](react_router.DataStrategyFunctionArgs.html#matches) : [DataStrategyMatch](react_router.DataStrategyMatch.html) \[\];     [params](react_router.DataStrategyFunctionArgs.html#params) : [Params](../types/react_router.Params.html) ;     [request](react_router.DataStrategyFunctionArgs.html#request) : Request; } #### Type Parameters * Context = any #### Hierarchy * DataFunctionArgs<[Context](react_router.DataStrategyFunctionArgs.html#Context) \> * DataStrategyFunctionArgs ##### Index ### Properties [context?](react_router.DataStrategyFunctionArgs.html#context-1) [fetcherKey](react_router.DataStrategyFunctionArgs.html#fetcherKey) [matches](react_router.DataStrategyFunctionArgs.html#matches) [params](react_router.DataStrategyFunctionArgs.html#params) [request](react_router.DataStrategyFunctionArgs.html#request) Properties ---------- ### `Optional`context[](#context-1) context?: [Context](react_router.DataStrategyFunctionArgs.html#Context) ### fetcherKey[](#fetcherKey) fetcherKey: null | string ### matches[](#matches) matches: [DataStrategyMatch](react_router.DataStrategyMatch.html) \[\] ### params[](#params) params: [Params](../types/react_router.Params.html) ### request[](#request) request: Request ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [context](#context-1) [fetcherKey](#fetcherKey) [matches](#matches) [params](#params) [request](#request) --- # DataStrategyMatch | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [DataStrategyMatch](react_router.DataStrategyMatch.html) Interface DataStrategyMatch =========================== interface DataStrategyMatch {     [params](react_router.DataStrategyMatch.html#params) : [Params](../types/react_router.Params.html) ;     [pathname](react_router.DataStrategyMatch.html#pathname) : string;     [pathnameBase](react_router.DataStrategyMatch.html#pathnameBase) : string;     [resolve](react_router.DataStrategyMatch.html#resolve) : ((handlerOverride?: ((handler: ((ctx?: unknown) => DataFunctionReturnValue)) => DataFunctionReturnValue)) => Promise<[DataStrategyResult](react_router.DataStrategyResult.html) \>);     [route](react_router.DataStrategyMatch.html#route) : AgnosticDataRouteObject;     [shouldLoad](react_router.DataStrategyMatch.html#shouldLoad) : boolean; } #### Hierarchy * AgnosticRouteMatch * DataStrategyMatch ##### Index ### Properties [params](react_router.DataStrategyMatch.html#params) [pathname](react_router.DataStrategyMatch.html#pathname) [pathnameBase](react_router.DataStrategyMatch.html#pathnameBase) [resolve](react_router.DataStrategyMatch.html#resolve) [route](react_router.DataStrategyMatch.html#route) [shouldLoad](react_router.DataStrategyMatch.html#shouldLoad) Properties ---------- ### params[](#params) params: [Params](../types/react_router.Params.html) The names and values of dynamic parameters in the URL. ### pathname[](#pathname) pathname: string The portion of the URL pathname that was matched. ### pathnameBase[](#pathnameBase) pathnameBase: string The portion of the URL pathname that was matched before child routes. ### resolve[](#resolve) resolve: ((handlerOverride?: ((handler: ((ctx?: unknown) => DataFunctionReturnValue)) => DataFunctionReturnValue)) => Promise<[DataStrategyResult](react_router.DataStrategyResult.html) \>) ### route[](#route) route: AgnosticDataRouteObject The route object that was used to match. ### shouldLoad[](#shouldLoad) shouldLoad: boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [params](#params) [pathname](#pathname) [pathnameBase](#pathnameBase) [resolve](#resolve) [route](#route) [shouldLoad](#shouldLoad) --- # DataStrategyResult | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [DataStrategyResult](react_router.DataStrategyResult.html) Interface DataStrategyResult ============================ Result from a loader or action called via dataStrategy interface DataStrategyResult {     [result](react_router.DataStrategyResult.html#result) : unknown;     [type](react_router.DataStrategyResult.html#type) : "data" | "error"; } ##### Index ### Properties [result](react_router.DataStrategyResult.html#result) [type](react_router.DataStrategyResult.html#type) Properties ---------- ### result[](#result) result: unknown ### type[](#type) type: "data" | "error" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [result](#result) [type](#type) --- # FetcherSubmitOptions | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [FetcherSubmitOptions](react_router.FetcherSubmitOptions.html) Interface FetcherSubmitOptions ============================== Submit options available to fetchers interface FetcherSubmitOptions {     [action](react_router.FetcherSubmitOptions.html#action) ?: string;     [encType](react_router.FetcherSubmitOptions.html#encType) ?: [FormEncType](../types/react_router.FormEncType.html) ;     [flushSync](react_router.FetcherSubmitOptions.html#flushSync) ?: boolean;     [method](react_router.FetcherSubmitOptions.html#method) ?: [HTMLFormMethod](../types/react_router.HTMLFormMethod.html) ;     [preventScrollReset](react_router.FetcherSubmitOptions.html#preventScrollReset) ?: boolean;     [relative](react_router.FetcherSubmitOptions.html#relative) ?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) ; } #### Hierarchy ([view full](../hierarchy.html#react-router.FetcherSubmitOptions) ) * SharedSubmitOptions * FetcherSubmitOptions * [SubmitOptions](react_router.SubmitOptions.html) ##### Index ### Properties [action?](react_router.FetcherSubmitOptions.html#action) [encType?](react_router.FetcherSubmitOptions.html#encType) [flushSync?](react_router.FetcherSubmitOptions.html#flushSync) [method?](react_router.FetcherSubmitOptions.html#method) [preventScrollReset?](react_router.FetcherSubmitOptions.html#preventScrollReset) [relative?](react_router.FetcherSubmitOptions.html#relative) Properties ---------- ### `Optional`action[](#action) action?: string The action URL path used to submit the form. Overrides `
`. Defaults to the path of the current route. ### `Optional`encType[](#encType) encType?: [FormEncType](../types/react_router.FormEncType.html) The encoding used to submit the form. Overrides ``. Defaults to "application/x-www-form-urlencoded". ### `Optional`flushSync[](#flushSync) flushSync?: boolean Enable flushSync for this submission's state updates ### `Optional`method[](#method) method?: [HTMLFormMethod](../types/react_router.HTMLFormMethod.html) The HTTP method used to submit the form. Overrides ``. Defaults to "GET". ### `Optional`preventScrollReset[](#preventScrollReset) preventScrollReset?: boolean In browser-based environments, prevent resetting scroll after this navigation when using the component ### `Optional`relative[](#relative) relative?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) Determines whether the form action is relative to the route hierarchy or the pathname. Use this if you want to opt out of navigating the route hierarchy and want to instead route based on /-delimited URL segments ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [action](#action) [encType](#encType) [flushSync](#flushSync) [method](#method) [preventScrollReset](#preventScrollReset) [relative](#relative) --- # EntryContext | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [EntryContext](react_router.EntryContext.html) Interface EntryContext ====================== interface EntryContext {     [abortDelay](react_router.EntryContext.html#abortDelay) ?: number;     [criticalCss](react_router.EntryContext.html#criticalCss) ?: string;     [future](react_router.EntryContext.html#future) : FutureConfig;     [isSpaMode](react_router.EntryContext.html#isSpaMode) : boolean;     [manifest](react_router.EntryContext.html#manifest) : [UNSAFE\_AssetsManifest](react_router.UNSAFE_AssetsManifest.html) ;     [renderMeta](react_router.EntryContext.html#renderMeta) ?: {         didRenderScripts?: boolean;         streamCache?: Record & {             error?: unknown;             result?: {                 done: boolean;                 value: string;             };         }\>;     };     [routeModules](react_router.EntryContext.html#routeModules) : [UNSAFE\_RouteModules](react_router.UNSAFE_RouteModules.html) ;     [serverHandoffStream](react_router.EntryContext.html#serverHandoffStream) ?: ReadableStream;     [serverHandoffString](react_router.EntryContext.html#serverHandoffString) ?: string;     [staticHandlerContext](react_router.EntryContext.html#staticHandlerContext) : [StaticHandlerContext](react_router.StaticHandlerContext.html) ;     [serializeError](react_router.EntryContext.html#serializeError.serializeError-1) ?(error: Error): SerializedError; } #### Hierarchy * FrameworkContextObject * EntryContext ##### Index ### Properties [abortDelay?](react_router.EntryContext.html#abortDelay) [criticalCss?](react_router.EntryContext.html#criticalCss) [future](react_router.EntryContext.html#future) [isSpaMode](react_router.EntryContext.html#isSpaMode) [manifest](react_router.EntryContext.html#manifest) [renderMeta?](react_router.EntryContext.html#renderMeta) [routeModules](react_router.EntryContext.html#routeModules) [serverHandoffStream?](react_router.EntryContext.html#serverHandoffStream) [serverHandoffString?](react_router.EntryContext.html#serverHandoffString) [staticHandlerContext](react_router.EntryContext.html#staticHandlerContext) ### Methods [serializeError?](react_router.EntryContext.html#serializeError) Properties ---------- ### `Optional`abortDelay[](#abortDelay) abortDelay?: number ### `Optional`criticalCss[](#criticalCss) criticalCss?: string ### future[](#future) future: FutureConfig ### isSpaMode[](#isSpaMode) isSpaMode: boolean ### manifest[](#manifest) manifest: [UNSAFE\_AssetsManifest](react_router.UNSAFE_AssetsManifest.html) ### `Optional`renderMeta[](#renderMeta) renderMeta?: {     didRenderScripts?: boolean;     streamCache?: Record & {         error?: unknown;         result?: {             done: boolean;             value: string;         };     }\>; } ### routeModules[](#routeModules) routeModules: [UNSAFE\_RouteModules](react_router.UNSAFE_RouteModules.html) ### `Optional`serverHandoffStream[](#serverHandoffStream) serverHandoffStream?: ReadableStream ### `Optional`serverHandoffString[](#serverHandoffString) serverHandoffString?: string ### staticHandlerContext[](#staticHandlerContext) staticHandlerContext: [StaticHandlerContext](react_router.StaticHandlerContext.html) Methods ------- ### `Optional`serializeError[](#serializeError) * serializeError(error): SerializedError[](#serializeError.serializeError-1) * #### Parameters * error: Error #### Returns SerializedError ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [abortDelay](#abortDelay) [criticalCss](#criticalCss) [future](#future) [isSpaMode](#isSpaMode) [manifest](#manifest) [renderMeta](#renderMeta) [routeModules](#routeModules) [serverHandoffStream](#serverHandoffStream) [serverHandoffString](#serverHandoffString) [staticHandlerContext](#staticHandlerContext) Methods [serializeError](#serializeError) --- # FetcherSubmitFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [FetcherSubmitFunction](react_router.FetcherSubmitFunction.html) Interface FetcherSubmitFunction =============================== Submits a fetcher `` to the server without reloading the page. * FetcherSubmitFunction(target, options?): Promise[](#FetcherSubmitFunction) * #### Parameters * target: [SubmitTarget](../types/react_router.SubmitTarget.html) Can be multiple types of elements and objects **`HTMLFormElement`** { fetcher.submit(event.currentTarget); }}/> **`FormData`** const formData = new FormData();formData.append("myKey", "myValue");fetcher.submit(formData, { method: "post" }); **Plain object that will be serialized as `FormData`** fetcher.submit({ myKey: "myValue" }, { method: "post" }); **Plain object that will be serialized as JSON** fetcher.submit( { myKey: "myValue" }, { method: "post", encType: "application/json" }); * `Optional`options: [FetcherSubmitOptions](react_router.FetcherSubmitOptions.html) #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # GetScrollPositionFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [GetScrollPositionFunction](react_router.GetScrollPositionFunction.html) Interface GetScrollPositionFunction =================================== Function signature for determining the current scroll position * GetScrollPositionFunction(): number[](#GetScrollPositionFunction) * #### Returns number ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HandleDocumentRequestFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [HandleDocumentRequestFunction](react_router.HandleDocumentRequestFunction.html) Interface HandleDocumentRequestFunction ======================================= * HandleDocumentRequestFunction(request, responseStatusCode, responseHeaders, context, loadContext): Response | Promise[](#HandleDocumentRequestFunction) * #### Parameters * request: Request * responseStatusCode: number * responseHeaders: Headers * context: [EntryContext](react_router.EntryContext.html) * loadContext: [AppLoadContext](react_router.AppLoadContext.html) #### Returns Response | Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # GetScrollRestorationKeyFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [GetScrollRestorationKeyFunction](react_router.GetScrollRestorationKeyFunction.html) Interface GetScrollRestorationKeyFunction ========================================= Function signature for determining the key to be used in scroll restoration for a given location * GetScrollRestorationKeyFunction(location, matches): null | string[](#GetScrollRestorationKeyFunction) * #### Parameters * location: [Location](react_router.Location.html) * matches: [UIMatch](react_router.UIMatch.html) \[\] #### Returns null | string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HandleDataRequestFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [HandleDataRequestFunction](react_router.HandleDataRequestFunction.html) Interface HandleDataRequestFunction =================================== * HandleDataRequestFunction(response, args): Response | Promise[](#HandleDataRequestFunction) * #### Parameters * response: Response * args: [LoaderFunctionArgs](react_router.LoaderFunctionArgs.html) | [ActionFunctionArgs](react_router.ActionFunctionArgs.html) #### Returns Response | Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HandleErrorFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [HandleErrorFunction](react_router.HandleErrorFunction.html) Interface HandleErrorFunction ============================= * HandleErrorFunction(error, args): void[](#HandleErrorFunction) * #### Parameters * error: unknown * args: [LoaderFunctionArgs](react_router.LoaderFunctionArgs.html) | [ActionFunctionArgs](react_router.ActionFunctionArgs.html) #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # FetcherFormProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [FetcherFormProps](react_router.FetcherFormProps.html) Interface FetcherFormProps ========================== Form props available to fetchers interface FetcherFormProps {     [about](react_router.FetcherFormProps.html#about) ?: string;     [acceptCharset](react_router.FetcherFormProps.html#acceptCharset) ?: string;     [accessKey](react_router.FetcherFormProps.html#accessKey) ?: string;     [action](react_router.FetcherFormProps.html#action) ?: string;     [aria-activedescendant](react_router.FetcherFormProps.html#aria_activedescendant) ?: string;     [aria-atomic](react_router.FetcherFormProps.html#aria_atomic) ?: Booleanish;     [aria-autocomplete](react_router.FetcherFormProps.html#aria_autocomplete) ?:         | "none"         | "list"         | "inline"         | "both";     [aria-braillelabel](react_router.FetcherFormProps.html#aria_braillelabel) ?: string;     [aria-brailleroledescription](react_router.FetcherFormProps.html#aria_brailleroledescription) ?: string;     [aria-busy](react_router.FetcherFormProps.html#aria_busy) ?: Booleanish;     [aria-checked](react_router.FetcherFormProps.html#aria_checked) ?:         | boolean         | "true"         | "false"         | "mixed";     [aria-colcount](react_router.FetcherFormProps.html#aria_colcount) ?: number;     [aria-colindex](react_router.FetcherFormProps.html#aria_colindex) ?: number;     [aria-colindextext](react_router.FetcherFormProps.html#aria_colindextext) ?: string;     [aria-colspan](react_router.FetcherFormProps.html#aria_colspan) ?: number;     [aria-controls](react_router.FetcherFormProps.html#aria_controls) ?: string;     [aria-current](react_router.FetcherFormProps.html#aria_current) ?:         | boolean         | "time"         | "true"         | "location"         | "page"         | "step"         | "false"         | "date";     [aria-describedby](react_router.FetcherFormProps.html#aria_describedby) ?: string;     [aria-description](react_router.FetcherFormProps.html#aria_description) ?: string;     [aria-details](react_router.FetcherFormProps.html#aria_details) ?: string;     [aria-disabled](react_router.FetcherFormProps.html#aria_disabled) ?: Booleanish;     [aria-dropeffect](react_router.FetcherFormProps.html#aria_dropeffect) ?:         | "link"         | "copy"         | "none"         | "execute"         | "move"         | "popup";     [aria-errormessage](react_router.FetcherFormProps.html#aria_errormessage) ?: string;     [aria-expanded](react_router.FetcherFormProps.html#aria_expanded) ?: Booleanish;     [aria-flowto](react_router.FetcherFormProps.html#aria_flowto) ?: string;     [aria-grabbed](react_router.FetcherFormProps.html#aria_grabbed) ?: Booleanish;     [aria-haspopup](react_router.FetcherFormProps.html#aria_haspopup) ?:         | boolean         | "dialog"         | "menu"         | "true"         | "false"         | "grid"         | "listbox"         | "tree";     [aria-hidden](react_router.FetcherFormProps.html#aria_hidden) ?: Booleanish;     [aria-invalid](react_router.FetcherFormProps.html#aria_invalid) ?:         | boolean         | "true"         | "false"         | "grammar"         | "spelling";     [aria-keyshortcuts](react_router.FetcherFormProps.html#aria_keyshortcuts) ?: string;     [aria-label](react_router.FetcherFormProps.html#aria_label) ?: string;     [aria-labelledby](react_router.FetcherFormProps.html#aria_labelledby) ?: string;     [aria-level](react_router.FetcherFormProps.html#aria_level) ?: number;     [aria-live](react_router.FetcherFormProps.html#aria_live) ?: "off" | "assertive" | "polite";     [aria-modal](react_router.FetcherFormProps.html#aria_modal) ?: Booleanish;     [aria-multiline](react_router.FetcherFormProps.html#aria_multiline) ?: Booleanish;     [aria-multiselectable](react_router.FetcherFormProps.html#aria_multiselectable) ?: Booleanish;     [aria-orientation](react_router.FetcherFormProps.html#aria_orientation) ?: "horizontal" | "vertical";     [aria-owns](react_router.FetcherFormProps.html#aria_owns) ?: string;     [aria-placeholder](react_router.FetcherFormProps.html#aria_placeholder) ?: string;     [aria-posinset](react_router.FetcherFormProps.html#aria_posinset) ?: number;     [aria-pressed](react_router.FetcherFormProps.html#aria_pressed) ?:         | boolean         | "true"         | "false"         | "mixed";     [aria-readonly](react_router.FetcherFormProps.html#aria_readonly) ?: Booleanish;     [aria-relevant](react_router.FetcherFormProps.html#aria_relevant) ?:         | "text"         | "additions"         | "additions removals"         | "additions text"         | "all"         | "removals"         | "removals additions"         | "removals text"         | "text additions"         | "text removals";     [aria-required](react_router.FetcherFormProps.html#aria_required) ?: Booleanish;     [aria-roledescription](react_router.FetcherFormProps.html#aria_roledescription) ?: string;     [aria-rowcount](react_router.FetcherFormProps.html#aria_rowcount) ?: number;     [aria-rowindex](react_router.FetcherFormProps.html#aria_rowindex) ?: number;     [aria-rowindextext](react_router.FetcherFormProps.html#aria_rowindextext) ?: string;     [aria-rowspan](react_router.FetcherFormProps.html#aria_rowspan) ?: number;     [aria-selected](react_router.FetcherFormProps.html#aria_selected) ?: Booleanish;     [aria-setsize](react_router.FetcherFormProps.html#aria_setsize) ?: number;     [aria-sort](react_router.FetcherFormProps.html#aria_sort) ?:         | "none"         | "ascending"         | "descending"         | "other";     [aria-valuemax](react_router.FetcherFormProps.html#aria_valuemax) ?: number;     [aria-valuemin](react_router.FetcherFormProps.html#aria_valuemin) ?: number;     [aria-valuenow](react_router.FetcherFormProps.html#aria_valuenow) ?: number;     [aria-valuetext](react_router.FetcherFormProps.html#aria_valuetext) ?: string;     [autoCapitalize](react_router.FetcherFormProps.html#autoCapitalize) ?: string;     [autoComplete](react_router.FetcherFormProps.html#autoComplete) ?: string;     [autoCorrect](react_router.FetcherFormProps.html#autoCorrect) ?: string;     [autoFocus](react_router.FetcherFormProps.html#autoFocus) ?: boolean;     [autoSave](react_router.FetcherFormProps.html#autoSave) ?: string;     [children](react_router.FetcherFormProps.html#children) ?: ReactNode;     [className](react_router.FetcherFormProps.html#className) ?: string;     [color](react_router.FetcherFormProps.html#color) ?: string;     [content](react_router.FetcherFormProps.html#content) ?: string;     [contentEditable](react_router.FetcherFormProps.html#contentEditable) ?: Booleanish | "inherit";     [contextMenu](react_router.FetcherFormProps.html#contextMenu) ?: string;     [dangerouslySetInnerHTML](react_router.FetcherFormProps.html#dangerouslySetInnerHTML) ?: {         \_\_html: string | TrustedHTML;     };     [datatype](react_router.FetcherFormProps.html#datatype) ?: string;     [defaultChecked](react_router.FetcherFormProps.html#defaultChecked) ?: boolean;     [defaultValue](react_router.FetcherFormProps.html#defaultValue) ?: string | number | readonly string\[\];     [dir](react_router.FetcherFormProps.html#dir) ?: string;     [draggable](react_router.FetcherFormProps.html#draggable) ?: Booleanish;     [encType](react_router.FetcherFormProps.html#encType) ?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain";     [hidden](react_router.FetcherFormProps.html#hidden) ?: boolean;     [id](react_router.FetcherFormProps.html#id) ?: string;     [inlist](react_router.FetcherFormProps.html#inlist) ?: any;     [inputMode](react_router.FetcherFormProps.html#inputMode) ?:         | "search"         | "text"         | "url"         | "none"         | "tel"         | "email"         | "numeric"         | "decimal";     [is](react_router.FetcherFormProps.html#is) ?: string;     [itemID](react_router.FetcherFormProps.html#itemID) ?: string;     [itemProp](react_router.FetcherFormProps.html#itemProp) ?: string;     [itemRef](react_router.FetcherFormProps.html#itemRef) ?: string;     [itemScope](react_router.FetcherFormProps.html#itemScope) ?: boolean;     [itemType](react_router.FetcherFormProps.html#itemType) ?: string;     [lang](react_router.FetcherFormProps.html#lang) ?: string;     [method](react_router.FetcherFormProps.html#method) ?: [HTMLFormMethod](../types/react_router.HTMLFormMethod.html) ;     [name](react_router.FetcherFormProps.html#name) ?: string;     [nonce](react_router.FetcherFormProps.html#nonce) ?: string;     [noValidate](react_router.FetcherFormProps.html#noValidate) ?: boolean;     [onAbort](react_router.FetcherFormProps.html#onAbort) ?: ReactEventHandler;     [onAbortCapture](react_router.FetcherFormProps.html#onAbortCapture) ?: ReactEventHandler;     [onAnimationEnd](react_router.FetcherFormProps.html#onAnimationEnd) ?: AnimationEventHandler;     [onAnimationEndCapture](react_router.FetcherFormProps.html#onAnimationEndCapture) ?: AnimationEventHandler;     [onAnimationIteration](react_router.FetcherFormProps.html#onAnimationIteration) ?: AnimationEventHandler;     [onAnimationIterationCapture](react_router.FetcherFormProps.html#onAnimationIterationCapture) ?: AnimationEventHandler;     [onAnimationStart](react_router.FetcherFormProps.html#onAnimationStart) ?: AnimationEventHandler;     [onAnimationStartCapture](react_router.FetcherFormProps.html#onAnimationStartCapture) ?: AnimationEventHandler;     [onAuxClick](react_router.FetcherFormProps.html#onAuxClick) ?: MouseEventHandler;     [onAuxClickCapture](react_router.FetcherFormProps.html#onAuxClickCapture) ?: MouseEventHandler;     [onBeforeInput](react_router.FetcherFormProps.html#onBeforeInput) ?: FormEventHandler;     [onBeforeInputCapture](react_router.FetcherFormProps.html#onBeforeInputCapture) ?: FormEventHandler;     [onBlur](react_router.FetcherFormProps.html#onBlur) ?: FocusEventHandler;     [onBlurCapture](react_router.FetcherFormProps.html#onBlurCapture) ?: FocusEventHandler;     [onCanPlay](react_router.FetcherFormProps.html#onCanPlay) ?: ReactEventHandler;     [onCanPlayCapture](react_router.FetcherFormProps.html#onCanPlayCapture) ?: ReactEventHandler;     [onCanPlayThrough](react_router.FetcherFormProps.html#onCanPlayThrough) ?: ReactEventHandler;     [onCanPlayThroughCapture](react_router.FetcherFormProps.html#onCanPlayThroughCapture) ?: ReactEventHandler;     [onChange](react_router.FetcherFormProps.html#onChange) ?: FormEventHandler;     [onChangeCapture](react_router.FetcherFormProps.html#onChangeCapture) ?: FormEventHandler;     [onClick](react_router.FetcherFormProps.html#onClick) ?: MouseEventHandler;     [onClickCapture](react_router.FetcherFormProps.html#onClickCapture) ?: MouseEventHandler;     [onCompositionEnd](react_router.FetcherFormProps.html#onCompositionEnd) ?: CompositionEventHandler;     [onCompositionEndCapture](react_router.FetcherFormProps.html#onCompositionEndCapture) ?: CompositionEventHandler;     [onCompositionStart](react_router.FetcherFormProps.html#onCompositionStart) ?: CompositionEventHandler;     [onCompositionStartCapture](react_router.FetcherFormProps.html#onCompositionStartCapture) ?: CompositionEventHandler;     [onCompositionUpdate](react_router.FetcherFormProps.html#onCompositionUpdate) ?: CompositionEventHandler;     [onCompositionUpdateCapture](react_router.FetcherFormProps.html#onCompositionUpdateCapture) ?: CompositionEventHandler;     [onContextMenu](react_router.FetcherFormProps.html#onContextMenu) ?: MouseEventHandler;     [onContextMenuCapture](react_router.FetcherFormProps.html#onContextMenuCapture) ?: MouseEventHandler;     [onCopy](react_router.FetcherFormProps.html#onCopy) ?: ClipboardEventHandler;     [onCopyCapture](react_router.FetcherFormProps.html#onCopyCapture) ?: ClipboardEventHandler;     [onCut](react_router.FetcherFormProps.html#onCut) ?: ClipboardEventHandler;     [onCutCapture](react_router.FetcherFormProps.html#onCutCapture) ?: ClipboardEventHandler;     [onDoubleClick](react_router.FetcherFormProps.html#onDoubleClick) ?: MouseEventHandler;     [onDoubleClickCapture](react_router.FetcherFormProps.html#onDoubleClickCapture) ?: MouseEventHandler;     [onDrag](react_router.FetcherFormProps.html#onDrag) ?: DragEventHandler;     [onDragCapture](react_router.FetcherFormProps.html#onDragCapture) ?: DragEventHandler;     [onDragEnd](react_router.FetcherFormProps.html#onDragEnd) ?: DragEventHandler;     [onDragEndCapture](react_router.FetcherFormProps.html#onDragEndCapture) ?: DragEventHandler;     [onDragEnter](react_router.FetcherFormProps.html#onDragEnter) ?: DragEventHandler;     [onDragEnterCapture](react_router.FetcherFormProps.html#onDragEnterCapture) ?: DragEventHandler;     [onDragExit](react_router.FetcherFormProps.html#onDragExit) ?: DragEventHandler;     [onDragExitCapture](react_router.FetcherFormProps.html#onDragExitCapture) ?: DragEventHandler;     [onDragLeave](react_router.FetcherFormProps.html#onDragLeave) ?: DragEventHandler;     [onDragLeaveCapture](react_router.FetcherFormProps.html#onDragLeaveCapture) ?: DragEventHandler;     [onDragOver](react_router.FetcherFormProps.html#onDragOver) ?: DragEventHandler;     [onDragOverCapture](react_router.FetcherFormProps.html#onDragOverCapture) ?: DragEventHandler;     [onDragStart](react_router.FetcherFormProps.html#onDragStart) ?: DragEventHandler;     [onDragStartCapture](react_router.FetcherFormProps.html#onDragStartCapture) ?: DragEventHandler;     [onDrop](react_router.FetcherFormProps.html#onDrop) ?: DragEventHandler;     [onDropCapture](react_router.FetcherFormProps.html#onDropCapture) ?: DragEventHandler;     [onDurationChange](react_router.FetcherFormProps.html#onDurationChange) ?: ReactEventHandler;     [onDurationChangeCapture](react_router.FetcherFormProps.html#onDurationChangeCapture) ?: ReactEventHandler;     [onEmptied](react_router.FetcherFormProps.html#onEmptied) ?: ReactEventHandler;     [onEmptiedCapture](react_router.FetcherFormProps.html#onEmptiedCapture) ?: ReactEventHandler;     [onEncrypted](react_router.FetcherFormProps.html#onEncrypted) ?: ReactEventHandler;     [onEncryptedCapture](react_router.FetcherFormProps.html#onEncryptedCapture) ?: ReactEventHandler;     [onEnded](react_router.FetcherFormProps.html#onEnded) ?: ReactEventHandler;     [onEndedCapture](react_router.FetcherFormProps.html#onEndedCapture) ?: ReactEventHandler;     [onError](react_router.FetcherFormProps.html#onError) ?: ReactEventHandler;     [onErrorCapture](react_router.FetcherFormProps.html#onErrorCapture) ?: ReactEventHandler;     [onFocus](react_router.FetcherFormProps.html#onFocus) ?: FocusEventHandler;     [onFocusCapture](react_router.FetcherFormProps.html#onFocusCapture) ?: FocusEventHandler;     [onGotPointerCapture](react_router.FetcherFormProps.html#onGotPointerCapture) ?: PointerEventHandler;     [onGotPointerCaptureCapture](react_router.FetcherFormProps.html#onGotPointerCaptureCapture) ?: PointerEventHandler;     [onInput](react_router.FetcherFormProps.html#onInput) ?: FormEventHandler;     [onInputCapture](react_router.FetcherFormProps.html#onInputCapture) ?: FormEventHandler;     [onInvalid](react_router.FetcherFormProps.html#onInvalid) ?: FormEventHandler;     [onInvalidCapture](react_router.FetcherFormProps.html#onInvalidCapture) ?: FormEventHandler;     [onKeyDown](react_router.FetcherFormProps.html#onKeyDown) ?: KeyboardEventHandler;     [onKeyDownCapture](react_router.FetcherFormProps.html#onKeyDownCapture) ?: KeyboardEventHandler;     [onKeyPress](react_router.FetcherFormProps.html#onKeyPress) ?: KeyboardEventHandler;     [onKeyPressCapture](react_router.FetcherFormProps.html#onKeyPressCapture) ?: KeyboardEventHandler;     [onKeyUp](react_router.FetcherFormProps.html#onKeyUp) ?: KeyboardEventHandler;     [onKeyUpCapture](react_router.FetcherFormProps.html#onKeyUpCapture) ?: KeyboardEventHandler;     [onLoad](react_router.FetcherFormProps.html#onLoad) ?: ReactEventHandler;     [onLoadCapture](react_router.FetcherFormProps.html#onLoadCapture) ?: ReactEventHandler;     [onLoadedData](react_router.FetcherFormProps.html#onLoadedData) ?: ReactEventHandler;     [onLoadedDataCapture](react_router.FetcherFormProps.html#onLoadedDataCapture) ?: ReactEventHandler;     [onLoadedMetadata](react_router.FetcherFormProps.html#onLoadedMetadata) ?: ReactEventHandler;     [onLoadedMetadataCapture](react_router.FetcherFormProps.html#onLoadedMetadataCapture) ?: ReactEventHandler;     [onLoadStart](react_router.FetcherFormProps.html#onLoadStart) ?: ReactEventHandler;     [onLoadStartCapture](react_router.FetcherFormProps.html#onLoadStartCapture) ?: ReactEventHandler;     [onLostPointerCapture](react_router.FetcherFormProps.html#onLostPointerCapture) ?: PointerEventHandler;     [onLostPointerCaptureCapture](react_router.FetcherFormProps.html#onLostPointerCaptureCapture) ?: PointerEventHandler;     [onMouseDown](react_router.FetcherFormProps.html#onMouseDown) ?: MouseEventHandler;     [onMouseDownCapture](react_router.FetcherFormProps.html#onMouseDownCapture) ?: MouseEventHandler;     [onMouseEnter](react_router.FetcherFormProps.html#onMouseEnter) ?: MouseEventHandler;     [onMouseLeave](react_router.FetcherFormProps.html#onMouseLeave) ?: MouseEventHandler;     [onMouseMove](react_router.FetcherFormProps.html#onMouseMove) ?: MouseEventHandler;     [onMouseMoveCapture](react_router.FetcherFormProps.html#onMouseMoveCapture) ?: MouseEventHandler;     [onMouseOut](react_router.FetcherFormProps.html#onMouseOut) ?: MouseEventHandler;     [onMouseOutCapture](react_router.FetcherFormProps.html#onMouseOutCapture) ?: MouseEventHandler;     [onMouseOver](react_router.FetcherFormProps.html#onMouseOver) ?: MouseEventHandler;     [onMouseOverCapture](react_router.FetcherFormProps.html#onMouseOverCapture) ?: MouseEventHandler;     [onMouseUp](react_router.FetcherFormProps.html#onMouseUp) ?: MouseEventHandler;     [onMouseUpCapture](react_router.FetcherFormProps.html#onMouseUpCapture) ?: MouseEventHandler;     [onPaste](react_router.FetcherFormProps.html#onPaste) ?: ClipboardEventHandler;     [onPasteCapture](react_router.FetcherFormProps.html#onPasteCapture) ?: ClipboardEventHandler;     [onPause](react_router.FetcherFormProps.html#onPause) ?: ReactEventHandler;     [onPauseCapture](react_router.FetcherFormProps.html#onPauseCapture) ?: ReactEventHandler;     [onPlay](react_router.FetcherFormProps.html#onPlay) ?: ReactEventHandler;     [onPlayCapture](react_router.FetcherFormProps.html#onPlayCapture) ?: ReactEventHandler;     [onPlaying](react_router.FetcherFormProps.html#onPlaying) ?: ReactEventHandler;     [onPlayingCapture](react_router.FetcherFormProps.html#onPlayingCapture) ?: ReactEventHandler;     [onPointerCancel](react_router.FetcherFormProps.html#onPointerCancel) ?: PointerEventHandler;     [onPointerCancelCapture](react_router.FetcherFormProps.html#onPointerCancelCapture) ?: PointerEventHandler;     [onPointerDown](react_router.FetcherFormProps.html#onPointerDown) ?: PointerEventHandler;     [onPointerDownCapture](react_router.FetcherFormProps.html#onPointerDownCapture) ?: PointerEventHandler;     [onPointerEnter](react_router.FetcherFormProps.html#onPointerEnter) ?: PointerEventHandler;     [onPointerEnterCapture](react_router.FetcherFormProps.html#onPointerEnterCapture) ?: PointerEventHandler;     [onPointerLeave](react_router.FetcherFormProps.html#onPointerLeave) ?: PointerEventHandler;     [onPointerLeaveCapture](react_router.FetcherFormProps.html#onPointerLeaveCapture) ?: PointerEventHandler;     [onPointerMove](react_router.FetcherFormProps.html#onPointerMove) ?: PointerEventHandler;     [onPointerMoveCapture](react_router.FetcherFormProps.html#onPointerMoveCapture) ?: PointerEventHandler;     [onPointerOut](react_router.FetcherFormProps.html#onPointerOut) ?: PointerEventHandler;     [onPointerOutCapture](react_router.FetcherFormProps.html#onPointerOutCapture) ?: PointerEventHandler;     [onPointerOver](react_router.FetcherFormProps.html#onPointerOver) ?: PointerEventHandler;     [onPointerOverCapture](react_router.FetcherFormProps.html#onPointerOverCapture) ?: PointerEventHandler;     [onPointerUp](react_router.FetcherFormProps.html#onPointerUp) ?: PointerEventHandler;     [onPointerUpCapture](react_router.FetcherFormProps.html#onPointerUpCapture) ?: PointerEventHandler;     [onProgress](react_router.FetcherFormProps.html#onProgress) ?: ReactEventHandler;     [onProgressCapture](react_router.FetcherFormProps.html#onProgressCapture) ?: ReactEventHandler;     [onRateChange](react_router.FetcherFormProps.html#onRateChange) ?: ReactEventHandler;     [onRateChangeCapture](react_router.FetcherFormProps.html#onRateChangeCapture) ?: ReactEventHandler;     [onReset](react_router.FetcherFormProps.html#onReset) ?: FormEventHandler;     [onResetCapture](react_router.FetcherFormProps.html#onResetCapture) ?: FormEventHandler;     [onResize](react_router.FetcherFormProps.html#onResize) ?: ReactEventHandler;     [onResizeCapture](react_router.FetcherFormProps.html#onResizeCapture) ?: ReactEventHandler;     [onScroll](react_router.FetcherFormProps.html#onScroll) ?: UIEventHandler;     [onScrollCapture](react_router.FetcherFormProps.html#onScrollCapture) ?: UIEventHandler;     [onSeeked](react_router.FetcherFormProps.html#onSeeked) ?: ReactEventHandler;     [onSeekedCapture](react_router.FetcherFormProps.html#onSeekedCapture) ?: ReactEventHandler;     [onSeeking](react_router.FetcherFormProps.html#onSeeking) ?: ReactEventHandler;     [onSeekingCapture](react_router.FetcherFormProps.html#onSeekingCapture) ?: ReactEventHandler;     [onSelect](react_router.FetcherFormProps.html#onSelect) ?: ReactEventHandler;     [onSelectCapture](react_router.FetcherFormProps.html#onSelectCapture) ?: ReactEventHandler;     [onStalled](react_router.FetcherFormProps.html#onStalled) ?: ReactEventHandler;     [onStalledCapture](react_router.FetcherFormProps.html#onStalledCapture) ?: ReactEventHandler;     [onSubmit](react_router.FetcherFormProps.html#onSubmit) ?: FormEventHandler;     [onSubmitCapture](react_router.FetcherFormProps.html#onSubmitCapture) ?: FormEventHandler;     [onSuspend](react_router.FetcherFormProps.html#onSuspend) ?: ReactEventHandler;     [onSuspendCapture](react_router.FetcherFormProps.html#onSuspendCapture) ?: ReactEventHandler;     [onTimeUpdate](react_router.FetcherFormProps.html#onTimeUpdate) ?: ReactEventHandler;     [onTimeUpdateCapture](react_router.FetcherFormProps.html#onTimeUpdateCapture) ?: ReactEventHandler;     [onTouchCancel](react_router.FetcherFormProps.html#onTouchCancel) ?: TouchEventHandler;     [onTouchCancelCapture](react_router.FetcherFormProps.html#onTouchCancelCapture) ?: TouchEventHandler;     [onTouchEnd](react_router.FetcherFormProps.html#onTouchEnd) ?: TouchEventHandler;     [onTouchEndCapture](react_router.FetcherFormProps.html#onTouchEndCapture) ?: TouchEventHandler;     [onTouchMove](react_router.FetcherFormProps.html#onTouchMove) ?: TouchEventHandler;     [onTouchMoveCapture](react_router.FetcherFormProps.html#onTouchMoveCapture) ?: TouchEventHandler;     [onTouchStart](react_router.FetcherFormProps.html#onTouchStart) ?: TouchEventHandler;     [onTouchStartCapture](react_router.FetcherFormProps.html#onTouchStartCapture) ?: TouchEventHandler;     [onTransitionEnd](react_router.FetcherFormProps.html#onTransitionEnd) ?: TransitionEventHandler;     [onTransitionEndCapture](react_router.FetcherFormProps.html#onTransitionEndCapture) ?: TransitionEventHandler;     [onVolumeChange](react_router.FetcherFormProps.html#onVolumeChange) ?: ReactEventHandler;     [onVolumeChangeCapture](react_router.FetcherFormProps.html#onVolumeChangeCapture) ?: ReactEventHandler;     [onWaiting](react_router.FetcherFormProps.html#onWaiting) ?: ReactEventHandler;     [onWaitingCapture](react_router.FetcherFormProps.html#onWaitingCapture) ?: ReactEventHandler;     [onWheel](react_router.FetcherFormProps.html#onWheel) ?: WheelEventHandler;     [onWheelCapture](react_router.FetcherFormProps.html#onWheelCapture) ?: WheelEventHandler;     [placeholder](react_router.FetcherFormProps.html#placeholder) ?: string;     [prefix](react_router.FetcherFormProps.html#prefix) ?: string;     [preventScrollReset](react_router.FetcherFormProps.html#preventScrollReset) ?: boolean;     [property](react_router.FetcherFormProps.html#property) ?: string;     [radioGroup](react_router.FetcherFormProps.html#radioGroup) ?: string;     [rel](react_router.FetcherFormProps.html#rel) ?: string;     [relative](react_router.FetcherFormProps.html#relative) ?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) ;     [resource](react_router.FetcherFormProps.html#resource) ?: string;     [results](react_router.FetcherFormProps.html#results) ?: number;     [rev](react_router.FetcherFormProps.html#rev) ?: string;     [role](react_router.FetcherFormProps.html#role) ?: AriaRole;     [security](react_router.FetcherFormProps.html#security) ?: string;     [slot](react_router.FetcherFormProps.html#slot) ?: string;     [spellCheck](react_router.FetcherFormProps.html#spellCheck) ?: Booleanish;     [style](react_router.FetcherFormProps.html#style) ?: CSSProperties;     [suppressContentEditableWarning](react_router.FetcherFormProps.html#suppressContentEditableWarning) ?: boolean;     [suppressHydrationWarning](react_router.FetcherFormProps.html#suppressHydrationWarning) ?: boolean;     [tabIndex](react_router.FetcherFormProps.html#tabIndex) ?: number;     [target](react_router.FetcherFormProps.html#target) ?: string;     [title](react_router.FetcherFormProps.html#title) ?: string;     [translate](react_router.FetcherFormProps.html#translate) ?: "yes" | "no";     [typeof](react_router.FetcherFormProps.html#typeof) ?: string;     [unselectable](react_router.FetcherFormProps.html#unselectable) ?: "on" | "off";     [vocab](react_router.FetcherFormProps.html#vocab) ?: string; } #### Hierarchy * SharedFormProps * FetcherFormProps ##### Index ### Properties [about?](react_router.FetcherFormProps.html#about) [acceptCharset?](react_router.FetcherFormProps.html#acceptCharset) [accessKey?](react_router.FetcherFormProps.html#accessKey) [action?](react_router.FetcherFormProps.html#action) [aria-activedescendant?](react_router.FetcherFormProps.html#aria_activedescendant) [aria-atomic?](react_router.FetcherFormProps.html#aria_atomic) [aria-autocomplete?](react_router.FetcherFormProps.html#aria_autocomplete) [aria-braillelabel?](react_router.FetcherFormProps.html#aria_braillelabel) [aria-brailleroledescription?](react_router.FetcherFormProps.html#aria_brailleroledescription) [aria-busy?](react_router.FetcherFormProps.html#aria_busy) [aria-checked?](react_router.FetcherFormProps.html#aria_checked) [aria-colcount?](react_router.FetcherFormProps.html#aria_colcount) [aria-colindex?](react_router.FetcherFormProps.html#aria_colindex) [aria-colindextext?](react_router.FetcherFormProps.html#aria_colindextext) [aria-colspan?](react_router.FetcherFormProps.html#aria_colspan) [aria-controls?](react_router.FetcherFormProps.html#aria_controls) [aria-current?](react_router.FetcherFormProps.html#aria_current) [aria-describedby?](react_router.FetcherFormProps.html#aria_describedby) [aria-description?](react_router.FetcherFormProps.html#aria_description) [aria-details?](react_router.FetcherFormProps.html#aria_details) [aria-disabled?](react_router.FetcherFormProps.html#aria_disabled) [aria-dropeffect?](react_router.FetcherFormProps.html#aria_dropeffect) [aria-errormessage?](react_router.FetcherFormProps.html#aria_errormessage) [aria-expanded?](react_router.FetcherFormProps.html#aria_expanded) [aria-flowto?](react_router.FetcherFormProps.html#aria_flowto) [aria-grabbed?](react_router.FetcherFormProps.html#aria_grabbed) [aria-haspopup?](react_router.FetcherFormProps.html#aria_haspopup) [aria-hidden?](react_router.FetcherFormProps.html#aria_hidden) [aria-invalid?](react_router.FetcherFormProps.html#aria_invalid) [aria-keyshortcuts?](react_router.FetcherFormProps.html#aria_keyshortcuts) [aria-label?](react_router.FetcherFormProps.html#aria_label) [aria-labelledby?](react_router.FetcherFormProps.html#aria_labelledby) [aria-level?](react_router.FetcherFormProps.html#aria_level) [aria-live?](react_router.FetcherFormProps.html#aria_live) [aria-modal?](react_router.FetcherFormProps.html#aria_modal) [aria-multiline?](react_router.FetcherFormProps.html#aria_multiline) [aria-multiselectable?](react_router.FetcherFormProps.html#aria_multiselectable) [aria-orientation?](react_router.FetcherFormProps.html#aria_orientation) [aria-owns?](react_router.FetcherFormProps.html#aria_owns) [aria-placeholder?](react_router.FetcherFormProps.html#aria_placeholder) [aria-posinset?](react_router.FetcherFormProps.html#aria_posinset) [aria-pressed?](react_router.FetcherFormProps.html#aria_pressed) [aria-readonly?](react_router.FetcherFormProps.html#aria_readonly) [aria-relevant?](react_router.FetcherFormProps.html#aria_relevant) [aria-required?](react_router.FetcherFormProps.html#aria_required) [aria-roledescription?](react_router.FetcherFormProps.html#aria_roledescription) [aria-rowcount?](react_router.FetcherFormProps.html#aria_rowcount) [aria-rowindex?](react_router.FetcherFormProps.html#aria_rowindex) [aria-rowindextext?](react_router.FetcherFormProps.html#aria_rowindextext) [aria-rowspan?](react_router.FetcherFormProps.html#aria_rowspan) [aria-selected?](react_router.FetcherFormProps.html#aria_selected) [aria-setsize?](react_router.FetcherFormProps.html#aria_setsize) [aria-sort?](react_router.FetcherFormProps.html#aria_sort) [aria-valuemax?](react_router.FetcherFormProps.html#aria_valuemax) [aria-valuemin?](react_router.FetcherFormProps.html#aria_valuemin) [aria-valuenow?](react_router.FetcherFormProps.html#aria_valuenow) [aria-valuetext?](react_router.FetcherFormProps.html#aria_valuetext) [autoCapitalize?](react_router.FetcherFormProps.html#autoCapitalize) [autoComplete?](react_router.FetcherFormProps.html#autoComplete) [autoCorrect?](react_router.FetcherFormProps.html#autoCorrect) [autoFocus?](react_router.FetcherFormProps.html#autoFocus) [autoSave?](react_router.FetcherFormProps.html#autoSave) [children?](react_router.FetcherFormProps.html#children) [className?](react_router.FetcherFormProps.html#className) [color?](react_router.FetcherFormProps.html#color) [content?](react_router.FetcherFormProps.html#content) [contentEditable?](react_router.FetcherFormProps.html#contentEditable) [contextMenu?](react_router.FetcherFormProps.html#contextMenu) [dangerouslySetInnerHTML?](react_router.FetcherFormProps.html#dangerouslySetInnerHTML) [datatype?](react_router.FetcherFormProps.html#datatype) [defaultChecked?](react_router.FetcherFormProps.html#defaultChecked) [defaultValue?](react_router.FetcherFormProps.html#defaultValue) [dir?](react_router.FetcherFormProps.html#dir) [draggable?](react_router.FetcherFormProps.html#draggable) [encType?](react_router.FetcherFormProps.html#encType) [hidden?](react_router.FetcherFormProps.html#hidden) [id?](react_router.FetcherFormProps.html#id) [inlist?](react_router.FetcherFormProps.html#inlist) [inputMode?](react_router.FetcherFormProps.html#inputMode) [is?](react_router.FetcherFormProps.html#is) [itemID?](react_router.FetcherFormProps.html#itemID) [itemProp?](react_router.FetcherFormProps.html#itemProp) [itemRef?](react_router.FetcherFormProps.html#itemRef) [itemScope?](react_router.FetcherFormProps.html#itemScope) [itemType?](react_router.FetcherFormProps.html#itemType) [lang?](react_router.FetcherFormProps.html#lang) [method?](react_router.FetcherFormProps.html#method) [name?](react_router.FetcherFormProps.html#name) [nonce?](react_router.FetcherFormProps.html#nonce) [noValidate?](react_router.FetcherFormProps.html#noValidate) [onAbort?](react_router.FetcherFormProps.html#onAbort) [onAbortCapture?](react_router.FetcherFormProps.html#onAbortCapture) [onAnimationEnd?](react_router.FetcherFormProps.html#onAnimationEnd) [onAnimationEndCapture?](react_router.FetcherFormProps.html#onAnimationEndCapture) [onAnimationIteration?](react_router.FetcherFormProps.html#onAnimationIteration) [onAnimationIterationCapture?](react_router.FetcherFormProps.html#onAnimationIterationCapture) [onAnimationStart?](react_router.FetcherFormProps.html#onAnimationStart) [onAnimationStartCapture?](react_router.FetcherFormProps.html#onAnimationStartCapture) [onAuxClick?](react_router.FetcherFormProps.html#onAuxClick) [onAuxClickCapture?](react_router.FetcherFormProps.html#onAuxClickCapture) [onBeforeInput?](react_router.FetcherFormProps.html#onBeforeInput) [onBeforeInputCapture?](react_router.FetcherFormProps.html#onBeforeInputCapture) [onBlur?](react_router.FetcherFormProps.html#onBlur) [onBlurCapture?](react_router.FetcherFormProps.html#onBlurCapture) [onCanPlay?](react_router.FetcherFormProps.html#onCanPlay) [onCanPlayCapture?](react_router.FetcherFormProps.html#onCanPlayCapture) [onCanPlayThrough?](react_router.FetcherFormProps.html#onCanPlayThrough) [onCanPlayThroughCapture?](react_router.FetcherFormProps.html#onCanPlayThroughCapture) [onChange?](react_router.FetcherFormProps.html#onChange) [onChangeCapture?](react_router.FetcherFormProps.html#onChangeCapture) [onClick?](react_router.FetcherFormProps.html#onClick) [onClickCapture?](react_router.FetcherFormProps.html#onClickCapture) [onCompositionEnd?](react_router.FetcherFormProps.html#onCompositionEnd) [onCompositionEndCapture?](react_router.FetcherFormProps.html#onCompositionEndCapture) [onCompositionStart?](react_router.FetcherFormProps.html#onCompositionStart) [onCompositionStartCapture?](react_router.FetcherFormProps.html#onCompositionStartCapture) [onCompositionUpdate?](react_router.FetcherFormProps.html#onCompositionUpdate) [onCompositionUpdateCapture?](react_router.FetcherFormProps.html#onCompositionUpdateCapture) [onContextMenu?](react_router.FetcherFormProps.html#onContextMenu) [onContextMenuCapture?](react_router.FetcherFormProps.html#onContextMenuCapture) [onCopy?](react_router.FetcherFormProps.html#onCopy) [onCopyCapture?](react_router.FetcherFormProps.html#onCopyCapture) [onCut?](react_router.FetcherFormProps.html#onCut) [onCutCapture?](react_router.FetcherFormProps.html#onCutCapture) [onDoubleClick?](react_router.FetcherFormProps.html#onDoubleClick) [onDoubleClickCapture?](react_router.FetcherFormProps.html#onDoubleClickCapture) [onDrag?](react_router.FetcherFormProps.html#onDrag) [onDragCapture?](react_router.FetcherFormProps.html#onDragCapture) [onDragEnd?](react_router.FetcherFormProps.html#onDragEnd) [onDragEndCapture?](react_router.FetcherFormProps.html#onDragEndCapture) [onDragEnter?](react_router.FetcherFormProps.html#onDragEnter) [onDragEnterCapture?](react_router.FetcherFormProps.html#onDragEnterCapture) [onDragExit?](react_router.FetcherFormProps.html#onDragExit) [onDragExitCapture?](react_router.FetcherFormProps.html#onDragExitCapture) [onDragLeave?](react_router.FetcherFormProps.html#onDragLeave) [onDragLeaveCapture?](react_router.FetcherFormProps.html#onDragLeaveCapture) [onDragOver?](react_router.FetcherFormProps.html#onDragOver) [onDragOverCapture?](react_router.FetcherFormProps.html#onDragOverCapture) [onDragStart?](react_router.FetcherFormProps.html#onDragStart) [onDragStartCapture?](react_router.FetcherFormProps.html#onDragStartCapture) [onDrop?](react_router.FetcherFormProps.html#onDrop) [onDropCapture?](react_router.FetcherFormProps.html#onDropCapture) [onDurationChange?](react_router.FetcherFormProps.html#onDurationChange) [onDurationChangeCapture?](react_router.FetcherFormProps.html#onDurationChangeCapture) [onEmptied?](react_router.FetcherFormProps.html#onEmptied) [onEmptiedCapture?](react_router.FetcherFormProps.html#onEmptiedCapture) [onEncrypted?](react_router.FetcherFormProps.html#onEncrypted) [onEncryptedCapture?](react_router.FetcherFormProps.html#onEncryptedCapture) [onEnded?](react_router.FetcherFormProps.html#onEnded) [onEndedCapture?](react_router.FetcherFormProps.html#onEndedCapture) [onError?](react_router.FetcherFormProps.html#onError) [onErrorCapture?](react_router.FetcherFormProps.html#onErrorCapture) [onFocus?](react_router.FetcherFormProps.html#onFocus) [onFocusCapture?](react_router.FetcherFormProps.html#onFocusCapture) [onGotPointerCapture?](react_router.FetcherFormProps.html#onGotPointerCapture) [onGotPointerCaptureCapture?](react_router.FetcherFormProps.html#onGotPointerCaptureCapture) [onInput?](react_router.FetcherFormProps.html#onInput) [onInputCapture?](react_router.FetcherFormProps.html#onInputCapture) [onInvalid?](react_router.FetcherFormProps.html#onInvalid) [onInvalidCapture?](react_router.FetcherFormProps.html#onInvalidCapture) [onKeyDown?](react_router.FetcherFormProps.html#onKeyDown) [onKeyDownCapture?](react_router.FetcherFormProps.html#onKeyDownCapture) [onKeyPress?](react_router.FetcherFormProps.html#onKeyPress) [onKeyPressCapture?](react_router.FetcherFormProps.html#onKeyPressCapture) [onKeyUp?](react_router.FetcherFormProps.html#onKeyUp) [onKeyUpCapture?](react_router.FetcherFormProps.html#onKeyUpCapture) [onLoad?](react_router.FetcherFormProps.html#onLoad) [onLoadCapture?](react_router.FetcherFormProps.html#onLoadCapture) [onLoadedData?](react_router.FetcherFormProps.html#onLoadedData) [onLoadedDataCapture?](react_router.FetcherFormProps.html#onLoadedDataCapture) [onLoadedMetadata?](react_router.FetcherFormProps.html#onLoadedMetadata) [onLoadedMetadataCapture?](react_router.FetcherFormProps.html#onLoadedMetadataCapture) [onLoadStart?](react_router.FetcherFormProps.html#onLoadStart) [onLoadStartCapture?](react_router.FetcherFormProps.html#onLoadStartCapture) [onLostPointerCapture?](react_router.FetcherFormProps.html#onLostPointerCapture) [onLostPointerCaptureCapture?](react_router.FetcherFormProps.html#onLostPointerCaptureCapture) [onMouseDown?](react_router.FetcherFormProps.html#onMouseDown) [onMouseDownCapture?](react_router.FetcherFormProps.html#onMouseDownCapture) [onMouseEnter?](react_router.FetcherFormProps.html#onMouseEnter) [onMouseLeave?](react_router.FetcherFormProps.html#onMouseLeave) [onMouseMove?](react_router.FetcherFormProps.html#onMouseMove) [onMouseMoveCapture?](react_router.FetcherFormProps.html#onMouseMoveCapture) [onMouseOut?](react_router.FetcherFormProps.html#onMouseOut) [onMouseOutCapture?](react_router.FetcherFormProps.html#onMouseOutCapture) [onMouseOver?](react_router.FetcherFormProps.html#onMouseOver) [onMouseOverCapture?](react_router.FetcherFormProps.html#onMouseOverCapture) [onMouseUp?](react_router.FetcherFormProps.html#onMouseUp) [onMouseUpCapture?](react_router.FetcherFormProps.html#onMouseUpCapture) [onPaste?](react_router.FetcherFormProps.html#onPaste) [onPasteCapture?](react_router.FetcherFormProps.html#onPasteCapture) [onPause?](react_router.FetcherFormProps.html#onPause) [onPauseCapture?](react_router.FetcherFormProps.html#onPauseCapture) [onPlay?](react_router.FetcherFormProps.html#onPlay) [onPlayCapture?](react_router.FetcherFormProps.html#onPlayCapture) [onPlaying?](react_router.FetcherFormProps.html#onPlaying) [onPlayingCapture?](react_router.FetcherFormProps.html#onPlayingCapture) [onPointerCancel?](react_router.FetcherFormProps.html#onPointerCancel) [onPointerCancelCapture?](react_router.FetcherFormProps.html#onPointerCancelCapture) [onPointerDown?](react_router.FetcherFormProps.html#onPointerDown) [onPointerDownCapture?](react_router.FetcherFormProps.html#onPointerDownCapture) [onPointerEnter?](react_router.FetcherFormProps.html#onPointerEnter) [onPointerEnterCapture?](react_router.FetcherFormProps.html#onPointerEnterCapture) [onPointerLeave?](react_router.FetcherFormProps.html#onPointerLeave) [onPointerLeaveCapture?](react_router.FetcherFormProps.html#onPointerLeaveCapture) [onPointerMove?](react_router.FetcherFormProps.html#onPointerMove) [onPointerMoveCapture?](react_router.FetcherFormProps.html#onPointerMoveCapture) [onPointerOut?](react_router.FetcherFormProps.html#onPointerOut) [onPointerOutCapture?](react_router.FetcherFormProps.html#onPointerOutCapture) [onPointerOver?](react_router.FetcherFormProps.html#onPointerOver) [onPointerOverCapture?](react_router.FetcherFormProps.html#onPointerOverCapture) [onPointerUp?](react_router.FetcherFormProps.html#onPointerUp) [onPointerUpCapture?](react_router.FetcherFormProps.html#onPointerUpCapture) [onProgress?](react_router.FetcherFormProps.html#onProgress) [onProgressCapture?](react_router.FetcherFormProps.html#onProgressCapture) [onRateChange?](react_router.FetcherFormProps.html#onRateChange) [onRateChangeCapture?](react_router.FetcherFormProps.html#onRateChangeCapture) [onReset?](react_router.FetcherFormProps.html#onReset) [onResetCapture?](react_router.FetcherFormProps.html#onResetCapture) [onResize?](react_router.FetcherFormProps.html#onResize) [onResizeCapture?](react_router.FetcherFormProps.html#onResizeCapture) [onScroll?](react_router.FetcherFormProps.html#onScroll) [onScrollCapture?](react_router.FetcherFormProps.html#onScrollCapture) [onSeeked?](react_router.FetcherFormProps.html#onSeeked) [onSeekedCapture?](react_router.FetcherFormProps.html#onSeekedCapture) [onSeeking?](react_router.FetcherFormProps.html#onSeeking) [onSeekingCapture?](react_router.FetcherFormProps.html#onSeekingCapture) [onSelect?](react_router.FetcherFormProps.html#onSelect) [onSelectCapture?](react_router.FetcherFormProps.html#onSelectCapture) [onStalled?](react_router.FetcherFormProps.html#onStalled) [onStalledCapture?](react_router.FetcherFormProps.html#onStalledCapture) [onSubmit?](react_router.FetcherFormProps.html#onSubmit) [onSubmitCapture?](react_router.FetcherFormProps.html#onSubmitCapture) [onSuspend?](react_router.FetcherFormProps.html#onSuspend) [onSuspendCapture?](react_router.FetcherFormProps.html#onSuspendCapture) [onTimeUpdate?](react_router.FetcherFormProps.html#onTimeUpdate) [onTimeUpdateCapture?](react_router.FetcherFormProps.html#onTimeUpdateCapture) [onTouchCancel?](react_router.FetcherFormProps.html#onTouchCancel) [onTouchCancelCapture?](react_router.FetcherFormProps.html#onTouchCancelCapture) [onTouchEnd?](react_router.FetcherFormProps.html#onTouchEnd) [onTouchEndCapture?](react_router.FetcherFormProps.html#onTouchEndCapture) [onTouchMove?](react_router.FetcherFormProps.html#onTouchMove) [onTouchMoveCapture?](react_router.FetcherFormProps.html#onTouchMoveCapture) [onTouchStart?](react_router.FetcherFormProps.html#onTouchStart) [onTouchStartCapture?](react_router.FetcherFormProps.html#onTouchStartCapture) [onTransitionEnd?](react_router.FetcherFormProps.html#onTransitionEnd) [onTransitionEndCapture?](react_router.FetcherFormProps.html#onTransitionEndCapture) [onVolumeChange?](react_router.FetcherFormProps.html#onVolumeChange) [onVolumeChangeCapture?](react_router.FetcherFormProps.html#onVolumeChangeCapture) [onWaiting?](react_router.FetcherFormProps.html#onWaiting) [onWaitingCapture?](react_router.FetcherFormProps.html#onWaitingCapture) [onWheel?](react_router.FetcherFormProps.html#onWheel) [onWheelCapture?](react_router.FetcherFormProps.html#onWheelCapture) [placeholder?](react_router.FetcherFormProps.html#placeholder) [prefix?](react_router.FetcherFormProps.html#prefix) [preventScrollReset?](react_router.FetcherFormProps.html#preventScrollReset) [property?](react_router.FetcherFormProps.html#property) [radioGroup?](react_router.FetcherFormProps.html#radioGroup) [rel?](react_router.FetcherFormProps.html#rel) [relative?](react_router.FetcherFormProps.html#relative) [resource?](react_router.FetcherFormProps.html#resource) [results?](react_router.FetcherFormProps.html#results) [rev?](react_router.FetcherFormProps.html#rev) [role?](react_router.FetcherFormProps.html#role) [security?](react_router.FetcherFormProps.html#security) [slot?](react_router.FetcherFormProps.html#slot) [spellCheck?](react_router.FetcherFormProps.html#spellCheck) [style?](react_router.FetcherFormProps.html#style) [suppressContentEditableWarning?](react_router.FetcherFormProps.html#suppressContentEditableWarning) [suppressHydrationWarning?](react_router.FetcherFormProps.html#suppressHydrationWarning) [tabIndex?](react_router.FetcherFormProps.html#tabIndex) [target?](react_router.FetcherFormProps.html#target) [title?](react_router.FetcherFormProps.html#title) [translate?](react_router.FetcherFormProps.html#translate) [typeof?](react_router.FetcherFormProps.html#typeof) [unselectable?](react_router.FetcherFormProps.html#unselectable) [vocab?](react_router.FetcherFormProps.html#vocab) Properties ---------- ### `Optional`about[](#about) about?: string ### `Optional`acceptCharset[](#acceptCharset) acceptCharset?: string ### `Optional`accessKey[](#accessKey) accessKey?: string ### `Optional`action[](#action) action?: string The URL to submit the form data to. If `undefined`, this defaults to the closest route in context. ### `Optional`aria-activedescendant[](#aria_activedescendant) aria-activedescendant?: string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. ### `Optional`aria-atomic[](#aria_atomic) aria-atomic?: Booleanish Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. ### `Optional`aria-autocomplete[](#aria_autocomplete) aria-autocomplete?:     | "none"     | "list"     | "inline"     | "both" Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. ### `Optional`aria-braillelabel[](#aria_braillelabel) aria-braillelabel?: string Defines a string value that labels the current element, which is intended to be converted into Braille. #### See[](#See) aria-label. ### `Optional`aria-brailleroledescription[](#aria_brailleroledescription) aria-brailleroledescription?: string Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. #### See[](#See-1) aria-roledescription. ### `Optional`aria-busy[](#aria_busy) aria-busy?: Booleanish ### `Optional`aria-checked[](#aria_checked) aria-checked?:     | boolean     | "true"     | "false"     | "mixed" Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. #### See[](#See-2) * aria-pressed * aria-selected. ### `Optional`aria-colcount[](#aria_colcount) aria-colcount?: number Defines the total number of columns in a table, grid, or treegrid. #### See[](#See-3) aria-colindex. ### `Optional`aria-colindex[](#aria_colindex) aria-colindex?: number Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. #### See[](#See-4) * aria-colcount * aria-colspan. ### `Optional`aria-colindextext[](#aria_colindextext) aria-colindextext?: string Defines a human readable text alternative of aria-colindex. #### See[](#See-5) aria-rowindextext. ### `Optional`aria-colspan[](#aria_colspan) aria-colspan?: number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. #### See[](#See-6) * aria-colindex * aria-rowspan. ### `Optional`aria-controls[](#aria_controls) aria-controls?: string Identifies the element (or elements) whose contents or presence are controlled by the current element. #### See[](#See-7) aria-owns. ### `Optional`aria-current[](#aria_current) aria-current?:     | boolean     | "time"     | "true"     | "location"     | "page"     | "step"     | "false"     | "date" Indicates the element that represents the current item within a container or set of related elements. ### `Optional`aria-describedby[](#aria_describedby) aria-describedby?: string Identifies the element (or elements) that describes the object. #### See[](#See-8) aria-labelledby ### `Optional`aria-description[](#aria_description) aria-description?: string Defines a string value that describes or annotates the current element. #### See[](#See-9) related aria-describedby. ### `Optional`aria-details[](#aria_details) aria-details?: string Identifies the element that provides a detailed, extended description for the object. #### See[](#See-10) aria-describedby. ### `Optional`aria-disabled[](#aria_disabled) aria-disabled?: Booleanish Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. #### See[](#See-11) * aria-hidden * aria-readonly. ### `Optional`aria-dropeffect[](#aria_dropeffect) aria-dropeffect?:     | "link"     | "copy"     | "none"     | "execute"     | "move"     | "popup" Indicates what functions can be performed when a dragged object is released on the drop target. #### Deprecated[](#Deprecated) in ARIA 1.1 ### `Optional`aria-errormessage[](#aria_errormessage) aria-errormessage?: string Identifies the element that provides an error message for the object. #### See[](#See-12) * aria-invalid * aria-describedby. ### `Optional`aria-expanded[](#aria_expanded) aria-expanded?: Booleanish Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. ### `Optional`aria-flowto[](#aria_flowto) aria-flowto?: string Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. ### `Optional`aria-grabbed[](#aria_grabbed) aria-grabbed?: Booleanish Indicates an element's "grabbed" state in a drag-and-drop operation. #### Deprecated[](#Deprecated-1) in ARIA 1.1 ### `Optional`aria-haspopup[](#aria_haspopup) aria-haspopup?:     | boolean     | "dialog"     | "menu"     | "true"     | "false"     | "grid"     | "listbox"     | "tree" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. ### `Optional`aria-hidden[](#aria_hidden) aria-hidden?: Booleanish Indicates whether the element is exposed to an accessibility API. #### See[](#See-13) aria-disabled. ### `Optional`aria-invalid[](#aria_invalid) aria-invalid?:     | boolean     | "true"     | "false"     | "grammar"     | "spelling" Indicates the entered value does not conform to the format expected by the application. #### See[](#See-14) aria-errormessage. ### `Optional`aria-keyshortcuts[](#aria_keyshortcuts) aria-keyshortcuts?: string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. ### `Optional`aria-label[](#aria_label) aria-label?: string Defines a string value that labels the current element. #### See[](#See-15) aria-labelledby. ### `Optional`aria-labelledby[](#aria_labelledby) aria-labelledby?: string Identifies the element (or elements) that labels the current element. #### See[](#See-16) aria-describedby. ### `Optional`aria-level[](#aria_level) aria-level?: number Defines the hierarchical level of an element within a structure. ### `Optional`aria-live[](#aria_live) aria-live?: "off" | "assertive" | "polite" Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. ### `Optional`aria-modal[](#aria_modal) aria-modal?: Booleanish Indicates whether an element is modal when displayed. ### `Optional`aria-multiline[](#aria_multiline) aria-multiline?: Booleanish Indicates whether a text box accepts multiple lines of input or only a single line. ### `Optional`aria-multiselectable[](#aria_multiselectable) aria-multiselectable?: Booleanish Indicates that the user may select more than one item from the current selectable descendants. ### `Optional`aria-orientation[](#aria_orientation) aria-orientation?: "horizontal" | "vertical" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. ### `Optional`aria-owns[](#aria_owns) aria-owns?: string Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. #### See[](#See-17) aria-controls. ### `Optional`aria-placeholder[](#aria_placeholder) aria-placeholder?: string Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. ### `Optional`aria-posinset[](#aria_posinset) aria-posinset?: number Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. #### See[](#See-18) aria-setsize. ### `Optional`aria-pressed[](#aria_pressed) aria-pressed?:     | boolean     | "true"     | "false"     | "mixed" Indicates the current "pressed" state of toggle buttons. #### See[](#See-19) * aria-checked * aria-selected. ### `Optional`aria-readonly[](#aria_readonly) aria-readonly?: Booleanish Indicates that the element is not editable, but is otherwise operable. #### See[](#See-20) aria-disabled. ### `Optional`aria-relevant[](#aria_relevant) aria-relevant?:     | "text"     | "additions"     | "additions removals"     | "additions text"     | "all"     | "removals"     | "removals additions"     | "removals text"     | "text additions"     | "text removals" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. #### See[](#See-21) aria-atomic. ### `Optional`aria-required[](#aria_required) aria-required?: Booleanish Indicates that user input is required on the element before a form may be submitted. ### `Optional`aria-roledescription[](#aria_roledescription) aria-roledescription?: string Defines a human-readable, author-localized description for the role of an element. ### `Optional`aria-rowcount[](#aria_rowcount) aria-rowcount?: number Defines the total number of rows in a table, grid, or treegrid. #### See[](#See-22) aria-rowindex. ### `Optional`aria-rowindex[](#aria_rowindex) aria-rowindex?: number Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. #### See[](#See-23) * aria-rowcount * aria-rowspan. ### `Optional`aria-rowindextext[](#aria_rowindextext) aria-rowindextext?: string Defines a human readable text alternative of aria-rowindex. #### See[](#See-24) aria-colindextext. ### `Optional`aria-rowspan[](#aria_rowspan) aria-rowspan?: number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. #### See[](#See-25) * aria-rowindex * aria-colspan. ### `Optional`aria-selected[](#aria_selected) aria-selected?: Booleanish Indicates the current "selected" state of various widgets. #### See[](#See-26) * aria-checked * aria-pressed. ### `Optional`aria-setsize[](#aria_setsize) aria-setsize?: number Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. #### See[](#See-27) aria-posinset. ### `Optional`aria-sort[](#aria_sort) aria-sort?:     | "none"     | "ascending"     | "descending"     | "other" Indicates if items in a table or grid are sorted in ascending or descending order. ### `Optional`aria-valuemax[](#aria_valuemax) aria-valuemax?: number Defines the maximum allowed value for a range widget. ### `Optional`aria-valuemin[](#aria_valuemin) aria-valuemin?: number Defines the minimum allowed value for a range widget. ### `Optional`aria-valuenow[](#aria_valuenow) aria-valuenow?: number Defines the current value for a range widget. #### See[](#See-28) aria-valuetext. ### `Optional`aria-valuetext[](#aria_valuetext) aria-valuetext?: string Defines the human readable text alternative of aria-valuenow for a range widget. ### `Optional`autoCapitalize[](#autoCapitalize) autoCapitalize?: string ### `Optional`autoComplete[](#autoComplete) autoComplete?: string ### `Optional`autoCorrect[](#autoCorrect) autoCorrect?: string ### `Optional`autoFocus[](#autoFocus) autoFocus?: boolean ### `Optional`autoSave[](#autoSave) autoSave?: string ### `Optional`children[](#children) children?: ReactNode ### `Optional`className[](#className) className?: string ### `Optional`color[](#color) color?: string ### `Optional`content[](#content) content?: string ### `Optional`contentEditable[](#contentEditable) contentEditable?: Booleanish | "inherit" ### `Optional`contextMenu[](#contextMenu) contextMenu?: string ### `Optional`dangerouslySetInnerHTML[](#dangerouslySetInnerHTML) dangerouslySetInnerHTML?: {     \_\_html: string | TrustedHTML; } ### `Optional`datatype[](#datatype) datatype?: string ### `Optional`defaultChecked[](#defaultChecked) defaultChecked?: boolean ### `Optional`defaultValue[](#defaultValue) defaultValue?: string | number | readonly string\[\] ### `Optional`dir[](#dir) dir?: string ### `Optional`draggable[](#draggable) draggable?: Booleanish ### `Optional`encType[](#encType) encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain" The encoding type to use for the form submission. ### `Optional`hidden[](#hidden) hidden?: boolean ### `Optional`id[](#id) id?: string ### `Optional`inlist[](#inlist) inlist?: any ### `Optional`inputMode[](#inputMode) inputMode?:     | "search"     | "text"     | "url"     | "none"     | "tel"     | "email"     | "numeric"     | "decimal" Hints at the type of data that might be entered by the user while editing the element or its contents #### See[](#See-29) [https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute) ### `Optional`is[](#is) is?: string Specify that a standard HTML element should behave like a defined custom built-in element #### See[](#See-30) [https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is) ### `Optional`itemID[](#itemID) itemID?: string ### `Optional`itemProp[](#itemProp) itemProp?: string ### `Optional`itemRef[](#itemRef) itemRef?: string ### `Optional`itemScope[](#itemScope) itemScope?: boolean ### `Optional`itemType[](#itemType) itemType?: string ### `Optional`lang[](#lang) lang?: string ### `Optional`method[](#method) method?: [HTMLFormMethod](../types/react_router.HTMLFormMethod.html) The HTTP verb to use when the form is submitted. Supports "get", "post", "put", "delete", and "patch". Native `` only supports `get` and `post`, avoid the other verbs if you'd like to support progressive enhancement ### `Optional`name[](#name) name?: string ### `Optional`nonce[](#nonce) nonce?: string ### `Optional`noValidate[](#noValidate) noValidate?: boolean ### `Optional`onAbort[](#onAbort) onAbort?: ReactEventHandler ### `Optional`onAbortCapture[](#onAbortCapture) onAbortCapture?: ReactEventHandler ### `Optional`onAnimationEnd[](#onAnimationEnd) onAnimationEnd?: AnimationEventHandler ### `Optional`onAnimationEndCapture[](#onAnimationEndCapture) onAnimationEndCapture?: AnimationEventHandler ### `Optional`onAnimationIteration[](#onAnimationIteration) onAnimationIteration?: AnimationEventHandler ### `Optional`onAnimationIterationCapture[](#onAnimationIterationCapture) onAnimationIterationCapture?: AnimationEventHandler ### `Optional`onAnimationStart[](#onAnimationStart) onAnimationStart?: AnimationEventHandler ### `Optional`onAnimationStartCapture[](#onAnimationStartCapture) onAnimationStartCapture?: AnimationEventHandler ### `Optional`onAuxClick[](#onAuxClick) onAuxClick?: MouseEventHandler ### `Optional`onAuxClickCapture[](#onAuxClickCapture) onAuxClickCapture?: MouseEventHandler ### `Optional`onBeforeInput[](#onBeforeInput) onBeforeInput?: FormEventHandler ### `Optional`onBeforeInputCapture[](#onBeforeInputCapture) onBeforeInputCapture?: FormEventHandler ### `Optional`onBlur[](#onBlur) onBlur?: FocusEventHandler ### `Optional`onBlurCapture[](#onBlurCapture) onBlurCapture?: FocusEventHandler ### `Optional`onCanPlay[](#onCanPlay) onCanPlay?: ReactEventHandler ### `Optional`onCanPlayCapture[](#onCanPlayCapture) onCanPlayCapture?: ReactEventHandler ### `Optional`onCanPlayThrough[](#onCanPlayThrough) onCanPlayThrough?: ReactEventHandler ### `Optional`onCanPlayThroughCapture[](#onCanPlayThroughCapture) onCanPlayThroughCapture?: ReactEventHandler ### `Optional`onChange[](#onChange) onChange?: FormEventHandler ### `Optional`onChangeCapture[](#onChangeCapture) onChangeCapture?: FormEventHandler ### `Optional`onClick[](#onClick) onClick?: MouseEventHandler ### `Optional`onClickCapture[](#onClickCapture) onClickCapture?: MouseEventHandler ### `Optional`onCompositionEnd[](#onCompositionEnd) onCompositionEnd?: CompositionEventHandler ### `Optional`onCompositionEndCapture[](#onCompositionEndCapture) onCompositionEndCapture?: CompositionEventHandler ### `Optional`onCompositionStart[](#onCompositionStart) onCompositionStart?: CompositionEventHandler ### `Optional`onCompositionStartCapture[](#onCompositionStartCapture) onCompositionStartCapture?: CompositionEventHandler ### `Optional`onCompositionUpdate[](#onCompositionUpdate) onCompositionUpdate?: CompositionEventHandler ### `Optional`onCompositionUpdateCapture[](#onCompositionUpdateCapture) onCompositionUpdateCapture?: CompositionEventHandler ### `Optional`onContextMenu[](#onContextMenu) onContextMenu?: MouseEventHandler ### `Optional`onContextMenuCapture[](#onContextMenuCapture) onContextMenuCapture?: MouseEventHandler ### `Optional`onCopy[](#onCopy) onCopy?: ClipboardEventHandler ### `Optional`onCopyCapture[](#onCopyCapture) onCopyCapture?: ClipboardEventHandler ### `Optional`onCut[](#onCut) onCut?: ClipboardEventHandler ### `Optional`onCutCapture[](#onCutCapture) onCutCapture?: ClipboardEventHandler ### `Optional`onDoubleClick[](#onDoubleClick) onDoubleClick?: MouseEventHandler ### `Optional`onDoubleClickCapture[](#onDoubleClickCapture) onDoubleClickCapture?: MouseEventHandler ### `Optional`onDrag[](#onDrag) onDrag?: DragEventHandler ### `Optional`onDragCapture[](#onDragCapture) onDragCapture?: DragEventHandler ### `Optional`onDragEnd[](#onDragEnd) onDragEnd?: DragEventHandler ### `Optional`onDragEndCapture[](#onDragEndCapture) onDragEndCapture?: DragEventHandler ### `Optional`onDragEnter[](#onDragEnter) onDragEnter?: DragEventHandler ### `Optional`onDragEnterCapture[](#onDragEnterCapture) onDragEnterCapture?: DragEventHandler ### `Optional`onDragExit[](#onDragExit) onDragExit?: DragEventHandler ### `Optional`onDragExitCapture[](#onDragExitCapture) onDragExitCapture?: DragEventHandler ### `Optional`onDragLeave[](#onDragLeave) onDragLeave?: DragEventHandler ### `Optional`onDragLeaveCapture[](#onDragLeaveCapture) onDragLeaveCapture?: DragEventHandler ### `Optional`onDragOver[](#onDragOver) onDragOver?: DragEventHandler ### `Optional`onDragOverCapture[](#onDragOverCapture) onDragOverCapture?: DragEventHandler ### `Optional`onDragStart[](#onDragStart) onDragStart?: DragEventHandler ### `Optional`onDragStartCapture[](#onDragStartCapture) onDragStartCapture?: DragEventHandler ### `Optional`onDrop[](#onDrop) onDrop?: DragEventHandler ### `Optional`onDropCapture[](#onDropCapture) onDropCapture?: DragEventHandler ### `Optional`onDurationChange[](#onDurationChange) onDurationChange?: ReactEventHandler ### `Optional`onDurationChangeCapture[](#onDurationChangeCapture) onDurationChangeCapture?: ReactEventHandler ### `Optional`onEmptied[](#onEmptied) onEmptied?: ReactEventHandler ### `Optional`onEmptiedCapture[](#onEmptiedCapture) onEmptiedCapture?: ReactEventHandler ### `Optional`onEncrypted[](#onEncrypted) onEncrypted?: ReactEventHandler ### `Optional`onEncryptedCapture[](#onEncryptedCapture) onEncryptedCapture?: ReactEventHandler ### `Optional`onEnded[](#onEnded) onEnded?: ReactEventHandler ### `Optional`onEndedCapture[](#onEndedCapture) onEndedCapture?: ReactEventHandler ### `Optional`onError[](#onError) onError?: ReactEventHandler ### `Optional`onErrorCapture[](#onErrorCapture) onErrorCapture?: ReactEventHandler ### `Optional`onFocus[](#onFocus) onFocus?: FocusEventHandler ### `Optional`onFocusCapture[](#onFocusCapture) onFocusCapture?: FocusEventHandler ### `Optional`onGotPointerCapture[](#onGotPointerCapture) onGotPointerCapture?: PointerEventHandler ### `Optional`onGotPointerCaptureCapture[](#onGotPointerCaptureCapture) onGotPointerCaptureCapture?: PointerEventHandler ### `Optional`onInput[](#onInput) onInput?: FormEventHandler ### `Optional`onInputCapture[](#onInputCapture) onInputCapture?: FormEventHandler ### `Optional`onInvalid[](#onInvalid) onInvalid?: FormEventHandler ### `Optional`onInvalidCapture[](#onInvalidCapture) onInvalidCapture?: FormEventHandler ### `Optional`onKeyDown[](#onKeyDown) onKeyDown?: KeyboardEventHandler ### `Optional`onKeyDownCapture[](#onKeyDownCapture) onKeyDownCapture?: KeyboardEventHandler ### `Optional`onKeyPress[](#onKeyPress) onKeyPress?: KeyboardEventHandler #### Deprecated[](#Deprecated-2) ### `Optional`onKeyPressCapture[](#onKeyPressCapture) onKeyPressCapture?: KeyboardEventHandler #### Deprecated[](#Deprecated-3) ### `Optional`onKeyUp[](#onKeyUp) onKeyUp?: KeyboardEventHandler ### `Optional`onKeyUpCapture[](#onKeyUpCapture) onKeyUpCapture?: KeyboardEventHandler ### `Optional`onLoad[](#onLoad) onLoad?: ReactEventHandler ### `Optional`onLoadCapture[](#onLoadCapture) onLoadCapture?: ReactEventHandler ### `Optional`onLoadedData[](#onLoadedData) onLoadedData?: ReactEventHandler ### `Optional`onLoadedDataCapture[](#onLoadedDataCapture) onLoadedDataCapture?: ReactEventHandler ### `Optional`onLoadedMetadata[](#onLoadedMetadata) onLoadedMetadata?: ReactEventHandler ### `Optional`onLoadedMetadataCapture[](#onLoadedMetadataCapture) onLoadedMetadataCapture?: ReactEventHandler ### `Optional`onLoadStart[](#onLoadStart) onLoadStart?: ReactEventHandler ### `Optional`onLoadStartCapture[](#onLoadStartCapture) onLoadStartCapture?: ReactEventHandler ### `Optional`onLostPointerCapture[](#onLostPointerCapture) onLostPointerCapture?: PointerEventHandler ### `Optional`onLostPointerCaptureCapture[](#onLostPointerCaptureCapture) onLostPointerCaptureCapture?: PointerEventHandler ### `Optional`onMouseDown[](#onMouseDown) onMouseDown?: MouseEventHandler ### `Optional`onMouseDownCapture[](#onMouseDownCapture) onMouseDownCapture?: MouseEventHandler ### `Optional`onMouseEnter[](#onMouseEnter) onMouseEnter?: MouseEventHandler ### `Optional`onMouseLeave[](#onMouseLeave) onMouseLeave?: MouseEventHandler ### `Optional`onMouseMove[](#onMouseMove) onMouseMove?: MouseEventHandler ### `Optional`onMouseMoveCapture[](#onMouseMoveCapture) onMouseMoveCapture?: MouseEventHandler ### `Optional`onMouseOut[](#onMouseOut) onMouseOut?: MouseEventHandler ### `Optional`onMouseOutCapture[](#onMouseOutCapture) onMouseOutCapture?: MouseEventHandler ### `Optional`onMouseOver[](#onMouseOver) onMouseOver?: MouseEventHandler ### `Optional`onMouseOverCapture[](#onMouseOverCapture) onMouseOverCapture?: MouseEventHandler ### `Optional`onMouseUp[](#onMouseUp) onMouseUp?: MouseEventHandler ### `Optional`onMouseUpCapture[](#onMouseUpCapture) onMouseUpCapture?: MouseEventHandler ### `Optional`onPaste[](#onPaste) onPaste?: ClipboardEventHandler ### `Optional`onPasteCapture[](#onPasteCapture) onPasteCapture?: ClipboardEventHandler ### `Optional`onPause[](#onPause) onPause?: ReactEventHandler ### `Optional`onPauseCapture[](#onPauseCapture) onPauseCapture?: ReactEventHandler ### `Optional`onPlay[](#onPlay) onPlay?: ReactEventHandler ### `Optional`onPlayCapture[](#onPlayCapture) onPlayCapture?: ReactEventHandler ### `Optional`onPlaying[](#onPlaying) onPlaying?: ReactEventHandler ### `Optional`onPlayingCapture[](#onPlayingCapture) onPlayingCapture?: ReactEventHandler ### `Optional`onPointerCancel[](#onPointerCancel) onPointerCancel?: PointerEventHandler ### `Optional`onPointerCancelCapture[](#onPointerCancelCapture) onPointerCancelCapture?: PointerEventHandler ### `Optional`onPointerDown[](#onPointerDown) onPointerDown?: PointerEventHandler ### `Optional`onPointerDownCapture[](#onPointerDownCapture) onPointerDownCapture?: PointerEventHandler ### `Optional`onPointerEnter[](#onPointerEnter) onPointerEnter?: PointerEventHandler ### `Optional`onPointerEnterCapture[](#onPointerEnterCapture) onPointerEnterCapture?: PointerEventHandler ### `Optional`onPointerLeave[](#onPointerLeave) onPointerLeave?: PointerEventHandler ### `Optional`onPointerLeaveCapture[](#onPointerLeaveCapture) onPointerLeaveCapture?: PointerEventHandler ### `Optional`onPointerMove[](#onPointerMove) onPointerMove?: PointerEventHandler ### `Optional`onPointerMoveCapture[](#onPointerMoveCapture) onPointerMoveCapture?: PointerEventHandler ### `Optional`onPointerOut[](#onPointerOut) onPointerOut?: PointerEventHandler ### `Optional`onPointerOutCapture[](#onPointerOutCapture) onPointerOutCapture?: PointerEventHandler ### `Optional`onPointerOver[](#onPointerOver) onPointerOver?: PointerEventHandler ### `Optional`onPointerOverCapture[](#onPointerOverCapture) onPointerOverCapture?: PointerEventHandler ### `Optional`onPointerUp[](#onPointerUp) onPointerUp?: PointerEventHandler ### `Optional`onPointerUpCapture[](#onPointerUpCapture) onPointerUpCapture?: PointerEventHandler ### `Optional`onProgress[](#onProgress) onProgress?: ReactEventHandler ### `Optional`onProgressCapture[](#onProgressCapture) onProgressCapture?: ReactEventHandler ### `Optional`onRateChange[](#onRateChange) onRateChange?: ReactEventHandler ### `Optional`onRateChangeCapture[](#onRateChangeCapture) onRateChangeCapture?: ReactEventHandler ### `Optional`onReset[](#onReset) onReset?: FormEventHandler ### `Optional`onResetCapture[](#onResetCapture) onResetCapture?: FormEventHandler ### `Optional`onResize[](#onResize) onResize?: ReactEventHandler ### `Optional`onResizeCapture[](#onResizeCapture) onResizeCapture?: ReactEventHandler ### `Optional`onScroll[](#onScroll) onScroll?: UIEventHandler ### `Optional`onScrollCapture[](#onScrollCapture) onScrollCapture?: UIEventHandler ### `Optional`onSeeked[](#onSeeked) onSeeked?: ReactEventHandler ### `Optional`onSeekedCapture[](#onSeekedCapture) onSeekedCapture?: ReactEventHandler ### `Optional`onSeeking[](#onSeeking) onSeeking?: ReactEventHandler ### `Optional`onSeekingCapture[](#onSeekingCapture) onSeekingCapture?: ReactEventHandler ### `Optional`onSelect[](#onSelect) onSelect?: ReactEventHandler ### `Optional`onSelectCapture[](#onSelectCapture) onSelectCapture?: ReactEventHandler ### `Optional`onStalled[](#onStalled) onStalled?: ReactEventHandler ### `Optional`onStalledCapture[](#onStalledCapture) onStalledCapture?: ReactEventHandler ### `Optional`onSubmit[](#onSubmit) onSubmit?: FormEventHandler A function to call when the form is submitted. If you call `event.preventDefault()` then this form will not do anything. ### `Optional`onSubmitCapture[](#onSubmitCapture) onSubmitCapture?: FormEventHandler ### `Optional`onSuspend[](#onSuspend) onSuspend?: ReactEventHandler ### `Optional`onSuspendCapture[](#onSuspendCapture) onSuspendCapture?: ReactEventHandler ### `Optional`onTimeUpdate[](#onTimeUpdate) onTimeUpdate?: ReactEventHandler ### `Optional`onTimeUpdateCapture[](#onTimeUpdateCapture) onTimeUpdateCapture?: ReactEventHandler ### `Optional`onTouchCancel[](#onTouchCancel) onTouchCancel?: TouchEventHandler ### `Optional`onTouchCancelCapture[](#onTouchCancelCapture) onTouchCancelCapture?: TouchEventHandler ### `Optional`onTouchEnd[](#onTouchEnd) onTouchEnd?: TouchEventHandler ### `Optional`onTouchEndCapture[](#onTouchEndCapture) onTouchEndCapture?: TouchEventHandler ### `Optional`onTouchMove[](#onTouchMove) onTouchMove?: TouchEventHandler ### `Optional`onTouchMoveCapture[](#onTouchMoveCapture) onTouchMoveCapture?: TouchEventHandler ### `Optional`onTouchStart[](#onTouchStart) onTouchStart?: TouchEventHandler ### `Optional`onTouchStartCapture[](#onTouchStartCapture) onTouchStartCapture?: TouchEventHandler ### `Optional`onTransitionEnd[](#onTransitionEnd) onTransitionEnd?: TransitionEventHandler ### `Optional`onTransitionEndCapture[](#onTransitionEndCapture) onTransitionEndCapture?: TransitionEventHandler ### `Optional`onVolumeChange[](#onVolumeChange) onVolumeChange?: ReactEventHandler ### `Optional`onVolumeChangeCapture[](#onVolumeChangeCapture) onVolumeChangeCapture?: ReactEventHandler ### `Optional`onWaiting[](#onWaiting) onWaiting?: ReactEventHandler ### `Optional`onWaitingCapture[](#onWaitingCapture) onWaitingCapture?: ReactEventHandler ### `Optional`onWheel[](#onWheel) onWheel?: WheelEventHandler ### `Optional`onWheelCapture[](#onWheelCapture) onWheelCapture?: WheelEventHandler ### `Optional`placeholder[](#placeholder) placeholder?: string ### `Optional`prefix[](#prefix) prefix?: string ### `Optional`preventScrollReset[](#preventScrollReset) preventScrollReset?: boolean Prevent the scroll position from resetting to the top of the viewport on completion of the navigation when using the component ### `Optional`property[](#property) property?: string ### `Optional`radioGroup[](#radioGroup) radioGroup?: string ### `Optional`rel[](#rel) rel?: string ### `Optional`relative[](#relative) relative?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) Determines whether the form action is relative to the route hierarchy or the pathname. Use this if you want to opt out of navigating the route hierarchy and want to instead route based on /-delimited URL segments ### `Optional`resource[](#resource) resource?: string ### `Optional`results[](#results) results?: number ### `Optional`rev[](#rev) rev?: string ### `Optional`role[](#role) role?: AriaRole ### `Optional`security[](#security) security?: string ### `Optional`slot[](#slot) slot?: string ### `Optional`spellCheck[](#spellCheck) spellCheck?: Booleanish ### `Optional`style[](#style) style?: CSSProperties ### `Optional`suppressContentEditableWarning[](#suppressContentEditableWarning) suppressContentEditableWarning?: boolean ### `Optional`suppressHydrationWarning[](#suppressHydrationWarning) suppressHydrationWarning?: boolean ### `Optional`tabIndex[](#tabIndex) tabIndex?: number ### `Optional`target[](#target) target?: string ### `Optional`title[](#title) title?: string ### `Optional`translate[](#translate) translate?: "yes" | "no" ### `Optional`typeof[](#typeof) typeof?: string ### `Optional`unselectable[](#unselectable) unselectable?: "on" | "off" ### `Optional`vocab[](#vocab) vocab?: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [about](#about) [acceptCharset](#acceptCharset) [accessKey](#accessKey) [action](#action) [aria-activedescendant](#aria_activedescendant) [aria-atomic](#aria_atomic) [aria-autocomplete](#aria_autocomplete) [aria-braillelabel](#aria_braillelabel) [aria-brailleroledescription](#aria_brailleroledescription) [aria-busy](#aria_busy) [aria-checked](#aria_checked) [aria-colcount](#aria_colcount) [aria-colindex](#aria_colindex) [aria-colindextext](#aria_colindextext) [aria-colspan](#aria_colspan) [aria-controls](#aria_controls) [aria-current](#aria_current) [aria-describedby](#aria_describedby) [aria-description](#aria_description) [aria-details](#aria_details) [aria-disabled](#aria_disabled) [aria-dropeffect](#aria_dropeffect) [aria-errormessage](#aria_errormessage) [aria-expanded](#aria_expanded) [aria-flowto](#aria_flowto) [aria-grabbed](#aria_grabbed) [aria-haspopup](#aria_haspopup) [aria-hidden](#aria_hidden) [aria-invalid](#aria_invalid) [aria-keyshortcuts](#aria_keyshortcuts) [aria-label](#aria_label) [aria-labelledby](#aria_labelledby) [aria-level](#aria_level) [aria-live](#aria_live) [aria-modal](#aria_modal) [aria-multiline](#aria_multiline) [aria-multiselectable](#aria_multiselectable) [aria-orientation](#aria_orientation) [aria-owns](#aria_owns) [aria-placeholder](#aria_placeholder) [aria-posinset](#aria_posinset) [aria-pressed](#aria_pressed) [aria-readonly](#aria_readonly) [aria-relevant](#aria_relevant) [aria-required](#aria_required) [aria-roledescription](#aria_roledescription) [aria-rowcount](#aria_rowcount) [aria-rowindex](#aria_rowindex) [aria-rowindextext](#aria_rowindextext) [aria-rowspan](#aria_rowspan) [aria-selected](#aria_selected) [aria-setsize](#aria_setsize) [aria-sort](#aria_sort) [aria-valuemax](#aria_valuemax) [aria-valuemin](#aria_valuemin) [aria-valuenow](#aria_valuenow) [aria-valuetext](#aria_valuetext) [autoCapitalize](#autoCapitalize) [autoComplete](#autoComplete) [autoCorrect](#autoCorrect) [autoFocus](#autoFocus) [autoSave](#autoSave) [children](#children) [className](#className) [color](#color) [content](#content) [contentEditable](#contentEditable) [contextMenu](#contextMenu) [dangerouslySetInnerHTML](#dangerouslySetInnerHTML) [datatype](#datatype) [defaultChecked](#defaultChecked) [defaultValue](#defaultValue) [dir](#dir) [draggable](#draggable) [encType](#encType) [hidden](#hidden) [id](#id) [inlist](#inlist) [inputMode](#inputMode) [is](#is) [itemID](#itemID) [itemProp](#itemProp) [itemRef](#itemRef) [itemScope](#itemScope) [itemType](#itemType) [lang](#lang) [method](#method) [name](#name) [nonce](#nonce) [noValidate](#noValidate) [onAbort](#onAbort) [onAbortCapture](#onAbortCapture) [onAnimationEnd](#onAnimationEnd) [onAnimationEndCapture](#onAnimationEndCapture) [onAnimationIteration](#onAnimationIteration) [onAnimationIterationCapture](#onAnimationIterationCapture) [onAnimationStart](#onAnimationStart) [onAnimationStartCapture](#onAnimationStartCapture) [onAuxClick](#onAuxClick) [onAuxClickCapture](#onAuxClickCapture) [onBeforeInput](#onBeforeInput) [onBeforeInputCapture](#onBeforeInputCapture) [onBlur](#onBlur) [onBlurCapture](#onBlurCapture) [onCanPlay](#onCanPlay) [onCanPlayCapture](#onCanPlayCapture) [onCanPlayThrough](#onCanPlayThrough) [onCanPlayThroughCapture](#onCanPlayThroughCapture) [onChange](#onChange) [onChangeCapture](#onChangeCapture) [onClick](#onClick) [onClickCapture](#onClickCapture) [onCompositionEnd](#onCompositionEnd) [onCompositionEndCapture](#onCompositionEndCapture) [onCompositionStart](#onCompositionStart) [onCompositionStartCapture](#onCompositionStartCapture) [onCompositionUpdate](#onCompositionUpdate) [onCompositionUpdateCapture](#onCompositionUpdateCapture) [onContextMenu](#onContextMenu) [onContextMenuCapture](#onContextMenuCapture) [onCopy](#onCopy) [onCopyCapture](#onCopyCapture) [onCut](#onCut) [onCutCapture](#onCutCapture) [onDoubleClick](#onDoubleClick) [onDoubleClickCapture](#onDoubleClickCapture) [onDrag](#onDrag) [onDragCapture](#onDragCapture) [onDragEnd](#onDragEnd) [onDragEndCapture](#onDragEndCapture) [onDragEnter](#onDragEnter) [onDragEnterCapture](#onDragEnterCapture) [onDragExit](#onDragExit) [onDragExitCapture](#onDragExitCapture) [onDragLeave](#onDragLeave) [onDragLeaveCapture](#onDragLeaveCapture) [onDragOver](#onDragOver) [onDragOverCapture](#onDragOverCapture) [onDragStart](#onDragStart) [onDragStartCapture](#onDragStartCapture) [onDrop](#onDrop) [onDropCapture](#onDropCapture) [onDurationChange](#onDurationChange) [onDurationChangeCapture](#onDurationChangeCapture) [onEmptied](#onEmptied) [onEmptiedCapture](#onEmptiedCapture) [onEncrypted](#onEncrypted) [onEncryptedCapture](#onEncryptedCapture) [onEnded](#onEnded) [onEndedCapture](#onEndedCapture) [onError](#onError) [onErrorCapture](#onErrorCapture) [onFocus](#onFocus) [onFocusCapture](#onFocusCapture) [onGotPointerCapture](#onGotPointerCapture) [onGotPointerCaptureCapture](#onGotPointerCaptureCapture) [onInput](#onInput) [onInputCapture](#onInputCapture) [onInvalid](#onInvalid) [onInvalidCapture](#onInvalidCapture) [onKeyDown](#onKeyDown) [onKeyDownCapture](#onKeyDownCapture) [onKeyPress](#onKeyPress) [onKeyPressCapture](#onKeyPressCapture) [onKeyUp](#onKeyUp) [onKeyUpCapture](#onKeyUpCapture) [onLoad](#onLoad) [onLoadCapture](#onLoadCapture) [onLoadedData](#onLoadedData) [onLoadedDataCapture](#onLoadedDataCapture) [onLoadedMetadata](#onLoadedMetadata) [onLoadedMetadataCapture](#onLoadedMetadataCapture) [onLoadStart](#onLoadStart) [onLoadStartCapture](#onLoadStartCapture) [onLostPointerCapture](#onLostPointerCapture) [onLostPointerCaptureCapture](#onLostPointerCaptureCapture) [onMouseDown](#onMouseDown) [onMouseDownCapture](#onMouseDownCapture) [onMouseEnter](#onMouseEnter) [onMouseLeave](#onMouseLeave) [onMouseMove](#onMouseMove) [onMouseMoveCapture](#onMouseMoveCapture) [onMouseOut](#onMouseOut) [onMouseOutCapture](#onMouseOutCapture) [onMouseOver](#onMouseOver) [onMouseOverCapture](#onMouseOverCapture) [onMouseUp](#onMouseUp) [onMouseUpCapture](#onMouseUpCapture) [onPaste](#onPaste) [onPasteCapture](#onPasteCapture) [onPause](#onPause) [onPauseCapture](#onPauseCapture) [onPlay](#onPlay) [onPlayCapture](#onPlayCapture) [onPlaying](#onPlaying) [onPlayingCapture](#onPlayingCapture) [onPointerCancel](#onPointerCancel) [onPointerCancelCapture](#onPointerCancelCapture) [onPointerDown](#onPointerDown) [onPointerDownCapture](#onPointerDownCapture) [onPointerEnter](#onPointerEnter) [onPointerEnterCapture](#onPointerEnterCapture) [onPointerLeave](#onPointerLeave) [onPointerLeaveCapture](#onPointerLeaveCapture) [onPointerMove](#onPointerMove) [onPointerMoveCapture](#onPointerMoveCapture) [onPointerOut](#onPointerOut) [onPointerOutCapture](#onPointerOutCapture) [onPointerOver](#onPointerOver) [onPointerOverCapture](#onPointerOverCapture) [onPointerUp](#onPointerUp) [onPointerUpCapture](#onPointerUpCapture) [onProgress](#onProgress) [onProgressCapture](#onProgressCapture) [onRateChange](#onRateChange) [onRateChangeCapture](#onRateChangeCapture) [onReset](#onReset) [onResetCapture](#onResetCapture) [onResize](#onResize) [onResizeCapture](#onResizeCapture) [onScroll](#onScroll) [onScrollCapture](#onScrollCapture) [onSeeked](#onSeeked) [onSeekedCapture](#onSeekedCapture) [onSeeking](#onSeeking) [onSeekingCapture](#onSeekingCapture) [onSelect](#onSelect) [onSelectCapture](#onSelectCapture) [onStalled](#onStalled) [onStalledCapture](#onStalledCapture) [onSubmit](#onSubmit) [onSubmitCapture](#onSubmitCapture) [onSuspend](#onSuspend) [onSuspendCapture](#onSuspendCapture) [onTimeUpdate](#onTimeUpdate) [onTimeUpdateCapture](#onTimeUpdateCapture) [onTouchCancel](#onTouchCancel) [onTouchCancelCapture](#onTouchCancelCapture) [onTouchEnd](#onTouchEnd) [onTouchEndCapture](#onTouchEndCapture) [onTouchMove](#onTouchMove) [onTouchMoveCapture](#onTouchMoveCapture) [onTouchStart](#onTouchStart) [onTouchStartCapture](#onTouchStartCapture) [onTransitionEnd](#onTransitionEnd) [onTransitionEndCapture](#onTransitionEndCapture) [onVolumeChange](#onVolumeChange) [onVolumeChangeCapture](#onVolumeChangeCapture) [onWaiting](#onWaiting) [onWaitingCapture](#onWaitingCapture) [onWheel](#onWheel) [onWheelCapture](#onWheelCapture) [placeholder](#placeholder) [prefix](#prefix) [preventScrollReset](#preventScrollReset) [property](#property) [radioGroup](#radioGroup) [rel](#rel) [relative](#relative) [resource](#resource) [results](#results) [rev](#rev) [role](#role) [security](#security) [slot](#slot) [spellCheck](#spellCheck) [style](#style) [suppressContentEditableWarning](#suppressContentEditableWarning) [suppressHydrationWarning](#suppressHydrationWarning) [tabIndex](#tabIndex) [target](#target) [title](#title) [translate](#translate) [typeof](#typeof) [unselectable](#unselectable) [vocab](#vocab) --- # HeadersFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [HeadersFunction](react_router.HeadersFunction.html) Interface HeadersFunction ========================= A function that returns HTTP headers to be used for a route. These headers will be merged with (and take precedence over) headers from parent routes. * HeadersFunction(args): HeadersInit[](#HeadersFunction) * #### Parameters * args: [HeadersArgs](../types/react_router.HeadersArgs.html) #### Returns HeadersInit ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HashRouterProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [HashRouterProps](react_router.HashRouterProps.html) Interface HashRouterProps ========================= interface HashRouterProps {     [basename](react_router.HashRouterProps.html#basename) ?: string;     [children](react_router.HashRouterProps.html#children) ?: ReactNode;     [window](react_router.HashRouterProps.html#window) ?: Window; } ##### Index ### Properties [basename?](react_router.HashRouterProps.html#basename) [children?](react_router.HashRouterProps.html#children) [window?](react_router.HashRouterProps.html#window) Properties ---------- ### `Optional`basename[](#basename) basename?: string ### `Optional`children[](#children) children?: ReactNode ### `Optional`window[](#window) window?: Window ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [basename](#basename) [children](#children) [window](#window) --- # FormProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [FormProps](react_router.FormProps.html) Interface FormProps =================== Form props available to navigations interface FormProps {     [about](react_router.FormProps.html#about) ?: string;     [acceptCharset](react_router.FormProps.html#acceptCharset) ?: string;     [accessKey](react_router.FormProps.html#accessKey) ?: string;     [action](react_router.FormProps.html#action) ?: string;     [aria-activedescendant](react_router.FormProps.html#aria_activedescendant) ?: string;     [aria-atomic](react_router.FormProps.html#aria_atomic) ?: Booleanish;     [aria-autocomplete](react_router.FormProps.html#aria_autocomplete) ?:         | "none"         | "list"         | "inline"         | "both";     [aria-braillelabel](react_router.FormProps.html#aria_braillelabel) ?: string;     [aria-brailleroledescription](react_router.FormProps.html#aria_brailleroledescription) ?: string;     [aria-busy](react_router.FormProps.html#aria_busy) ?: Booleanish;     [aria-checked](react_router.FormProps.html#aria_checked) ?:         | boolean         | "true"         | "false"         | "mixed";     [aria-colcount](react_router.FormProps.html#aria_colcount) ?: number;     [aria-colindex](react_router.FormProps.html#aria_colindex) ?: number;     [aria-colindextext](react_router.FormProps.html#aria_colindextext) ?: string;     [aria-colspan](react_router.FormProps.html#aria_colspan) ?: number;     [aria-controls](react_router.FormProps.html#aria_controls) ?: string;     [aria-current](react_router.FormProps.html#aria_current) ?:         | boolean         | "time"         | "true"         | "location"         | "page"         | "step"         | "false"         | "date";     [aria-describedby](react_router.FormProps.html#aria_describedby) ?: string;     [aria-description](react_router.FormProps.html#aria_description) ?: string;     [aria-details](react_router.FormProps.html#aria_details) ?: string;     [aria-disabled](react_router.FormProps.html#aria_disabled) ?: Booleanish;     [aria-dropeffect](react_router.FormProps.html#aria_dropeffect) ?:         | "link"         | "copy"         | "none"         | "execute"         | "move"         | "popup";     [aria-errormessage](react_router.FormProps.html#aria_errormessage) ?: string;     [aria-expanded](react_router.FormProps.html#aria_expanded) ?: Booleanish;     [aria-flowto](react_router.FormProps.html#aria_flowto) ?: string;     [aria-grabbed](react_router.FormProps.html#aria_grabbed) ?: Booleanish;     [aria-haspopup](react_router.FormProps.html#aria_haspopup) ?:         | boolean         | "dialog"         | "menu"         | "true"         | "false"         | "grid"         | "listbox"         | "tree";     [aria-hidden](react_router.FormProps.html#aria_hidden) ?: Booleanish;     [aria-invalid](react_router.FormProps.html#aria_invalid) ?:         | boolean         | "true"         | "false"         | "grammar"         | "spelling";     [aria-keyshortcuts](react_router.FormProps.html#aria_keyshortcuts) ?: string;     [aria-label](react_router.FormProps.html#aria_label) ?: string;     [aria-labelledby](react_router.FormProps.html#aria_labelledby) ?: string;     [aria-level](react_router.FormProps.html#aria_level) ?: number;     [aria-live](react_router.FormProps.html#aria_live) ?: "off" | "assertive" | "polite";     [aria-modal](react_router.FormProps.html#aria_modal) ?: Booleanish;     [aria-multiline](react_router.FormProps.html#aria_multiline) ?: Booleanish;     [aria-multiselectable](react_router.FormProps.html#aria_multiselectable) ?: Booleanish;     [aria-orientation](react_router.FormProps.html#aria_orientation) ?: "horizontal" | "vertical";     [aria-owns](react_router.FormProps.html#aria_owns) ?: string;     [aria-placeholder](react_router.FormProps.html#aria_placeholder) ?: string;     [aria-posinset](react_router.FormProps.html#aria_posinset) ?: number;     [aria-pressed](react_router.FormProps.html#aria_pressed) ?:         | boolean         | "true"         | "false"         | "mixed";     [aria-readonly](react_router.FormProps.html#aria_readonly) ?: Booleanish;     [aria-relevant](react_router.FormProps.html#aria_relevant) ?:         | "text"         | "additions"         | "additions removals"         | "additions text"         | "all"         | "removals"         | "removals additions"         | "removals text"         | "text additions"         | "text removals";     [aria-required](react_router.FormProps.html#aria_required) ?: Booleanish;     [aria-roledescription](react_router.FormProps.html#aria_roledescription) ?: string;     [aria-rowcount](react_router.FormProps.html#aria_rowcount) ?: number;     [aria-rowindex](react_router.FormProps.html#aria_rowindex) ?: number;     [aria-rowindextext](react_router.FormProps.html#aria_rowindextext) ?: string;     [aria-rowspan](react_router.FormProps.html#aria_rowspan) ?: number;     [aria-selected](react_router.FormProps.html#aria_selected) ?: Booleanish;     [aria-setsize](react_router.FormProps.html#aria_setsize) ?: number;     [aria-sort](react_router.FormProps.html#aria_sort) ?:         | "none"         | "ascending"         | "descending"         | "other";     [aria-valuemax](react_router.FormProps.html#aria_valuemax) ?: number;     [aria-valuemin](react_router.FormProps.html#aria_valuemin) ?: number;     [aria-valuenow](react_router.FormProps.html#aria_valuenow) ?: number;     [aria-valuetext](react_router.FormProps.html#aria_valuetext) ?: string;     [autoCapitalize](react_router.FormProps.html#autoCapitalize) ?: string;     [autoComplete](react_router.FormProps.html#autoComplete) ?: string;     [autoCorrect](react_router.FormProps.html#autoCorrect) ?: string;     [autoFocus](react_router.FormProps.html#autoFocus) ?: boolean;     [autoSave](react_router.FormProps.html#autoSave) ?: string;     [children](react_router.FormProps.html#children) ?: ReactNode;     [className](react_router.FormProps.html#className) ?: string;     [color](react_router.FormProps.html#color) ?: string;     [content](react_router.FormProps.html#content) ?: string;     [contentEditable](react_router.FormProps.html#contentEditable) ?: Booleanish | "inherit";     [contextMenu](react_router.FormProps.html#contextMenu) ?: string;     [dangerouslySetInnerHTML](react_router.FormProps.html#dangerouslySetInnerHTML) ?: {         \_\_html: string | TrustedHTML;     };     [datatype](react_router.FormProps.html#datatype) ?: string;     [defaultChecked](react_router.FormProps.html#defaultChecked) ?: boolean;     [defaultValue](react_router.FormProps.html#defaultValue) ?: string | number | readonly string\[\];     [dir](react_router.FormProps.html#dir) ?: string;     [discover](react_router.FormProps.html#discover) ?: DiscoverBehavior;     [draggable](react_router.FormProps.html#draggable) ?: Booleanish;     [encType](react_router.FormProps.html#encType) ?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain";     [fetcherKey](react_router.FormProps.html#fetcherKey) ?: string;     [hidden](react_router.FormProps.html#hidden) ?: boolean;     [id](react_router.FormProps.html#id) ?: string;     [inlist](react_router.FormProps.html#inlist) ?: any;     [inputMode](react_router.FormProps.html#inputMode) ?:         | "search"         | "text"         | "url"         | "none"         | "tel"         | "email"         | "numeric"         | "decimal";     [is](react_router.FormProps.html#is) ?: string;     [itemID](react_router.FormProps.html#itemID) ?: string;     [itemProp](react_router.FormProps.html#itemProp) ?: string;     [itemRef](react_router.FormProps.html#itemRef) ?: string;     [itemScope](react_router.FormProps.html#itemScope) ?: boolean;     [itemType](react_router.FormProps.html#itemType) ?: string;     [lang](react_router.FormProps.html#lang) ?: string;     [method](react_router.FormProps.html#method) ?: [HTMLFormMethod](../types/react_router.HTMLFormMethod.html) ;     [name](react_router.FormProps.html#name) ?: string;     [navigate](react_router.FormProps.html#navigate) ?: boolean;     [nonce](react_router.FormProps.html#nonce) ?: string;     [noValidate](react_router.FormProps.html#noValidate) ?: boolean;     [onAbort](react_router.FormProps.html#onAbort) ?: ReactEventHandler;     [onAbortCapture](react_router.FormProps.html#onAbortCapture) ?: ReactEventHandler;     [onAnimationEnd](react_router.FormProps.html#onAnimationEnd) ?: AnimationEventHandler;     [onAnimationEndCapture](react_router.FormProps.html#onAnimationEndCapture) ?: AnimationEventHandler;     [onAnimationIteration](react_router.FormProps.html#onAnimationIteration) ?: AnimationEventHandler;     [onAnimationIterationCapture](react_router.FormProps.html#onAnimationIterationCapture) ?: AnimationEventHandler;     [onAnimationStart](react_router.FormProps.html#onAnimationStart) ?: AnimationEventHandler;     [onAnimationStartCapture](react_router.FormProps.html#onAnimationStartCapture) ?: AnimationEventHandler;     [onAuxClick](react_router.FormProps.html#onAuxClick) ?: MouseEventHandler;     [onAuxClickCapture](react_router.FormProps.html#onAuxClickCapture) ?: MouseEventHandler;     [onBeforeInput](react_router.FormProps.html#onBeforeInput) ?: FormEventHandler;     [onBeforeInputCapture](react_router.FormProps.html#onBeforeInputCapture) ?: FormEventHandler;     [onBlur](react_router.FormProps.html#onBlur) ?: FocusEventHandler;     [onBlurCapture](react_router.FormProps.html#onBlurCapture) ?: FocusEventHandler;     [onCanPlay](react_router.FormProps.html#onCanPlay) ?: ReactEventHandler;     [onCanPlayCapture](react_router.FormProps.html#onCanPlayCapture) ?: ReactEventHandler;     [onCanPlayThrough](react_router.FormProps.html#onCanPlayThrough) ?: ReactEventHandler;     [onCanPlayThroughCapture](react_router.FormProps.html#onCanPlayThroughCapture) ?: ReactEventHandler;     [onChange](react_router.FormProps.html#onChange) ?: FormEventHandler;     [onChangeCapture](react_router.FormProps.html#onChangeCapture) ?: FormEventHandler;     [onClick](react_router.FormProps.html#onClick) ?: MouseEventHandler;     [onClickCapture](react_router.FormProps.html#onClickCapture) ?: MouseEventHandler;     [onCompositionEnd](react_router.FormProps.html#onCompositionEnd) ?: CompositionEventHandler;     [onCompositionEndCapture](react_router.FormProps.html#onCompositionEndCapture) ?: CompositionEventHandler;     [onCompositionStart](react_router.FormProps.html#onCompositionStart) ?: CompositionEventHandler;     [onCompositionStartCapture](react_router.FormProps.html#onCompositionStartCapture) ?: CompositionEventHandler;     [onCompositionUpdate](react_router.FormProps.html#onCompositionUpdate) ?: CompositionEventHandler;     [onCompositionUpdateCapture](react_router.FormProps.html#onCompositionUpdateCapture) ?: CompositionEventHandler;     [onContextMenu](react_router.FormProps.html#onContextMenu) ?: MouseEventHandler;     [onContextMenuCapture](react_router.FormProps.html#onContextMenuCapture) ?: MouseEventHandler;     [onCopy](react_router.FormProps.html#onCopy) ?: ClipboardEventHandler;     [onCopyCapture](react_router.FormProps.html#onCopyCapture) ?: ClipboardEventHandler;     [onCut](react_router.FormProps.html#onCut) ?: ClipboardEventHandler;     [onCutCapture](react_router.FormProps.html#onCutCapture) ?: ClipboardEventHandler;     [onDoubleClick](react_router.FormProps.html#onDoubleClick) ?: MouseEventHandler;     [onDoubleClickCapture](react_router.FormProps.html#onDoubleClickCapture) ?: MouseEventHandler;     [onDrag](react_router.FormProps.html#onDrag) ?: DragEventHandler;     [onDragCapture](react_router.FormProps.html#onDragCapture) ?: DragEventHandler;     [onDragEnd](react_router.FormProps.html#onDragEnd) ?: DragEventHandler;     [onDragEndCapture](react_router.FormProps.html#onDragEndCapture) ?: DragEventHandler;     [onDragEnter](react_router.FormProps.html#onDragEnter) ?: DragEventHandler;     [onDragEnterCapture](react_router.FormProps.html#onDragEnterCapture) ?: DragEventHandler;     [onDragExit](react_router.FormProps.html#onDragExit) ?: DragEventHandler;     [onDragExitCapture](react_router.FormProps.html#onDragExitCapture) ?: DragEventHandler;     [onDragLeave](react_router.FormProps.html#onDragLeave) ?: DragEventHandler;     [onDragLeaveCapture](react_router.FormProps.html#onDragLeaveCapture) ?: DragEventHandler;     [onDragOver](react_router.FormProps.html#onDragOver) ?: DragEventHandler;     [onDragOverCapture](react_router.FormProps.html#onDragOverCapture) ?: DragEventHandler;     [onDragStart](react_router.FormProps.html#onDragStart) ?: DragEventHandler;     [onDragStartCapture](react_router.FormProps.html#onDragStartCapture) ?: DragEventHandler;     [onDrop](react_router.FormProps.html#onDrop) ?: DragEventHandler;     [onDropCapture](react_router.FormProps.html#onDropCapture) ?: DragEventHandler;     [onDurationChange](react_router.FormProps.html#onDurationChange) ?: ReactEventHandler;     [onDurationChangeCapture](react_router.FormProps.html#onDurationChangeCapture) ?: ReactEventHandler;     [onEmptied](react_router.FormProps.html#onEmptied) ?: ReactEventHandler;     [onEmptiedCapture](react_router.FormProps.html#onEmptiedCapture) ?: ReactEventHandler;     [onEncrypted](react_router.FormProps.html#onEncrypted) ?: ReactEventHandler;     [onEncryptedCapture](react_router.FormProps.html#onEncryptedCapture) ?: ReactEventHandler;     [onEnded](react_router.FormProps.html#onEnded) ?: ReactEventHandler;     [onEndedCapture](react_router.FormProps.html#onEndedCapture) ?: ReactEventHandler;     [onError](react_router.FormProps.html#onError) ?: ReactEventHandler;     [onErrorCapture](react_router.FormProps.html#onErrorCapture) ?: ReactEventHandler;     [onFocus](react_router.FormProps.html#onFocus) ?: FocusEventHandler;     [onFocusCapture](react_router.FormProps.html#onFocusCapture) ?: FocusEventHandler;     [onGotPointerCapture](react_router.FormProps.html#onGotPointerCapture) ?: PointerEventHandler;     [onGotPointerCaptureCapture](react_router.FormProps.html#onGotPointerCaptureCapture) ?: PointerEventHandler;     [onInput](react_router.FormProps.html#onInput) ?: FormEventHandler;     [onInputCapture](react_router.FormProps.html#onInputCapture) ?: FormEventHandler;     [onInvalid](react_router.FormProps.html#onInvalid) ?: FormEventHandler;     [onInvalidCapture](react_router.FormProps.html#onInvalidCapture) ?: FormEventHandler;     [onKeyDown](react_router.FormProps.html#onKeyDown) ?: KeyboardEventHandler;     [onKeyDownCapture](react_router.FormProps.html#onKeyDownCapture) ?: KeyboardEventHandler;     [onKeyPress](react_router.FormProps.html#onKeyPress) ?: KeyboardEventHandler;     [onKeyPressCapture](react_router.FormProps.html#onKeyPressCapture) ?: KeyboardEventHandler;     [onKeyUp](react_router.FormProps.html#onKeyUp) ?: KeyboardEventHandler;     [onKeyUpCapture](react_router.FormProps.html#onKeyUpCapture) ?: KeyboardEventHandler;     [onLoad](react_router.FormProps.html#onLoad) ?: ReactEventHandler;     [onLoadCapture](react_router.FormProps.html#onLoadCapture) ?: ReactEventHandler;     [onLoadedData](react_router.FormProps.html#onLoadedData) ?: ReactEventHandler;     [onLoadedDataCapture](react_router.FormProps.html#onLoadedDataCapture) ?: ReactEventHandler;     [onLoadedMetadata](react_router.FormProps.html#onLoadedMetadata) ?: ReactEventHandler;     [onLoadedMetadataCapture](react_router.FormProps.html#onLoadedMetadataCapture) ?: ReactEventHandler;     [onLoadStart](react_router.FormProps.html#onLoadStart) ?: ReactEventHandler;     [onLoadStartCapture](react_router.FormProps.html#onLoadStartCapture) ?: ReactEventHandler;     [onLostPointerCapture](react_router.FormProps.html#onLostPointerCapture) ?: PointerEventHandler;     [onLostPointerCaptureCapture](react_router.FormProps.html#onLostPointerCaptureCapture) ?: PointerEventHandler;     [onMouseDown](react_router.FormProps.html#onMouseDown) ?: MouseEventHandler;     [onMouseDownCapture](react_router.FormProps.html#onMouseDownCapture) ?: MouseEventHandler;     [onMouseEnter](react_router.FormProps.html#onMouseEnter) ?: MouseEventHandler;     [onMouseLeave](react_router.FormProps.html#onMouseLeave) ?: MouseEventHandler;     [onMouseMove](react_router.FormProps.html#onMouseMove) ?: MouseEventHandler;     [onMouseMoveCapture](react_router.FormProps.html#onMouseMoveCapture) ?: MouseEventHandler;     [onMouseOut](react_router.FormProps.html#onMouseOut) ?: MouseEventHandler;     [onMouseOutCapture](react_router.FormProps.html#onMouseOutCapture) ?: MouseEventHandler;     [onMouseOver](react_router.FormProps.html#onMouseOver) ?: MouseEventHandler;     [onMouseOverCapture](react_router.FormProps.html#onMouseOverCapture) ?: MouseEventHandler;     [onMouseUp](react_router.FormProps.html#onMouseUp) ?: MouseEventHandler;     [onMouseUpCapture](react_router.FormProps.html#onMouseUpCapture) ?: MouseEventHandler;     [onPaste](react_router.FormProps.html#onPaste) ?: ClipboardEventHandler;     [onPasteCapture](react_router.FormProps.html#onPasteCapture) ?: ClipboardEventHandler;     [onPause](react_router.FormProps.html#onPause) ?: ReactEventHandler;     [onPauseCapture](react_router.FormProps.html#onPauseCapture) ?: ReactEventHandler;     [onPlay](react_router.FormProps.html#onPlay) ?: ReactEventHandler;     [onPlayCapture](react_router.FormProps.html#onPlayCapture) ?: ReactEventHandler;     [onPlaying](react_router.FormProps.html#onPlaying) ?: ReactEventHandler;     [onPlayingCapture](react_router.FormProps.html#onPlayingCapture) ?: ReactEventHandler;     [onPointerCancel](react_router.FormProps.html#onPointerCancel) ?: PointerEventHandler;     [onPointerCancelCapture](react_router.FormProps.html#onPointerCancelCapture) ?: PointerEventHandler;     [onPointerDown](react_router.FormProps.html#onPointerDown) ?: PointerEventHandler;     [onPointerDownCapture](react_router.FormProps.html#onPointerDownCapture) ?: PointerEventHandler;     [onPointerEnter](react_router.FormProps.html#onPointerEnter) ?: PointerEventHandler;     [onPointerEnterCapture](react_router.FormProps.html#onPointerEnterCapture) ?: PointerEventHandler;     [onPointerLeave](react_router.FormProps.html#onPointerLeave) ?: PointerEventHandler;     [onPointerLeaveCapture](react_router.FormProps.html#onPointerLeaveCapture) ?: PointerEventHandler;     [onPointerMove](react_router.FormProps.html#onPointerMove) ?: PointerEventHandler;     [onPointerMoveCapture](react_router.FormProps.html#onPointerMoveCapture) ?: PointerEventHandler;     [onPointerOut](react_router.FormProps.html#onPointerOut) ?: PointerEventHandler;     [onPointerOutCapture](react_router.FormProps.html#onPointerOutCapture) ?: PointerEventHandler;     [onPointerOver](react_router.FormProps.html#onPointerOver) ?: PointerEventHandler;     [onPointerOverCapture](react_router.FormProps.html#onPointerOverCapture) ?: PointerEventHandler;     [onPointerUp](react_router.FormProps.html#onPointerUp) ?: PointerEventHandler;     [onPointerUpCapture](react_router.FormProps.html#onPointerUpCapture) ?: PointerEventHandler;     [onProgress](react_router.FormProps.html#onProgress) ?: ReactEventHandler;     [onProgressCapture](react_router.FormProps.html#onProgressCapture) ?: ReactEventHandler;     [onRateChange](react_router.FormProps.html#onRateChange) ?: ReactEventHandler;     [onRateChangeCapture](react_router.FormProps.html#onRateChangeCapture) ?: ReactEventHandler;     [onReset](react_router.FormProps.html#onReset) ?: FormEventHandler;     [onResetCapture](react_router.FormProps.html#onResetCapture) ?: FormEventHandler;     [onResize](react_router.FormProps.html#onResize) ?: ReactEventHandler;     [onResizeCapture](react_router.FormProps.html#onResizeCapture) ?: ReactEventHandler;     [onScroll](react_router.FormProps.html#onScroll) ?: UIEventHandler;     [onScrollCapture](react_router.FormProps.html#onScrollCapture) ?: UIEventHandler;     [onSeeked](react_router.FormProps.html#onSeeked) ?: ReactEventHandler;     [onSeekedCapture](react_router.FormProps.html#onSeekedCapture) ?: ReactEventHandler;     [onSeeking](react_router.FormProps.html#onSeeking) ?: ReactEventHandler;     [onSeekingCapture](react_router.FormProps.html#onSeekingCapture) ?: ReactEventHandler;     [onSelect](react_router.FormProps.html#onSelect) ?: ReactEventHandler;     [onSelectCapture](react_router.FormProps.html#onSelectCapture) ?: ReactEventHandler;     [onStalled](react_router.FormProps.html#onStalled) ?: ReactEventHandler;     [onStalledCapture](react_router.FormProps.html#onStalledCapture) ?: ReactEventHandler;     [onSubmit](react_router.FormProps.html#onSubmit) ?: FormEventHandler;     [onSubmitCapture](react_router.FormProps.html#onSubmitCapture) ?: FormEventHandler;     [onSuspend](react_router.FormProps.html#onSuspend) ?: ReactEventHandler;     [onSuspendCapture](react_router.FormProps.html#onSuspendCapture) ?: ReactEventHandler;     [onTimeUpdate](react_router.FormProps.html#onTimeUpdate) ?: ReactEventHandler;     [onTimeUpdateCapture](react_router.FormProps.html#onTimeUpdateCapture) ?: ReactEventHandler;     [onTouchCancel](react_router.FormProps.html#onTouchCancel) ?: TouchEventHandler;     [onTouchCancelCapture](react_router.FormProps.html#onTouchCancelCapture) ?: TouchEventHandler;     [onTouchEnd](react_router.FormProps.html#onTouchEnd) ?: TouchEventHandler;     [onTouchEndCapture](react_router.FormProps.html#onTouchEndCapture) ?: TouchEventHandler;     [onTouchMove](react_router.FormProps.html#onTouchMove) ?: TouchEventHandler;     [onTouchMoveCapture](react_router.FormProps.html#onTouchMoveCapture) ?: TouchEventHandler;     [onTouchStart](react_router.FormProps.html#onTouchStart) ?: TouchEventHandler;     [onTouchStartCapture](react_router.FormProps.html#onTouchStartCapture) ?: TouchEventHandler;     [onTransitionEnd](react_router.FormProps.html#onTransitionEnd) ?: TransitionEventHandler;     [onTransitionEndCapture](react_router.FormProps.html#onTransitionEndCapture) ?: TransitionEventHandler;     [onVolumeChange](react_router.FormProps.html#onVolumeChange) ?: ReactEventHandler;     [onVolumeChangeCapture](react_router.FormProps.html#onVolumeChangeCapture) ?: ReactEventHandler;     [onWaiting](react_router.FormProps.html#onWaiting) ?: ReactEventHandler;     [onWaitingCapture](react_router.FormProps.html#onWaitingCapture) ?: ReactEventHandler;     [onWheel](react_router.FormProps.html#onWheel) ?: WheelEventHandler;     [onWheelCapture](react_router.FormProps.html#onWheelCapture) ?: WheelEventHandler;     [placeholder](react_router.FormProps.html#placeholder) ?: string;     [prefix](react_router.FormProps.html#prefix) ?: string;     [preventScrollReset](react_router.FormProps.html#preventScrollReset) ?: boolean;     [property](react_router.FormProps.html#property) ?: string;     [radioGroup](react_router.FormProps.html#radioGroup) ?: string;     [rel](react_router.FormProps.html#rel) ?: string;     [relative](react_router.FormProps.html#relative) ?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) ;     [reloadDocument](react_router.FormProps.html#reloadDocument) ?: boolean;     [replace](react_router.FormProps.html#replace) ?: boolean;     [resource](react_router.FormProps.html#resource) ?: string;     [results](react_router.FormProps.html#results) ?: number;     [rev](react_router.FormProps.html#rev) ?: string;     [role](react_router.FormProps.html#role) ?: AriaRole;     [security](react_router.FormProps.html#security) ?: string;     [slot](react_router.FormProps.html#slot) ?: string;     [spellCheck](react_router.FormProps.html#spellCheck) ?: Booleanish;     [state](react_router.FormProps.html#state) ?: any;     [style](react_router.FormProps.html#style) ?: CSSProperties;     [suppressContentEditableWarning](react_router.FormProps.html#suppressContentEditableWarning) ?: boolean;     [suppressHydrationWarning](react_router.FormProps.html#suppressHydrationWarning) ?: boolean;     [tabIndex](react_router.FormProps.html#tabIndex) ?: number;     [target](react_router.FormProps.html#target) ?: string;     [title](react_router.FormProps.html#title) ?: string;     [translate](react_router.FormProps.html#translate) ?: "yes" | "no";     [typeof](react_router.FormProps.html#typeof) ?: string;     [unselectable](react_router.FormProps.html#unselectable) ?: "on" | "off";     [viewTransition](react_router.FormProps.html#viewTransition) ?: boolean;     [vocab](react_router.FormProps.html#vocab) ?: string; } #### Hierarchy * SharedFormProps * FormProps ##### Index ### Properties [about?](react_router.FormProps.html#about) [acceptCharset?](react_router.FormProps.html#acceptCharset) [accessKey?](react_router.FormProps.html#accessKey) [action?](react_router.FormProps.html#action) [aria-activedescendant?](react_router.FormProps.html#aria_activedescendant) [aria-atomic?](react_router.FormProps.html#aria_atomic) [aria-autocomplete?](react_router.FormProps.html#aria_autocomplete) [aria-braillelabel?](react_router.FormProps.html#aria_braillelabel) [aria-brailleroledescription?](react_router.FormProps.html#aria_brailleroledescription) [aria-busy?](react_router.FormProps.html#aria_busy) [aria-checked?](react_router.FormProps.html#aria_checked) [aria-colcount?](react_router.FormProps.html#aria_colcount) [aria-colindex?](react_router.FormProps.html#aria_colindex) [aria-colindextext?](react_router.FormProps.html#aria_colindextext) [aria-colspan?](react_router.FormProps.html#aria_colspan) [aria-controls?](react_router.FormProps.html#aria_controls) [aria-current?](react_router.FormProps.html#aria_current) [aria-describedby?](react_router.FormProps.html#aria_describedby) [aria-description?](react_router.FormProps.html#aria_description) [aria-details?](react_router.FormProps.html#aria_details) [aria-disabled?](react_router.FormProps.html#aria_disabled) [aria-dropeffect?](react_router.FormProps.html#aria_dropeffect) [aria-errormessage?](react_router.FormProps.html#aria_errormessage) [aria-expanded?](react_router.FormProps.html#aria_expanded) [aria-flowto?](react_router.FormProps.html#aria_flowto) [aria-grabbed?](react_router.FormProps.html#aria_grabbed) [aria-haspopup?](react_router.FormProps.html#aria_haspopup) [aria-hidden?](react_router.FormProps.html#aria_hidden) [aria-invalid?](react_router.FormProps.html#aria_invalid) [aria-keyshortcuts?](react_router.FormProps.html#aria_keyshortcuts) [aria-label?](react_router.FormProps.html#aria_label) [aria-labelledby?](react_router.FormProps.html#aria_labelledby) [aria-level?](react_router.FormProps.html#aria_level) [aria-live?](react_router.FormProps.html#aria_live) [aria-modal?](react_router.FormProps.html#aria_modal) [aria-multiline?](react_router.FormProps.html#aria_multiline) [aria-multiselectable?](react_router.FormProps.html#aria_multiselectable) [aria-orientation?](react_router.FormProps.html#aria_orientation) [aria-owns?](react_router.FormProps.html#aria_owns) [aria-placeholder?](react_router.FormProps.html#aria_placeholder) [aria-posinset?](react_router.FormProps.html#aria_posinset) [aria-pressed?](react_router.FormProps.html#aria_pressed) [aria-readonly?](react_router.FormProps.html#aria_readonly) [aria-relevant?](react_router.FormProps.html#aria_relevant) [aria-required?](react_router.FormProps.html#aria_required) [aria-roledescription?](react_router.FormProps.html#aria_roledescription) [aria-rowcount?](react_router.FormProps.html#aria_rowcount) [aria-rowindex?](react_router.FormProps.html#aria_rowindex) [aria-rowindextext?](react_router.FormProps.html#aria_rowindextext) [aria-rowspan?](react_router.FormProps.html#aria_rowspan) [aria-selected?](react_router.FormProps.html#aria_selected) [aria-setsize?](react_router.FormProps.html#aria_setsize) [aria-sort?](react_router.FormProps.html#aria_sort) [aria-valuemax?](react_router.FormProps.html#aria_valuemax) [aria-valuemin?](react_router.FormProps.html#aria_valuemin) [aria-valuenow?](react_router.FormProps.html#aria_valuenow) [aria-valuetext?](react_router.FormProps.html#aria_valuetext) [autoCapitalize?](react_router.FormProps.html#autoCapitalize) [autoComplete?](react_router.FormProps.html#autoComplete) [autoCorrect?](react_router.FormProps.html#autoCorrect) [autoFocus?](react_router.FormProps.html#autoFocus) [autoSave?](react_router.FormProps.html#autoSave) [children?](react_router.FormProps.html#children) [className?](react_router.FormProps.html#className) [color?](react_router.FormProps.html#color) [content?](react_router.FormProps.html#content) [contentEditable?](react_router.FormProps.html#contentEditable) [contextMenu?](react_router.FormProps.html#contextMenu) [dangerouslySetInnerHTML?](react_router.FormProps.html#dangerouslySetInnerHTML) [datatype?](react_router.FormProps.html#datatype) [defaultChecked?](react_router.FormProps.html#defaultChecked) [defaultValue?](react_router.FormProps.html#defaultValue) [dir?](react_router.FormProps.html#dir) [discover?](react_router.FormProps.html#discover) [draggable?](react_router.FormProps.html#draggable) [encType?](react_router.FormProps.html#encType) [fetcherKey?](react_router.FormProps.html#fetcherKey) [hidden?](react_router.FormProps.html#hidden) [id?](react_router.FormProps.html#id) [inlist?](react_router.FormProps.html#inlist) [inputMode?](react_router.FormProps.html#inputMode) [is?](react_router.FormProps.html#is) [itemID?](react_router.FormProps.html#itemID) [itemProp?](react_router.FormProps.html#itemProp) [itemRef?](react_router.FormProps.html#itemRef) [itemScope?](react_router.FormProps.html#itemScope) [itemType?](react_router.FormProps.html#itemType) [lang?](react_router.FormProps.html#lang) [method?](react_router.FormProps.html#method) [name?](react_router.FormProps.html#name) [navigate?](react_router.FormProps.html#navigate) [nonce?](react_router.FormProps.html#nonce) [noValidate?](react_router.FormProps.html#noValidate) [onAbort?](react_router.FormProps.html#onAbort) [onAbortCapture?](react_router.FormProps.html#onAbortCapture) [onAnimationEnd?](react_router.FormProps.html#onAnimationEnd) [onAnimationEndCapture?](react_router.FormProps.html#onAnimationEndCapture) [onAnimationIteration?](react_router.FormProps.html#onAnimationIteration) [onAnimationIterationCapture?](react_router.FormProps.html#onAnimationIterationCapture) [onAnimationStart?](react_router.FormProps.html#onAnimationStart) [onAnimationStartCapture?](react_router.FormProps.html#onAnimationStartCapture) [onAuxClick?](react_router.FormProps.html#onAuxClick) [onAuxClickCapture?](react_router.FormProps.html#onAuxClickCapture) [onBeforeInput?](react_router.FormProps.html#onBeforeInput) [onBeforeInputCapture?](react_router.FormProps.html#onBeforeInputCapture) [onBlur?](react_router.FormProps.html#onBlur) [onBlurCapture?](react_router.FormProps.html#onBlurCapture) [onCanPlay?](react_router.FormProps.html#onCanPlay) [onCanPlayCapture?](react_router.FormProps.html#onCanPlayCapture) [onCanPlayThrough?](react_router.FormProps.html#onCanPlayThrough) [onCanPlayThroughCapture?](react_router.FormProps.html#onCanPlayThroughCapture) [onChange?](react_router.FormProps.html#onChange) [onChangeCapture?](react_router.FormProps.html#onChangeCapture) [onClick?](react_router.FormProps.html#onClick) [onClickCapture?](react_router.FormProps.html#onClickCapture) [onCompositionEnd?](react_router.FormProps.html#onCompositionEnd) [onCompositionEndCapture?](react_router.FormProps.html#onCompositionEndCapture) [onCompositionStart?](react_router.FormProps.html#onCompositionStart) [onCompositionStartCapture?](react_router.FormProps.html#onCompositionStartCapture) [onCompositionUpdate?](react_router.FormProps.html#onCompositionUpdate) [onCompositionUpdateCapture?](react_router.FormProps.html#onCompositionUpdateCapture) [onContextMenu?](react_router.FormProps.html#onContextMenu) [onContextMenuCapture?](react_router.FormProps.html#onContextMenuCapture) [onCopy?](react_router.FormProps.html#onCopy) [onCopyCapture?](react_router.FormProps.html#onCopyCapture) [onCut?](react_router.FormProps.html#onCut) [onCutCapture?](react_router.FormProps.html#onCutCapture) [onDoubleClick?](react_router.FormProps.html#onDoubleClick) [onDoubleClickCapture?](react_router.FormProps.html#onDoubleClickCapture) [onDrag?](react_router.FormProps.html#onDrag) [onDragCapture?](react_router.FormProps.html#onDragCapture) [onDragEnd?](react_router.FormProps.html#onDragEnd) [onDragEndCapture?](react_router.FormProps.html#onDragEndCapture) [onDragEnter?](react_router.FormProps.html#onDragEnter) [onDragEnterCapture?](react_router.FormProps.html#onDragEnterCapture) [onDragExit?](react_router.FormProps.html#onDragExit) [onDragExitCapture?](react_router.FormProps.html#onDragExitCapture) [onDragLeave?](react_router.FormProps.html#onDragLeave) [onDragLeaveCapture?](react_router.FormProps.html#onDragLeaveCapture) [onDragOver?](react_router.FormProps.html#onDragOver) [onDragOverCapture?](react_router.FormProps.html#onDragOverCapture) [onDragStart?](react_router.FormProps.html#onDragStart) [onDragStartCapture?](react_router.FormProps.html#onDragStartCapture) [onDrop?](react_router.FormProps.html#onDrop) [onDropCapture?](react_router.FormProps.html#onDropCapture) [onDurationChange?](react_router.FormProps.html#onDurationChange) [onDurationChangeCapture?](react_router.FormProps.html#onDurationChangeCapture) [onEmptied?](react_router.FormProps.html#onEmptied) [onEmptiedCapture?](react_router.FormProps.html#onEmptiedCapture) [onEncrypted?](react_router.FormProps.html#onEncrypted) [onEncryptedCapture?](react_router.FormProps.html#onEncryptedCapture) [onEnded?](react_router.FormProps.html#onEnded) [onEndedCapture?](react_router.FormProps.html#onEndedCapture) [onError?](react_router.FormProps.html#onError) [onErrorCapture?](react_router.FormProps.html#onErrorCapture) [onFocus?](react_router.FormProps.html#onFocus) [onFocusCapture?](react_router.FormProps.html#onFocusCapture) [onGotPointerCapture?](react_router.FormProps.html#onGotPointerCapture) [onGotPointerCaptureCapture?](react_router.FormProps.html#onGotPointerCaptureCapture) [onInput?](react_router.FormProps.html#onInput) [onInputCapture?](react_router.FormProps.html#onInputCapture) [onInvalid?](react_router.FormProps.html#onInvalid) [onInvalidCapture?](react_router.FormProps.html#onInvalidCapture) [onKeyDown?](react_router.FormProps.html#onKeyDown) [onKeyDownCapture?](react_router.FormProps.html#onKeyDownCapture) [onKeyPress?](react_router.FormProps.html#onKeyPress) [onKeyPressCapture?](react_router.FormProps.html#onKeyPressCapture) [onKeyUp?](react_router.FormProps.html#onKeyUp) [onKeyUpCapture?](react_router.FormProps.html#onKeyUpCapture) [onLoad?](react_router.FormProps.html#onLoad) [onLoadCapture?](react_router.FormProps.html#onLoadCapture) [onLoadedData?](react_router.FormProps.html#onLoadedData) [onLoadedDataCapture?](react_router.FormProps.html#onLoadedDataCapture) [onLoadedMetadata?](react_router.FormProps.html#onLoadedMetadata) [onLoadedMetadataCapture?](react_router.FormProps.html#onLoadedMetadataCapture) [onLoadStart?](react_router.FormProps.html#onLoadStart) [onLoadStartCapture?](react_router.FormProps.html#onLoadStartCapture) [onLostPointerCapture?](react_router.FormProps.html#onLostPointerCapture) [onLostPointerCaptureCapture?](react_router.FormProps.html#onLostPointerCaptureCapture) [onMouseDown?](react_router.FormProps.html#onMouseDown) [onMouseDownCapture?](react_router.FormProps.html#onMouseDownCapture) [onMouseEnter?](react_router.FormProps.html#onMouseEnter) [onMouseLeave?](react_router.FormProps.html#onMouseLeave) [onMouseMove?](react_router.FormProps.html#onMouseMove) [onMouseMoveCapture?](react_router.FormProps.html#onMouseMoveCapture) [onMouseOut?](react_router.FormProps.html#onMouseOut) [onMouseOutCapture?](react_router.FormProps.html#onMouseOutCapture) [onMouseOver?](react_router.FormProps.html#onMouseOver) [onMouseOverCapture?](react_router.FormProps.html#onMouseOverCapture) [onMouseUp?](react_router.FormProps.html#onMouseUp) [onMouseUpCapture?](react_router.FormProps.html#onMouseUpCapture) [onPaste?](react_router.FormProps.html#onPaste) [onPasteCapture?](react_router.FormProps.html#onPasteCapture) [onPause?](react_router.FormProps.html#onPause) [onPauseCapture?](react_router.FormProps.html#onPauseCapture) [onPlay?](react_router.FormProps.html#onPlay) [onPlayCapture?](react_router.FormProps.html#onPlayCapture) [onPlaying?](react_router.FormProps.html#onPlaying) [onPlayingCapture?](react_router.FormProps.html#onPlayingCapture) [onPointerCancel?](react_router.FormProps.html#onPointerCancel) [onPointerCancelCapture?](react_router.FormProps.html#onPointerCancelCapture) [onPointerDown?](react_router.FormProps.html#onPointerDown) [onPointerDownCapture?](react_router.FormProps.html#onPointerDownCapture) [onPointerEnter?](react_router.FormProps.html#onPointerEnter) [onPointerEnterCapture?](react_router.FormProps.html#onPointerEnterCapture) [onPointerLeave?](react_router.FormProps.html#onPointerLeave) [onPointerLeaveCapture?](react_router.FormProps.html#onPointerLeaveCapture) [onPointerMove?](react_router.FormProps.html#onPointerMove) [onPointerMoveCapture?](react_router.FormProps.html#onPointerMoveCapture) [onPointerOut?](react_router.FormProps.html#onPointerOut) [onPointerOutCapture?](react_router.FormProps.html#onPointerOutCapture) [onPointerOver?](react_router.FormProps.html#onPointerOver) [onPointerOverCapture?](react_router.FormProps.html#onPointerOverCapture) [onPointerUp?](react_router.FormProps.html#onPointerUp) [onPointerUpCapture?](react_router.FormProps.html#onPointerUpCapture) [onProgress?](react_router.FormProps.html#onProgress) [onProgressCapture?](react_router.FormProps.html#onProgressCapture) [onRateChange?](react_router.FormProps.html#onRateChange) [onRateChangeCapture?](react_router.FormProps.html#onRateChangeCapture) [onReset?](react_router.FormProps.html#onReset) [onResetCapture?](react_router.FormProps.html#onResetCapture) [onResize?](react_router.FormProps.html#onResize) [onResizeCapture?](react_router.FormProps.html#onResizeCapture) [onScroll?](react_router.FormProps.html#onScroll) [onScrollCapture?](react_router.FormProps.html#onScrollCapture) [onSeeked?](react_router.FormProps.html#onSeeked) [onSeekedCapture?](react_router.FormProps.html#onSeekedCapture) [onSeeking?](react_router.FormProps.html#onSeeking) [onSeekingCapture?](react_router.FormProps.html#onSeekingCapture) [onSelect?](react_router.FormProps.html#onSelect) [onSelectCapture?](react_router.FormProps.html#onSelectCapture) [onStalled?](react_router.FormProps.html#onStalled) [onStalledCapture?](react_router.FormProps.html#onStalledCapture) [onSubmit?](react_router.FormProps.html#onSubmit) [onSubmitCapture?](react_router.FormProps.html#onSubmitCapture) [onSuspend?](react_router.FormProps.html#onSuspend) [onSuspendCapture?](react_router.FormProps.html#onSuspendCapture) [onTimeUpdate?](react_router.FormProps.html#onTimeUpdate) [onTimeUpdateCapture?](react_router.FormProps.html#onTimeUpdateCapture) [onTouchCancel?](react_router.FormProps.html#onTouchCancel) [onTouchCancelCapture?](react_router.FormProps.html#onTouchCancelCapture) [onTouchEnd?](react_router.FormProps.html#onTouchEnd) [onTouchEndCapture?](react_router.FormProps.html#onTouchEndCapture) [onTouchMove?](react_router.FormProps.html#onTouchMove) [onTouchMoveCapture?](react_router.FormProps.html#onTouchMoveCapture) [onTouchStart?](react_router.FormProps.html#onTouchStart) [onTouchStartCapture?](react_router.FormProps.html#onTouchStartCapture) [onTransitionEnd?](react_router.FormProps.html#onTransitionEnd) [onTransitionEndCapture?](react_router.FormProps.html#onTransitionEndCapture) [onVolumeChange?](react_router.FormProps.html#onVolumeChange) [onVolumeChangeCapture?](react_router.FormProps.html#onVolumeChangeCapture) [onWaiting?](react_router.FormProps.html#onWaiting) [onWaitingCapture?](react_router.FormProps.html#onWaitingCapture) [onWheel?](react_router.FormProps.html#onWheel) [onWheelCapture?](react_router.FormProps.html#onWheelCapture) [placeholder?](react_router.FormProps.html#placeholder) [prefix?](react_router.FormProps.html#prefix) [preventScrollReset?](react_router.FormProps.html#preventScrollReset) [property?](react_router.FormProps.html#property) [radioGroup?](react_router.FormProps.html#radioGroup) [rel?](react_router.FormProps.html#rel) [relative?](react_router.FormProps.html#relative) [reloadDocument?](react_router.FormProps.html#reloadDocument) [replace?](react_router.FormProps.html#replace) [resource?](react_router.FormProps.html#resource) [results?](react_router.FormProps.html#results) [rev?](react_router.FormProps.html#rev) [role?](react_router.FormProps.html#role) [security?](react_router.FormProps.html#security) [slot?](react_router.FormProps.html#slot) [spellCheck?](react_router.FormProps.html#spellCheck) [state?](react_router.FormProps.html#state) [style?](react_router.FormProps.html#style) [suppressContentEditableWarning?](react_router.FormProps.html#suppressContentEditableWarning) [suppressHydrationWarning?](react_router.FormProps.html#suppressHydrationWarning) [tabIndex?](react_router.FormProps.html#tabIndex) [target?](react_router.FormProps.html#target) [title?](react_router.FormProps.html#title) [translate?](react_router.FormProps.html#translate) [typeof?](react_router.FormProps.html#typeof) [unselectable?](react_router.FormProps.html#unselectable) [viewTransition?](react_router.FormProps.html#viewTransition) [vocab?](react_router.FormProps.html#vocab) Properties ---------- ### `Optional`about[](#about) about?: string ### `Optional`acceptCharset[](#acceptCharset) acceptCharset?: string ### `Optional`accessKey[](#accessKey) accessKey?: string ### `Optional`action[](#action) action?: string The URL to submit the form data to. If `undefined`, this defaults to the closest route in context. ### `Optional`aria-activedescendant[](#aria_activedescendant) aria-activedescendant?: string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. ### `Optional`aria-atomic[](#aria_atomic) aria-atomic?: Booleanish Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. ### `Optional`aria-autocomplete[](#aria_autocomplete) aria-autocomplete?:     | "none"     | "list"     | "inline"     | "both" Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. ### `Optional`aria-braillelabel[](#aria_braillelabel) aria-braillelabel?: string Defines a string value that labels the current element, which is intended to be converted into Braille. #### See[](#See) aria-label. ### `Optional`aria-brailleroledescription[](#aria_brailleroledescription) aria-brailleroledescription?: string Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. #### See[](#See-1) aria-roledescription. ### `Optional`aria-busy[](#aria_busy) aria-busy?: Booleanish ### `Optional`aria-checked[](#aria_checked) aria-checked?:     | boolean     | "true"     | "false"     | "mixed" Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. #### See[](#See-2) * aria-pressed * aria-selected. ### `Optional`aria-colcount[](#aria_colcount) aria-colcount?: number Defines the total number of columns in a table, grid, or treegrid. #### See[](#See-3) aria-colindex. ### `Optional`aria-colindex[](#aria_colindex) aria-colindex?: number Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. #### See[](#See-4) * aria-colcount * aria-colspan. ### `Optional`aria-colindextext[](#aria_colindextext) aria-colindextext?: string Defines a human readable text alternative of aria-colindex. #### See[](#See-5) aria-rowindextext. ### `Optional`aria-colspan[](#aria_colspan) aria-colspan?: number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. #### See[](#See-6) * aria-colindex * aria-rowspan. ### `Optional`aria-controls[](#aria_controls) aria-controls?: string Identifies the element (or elements) whose contents or presence are controlled by the current element. #### See[](#See-7) aria-owns. ### `Optional`aria-current[](#aria_current) aria-current?:     | boolean     | "time"     | "true"     | "location"     | "page"     | "step"     | "false"     | "date" Indicates the element that represents the current item within a container or set of related elements. ### `Optional`aria-describedby[](#aria_describedby) aria-describedby?: string Identifies the element (or elements) that describes the object. #### See[](#See-8) aria-labelledby ### `Optional`aria-description[](#aria_description) aria-description?: string Defines a string value that describes or annotates the current element. #### See[](#See-9) related aria-describedby. ### `Optional`aria-details[](#aria_details) aria-details?: string Identifies the element that provides a detailed, extended description for the object. #### See[](#See-10) aria-describedby. ### `Optional`aria-disabled[](#aria_disabled) aria-disabled?: Booleanish Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. #### See[](#See-11) * aria-hidden * aria-readonly. ### `Optional`aria-dropeffect[](#aria_dropeffect) aria-dropeffect?:     | "link"     | "copy"     | "none"     | "execute"     | "move"     | "popup" Indicates what functions can be performed when a dragged object is released on the drop target. #### Deprecated[](#Deprecated) in ARIA 1.1 ### `Optional`aria-errormessage[](#aria_errormessage) aria-errormessage?: string Identifies the element that provides an error message for the object. #### See[](#See-12) * aria-invalid * aria-describedby. ### `Optional`aria-expanded[](#aria_expanded) aria-expanded?: Booleanish Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. ### `Optional`aria-flowto[](#aria_flowto) aria-flowto?: string Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. ### `Optional`aria-grabbed[](#aria_grabbed) aria-grabbed?: Booleanish Indicates an element's "grabbed" state in a drag-and-drop operation. #### Deprecated[](#Deprecated-1) in ARIA 1.1 ### `Optional`aria-haspopup[](#aria_haspopup) aria-haspopup?:     | boolean     | "dialog"     | "menu"     | "true"     | "false"     | "grid"     | "listbox"     | "tree" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. ### `Optional`aria-hidden[](#aria_hidden) aria-hidden?: Booleanish Indicates whether the element is exposed to an accessibility API. #### See[](#See-13) aria-disabled. ### `Optional`aria-invalid[](#aria_invalid) aria-invalid?:     | boolean     | "true"     | "false"     | "grammar"     | "spelling" Indicates the entered value does not conform to the format expected by the application. #### See[](#See-14) aria-errormessage. ### `Optional`aria-keyshortcuts[](#aria_keyshortcuts) aria-keyshortcuts?: string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. ### `Optional`aria-label[](#aria_label) aria-label?: string Defines a string value that labels the current element. #### See[](#See-15) aria-labelledby. ### `Optional`aria-labelledby[](#aria_labelledby) aria-labelledby?: string Identifies the element (or elements) that labels the current element. #### See[](#See-16) aria-describedby. ### `Optional`aria-level[](#aria_level) aria-level?: number Defines the hierarchical level of an element within a structure. ### `Optional`aria-live[](#aria_live) aria-live?: "off" | "assertive" | "polite" Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. ### `Optional`aria-modal[](#aria_modal) aria-modal?: Booleanish Indicates whether an element is modal when displayed. ### `Optional`aria-multiline[](#aria_multiline) aria-multiline?: Booleanish Indicates whether a text box accepts multiple lines of input or only a single line. ### `Optional`aria-multiselectable[](#aria_multiselectable) aria-multiselectable?: Booleanish Indicates that the user may select more than one item from the current selectable descendants. ### `Optional`aria-orientation[](#aria_orientation) aria-orientation?: "horizontal" | "vertical" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. ### `Optional`aria-owns[](#aria_owns) aria-owns?: string Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. #### See[](#See-17) aria-controls. ### `Optional`aria-placeholder[](#aria_placeholder) aria-placeholder?: string Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. ### `Optional`aria-posinset[](#aria_posinset) aria-posinset?: number Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. #### See[](#See-18) aria-setsize. ### `Optional`aria-pressed[](#aria_pressed) aria-pressed?:     | boolean     | "true"     | "false"     | "mixed" Indicates the current "pressed" state of toggle buttons. #### See[](#See-19) * aria-checked * aria-selected. ### `Optional`aria-readonly[](#aria_readonly) aria-readonly?: Booleanish Indicates that the element is not editable, but is otherwise operable. #### See[](#See-20) aria-disabled. ### `Optional`aria-relevant[](#aria_relevant) aria-relevant?:     | "text"     | "additions"     | "additions removals"     | "additions text"     | "all"     | "removals"     | "removals additions"     | "removals text"     | "text additions"     | "text removals" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. #### See[](#See-21) aria-atomic. ### `Optional`aria-required[](#aria_required) aria-required?: Booleanish Indicates that user input is required on the element before a form may be submitted. ### `Optional`aria-roledescription[](#aria_roledescription) aria-roledescription?: string Defines a human-readable, author-localized description for the role of an element. ### `Optional`aria-rowcount[](#aria_rowcount) aria-rowcount?: number Defines the total number of rows in a table, grid, or treegrid. #### See[](#See-22) aria-rowindex. ### `Optional`aria-rowindex[](#aria_rowindex) aria-rowindex?: number Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. #### See[](#See-23) * aria-rowcount * aria-rowspan. ### `Optional`aria-rowindextext[](#aria_rowindextext) aria-rowindextext?: string Defines a human readable text alternative of aria-rowindex. #### See[](#See-24) aria-colindextext. ### `Optional`aria-rowspan[](#aria_rowspan) aria-rowspan?: number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. #### See[](#See-25) * aria-rowindex * aria-colspan. ### `Optional`aria-selected[](#aria_selected) aria-selected?: Booleanish Indicates the current "selected" state of various widgets. #### See[](#See-26) * aria-checked * aria-pressed. ### `Optional`aria-setsize[](#aria_setsize) aria-setsize?: number Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. #### See[](#See-27) aria-posinset. ### `Optional`aria-sort[](#aria_sort) aria-sort?:     | "none"     | "ascending"     | "descending"     | "other" Indicates if items in a table or grid are sorted in ascending or descending order. ### `Optional`aria-valuemax[](#aria_valuemax) aria-valuemax?: number Defines the maximum allowed value for a range widget. ### `Optional`aria-valuemin[](#aria_valuemin) aria-valuemin?: number Defines the minimum allowed value for a range widget. ### `Optional`aria-valuenow[](#aria_valuenow) aria-valuenow?: number Defines the current value for a range widget. #### See[](#See-28) aria-valuetext. ### `Optional`aria-valuetext[](#aria_valuetext) aria-valuetext?: string Defines the human readable text alternative of aria-valuenow for a range widget. ### `Optional`autoCapitalize[](#autoCapitalize) autoCapitalize?: string ### `Optional`autoComplete[](#autoComplete) autoComplete?: string ### `Optional`autoCorrect[](#autoCorrect) autoCorrect?: string ### `Optional`autoFocus[](#autoFocus) autoFocus?: boolean ### `Optional`autoSave[](#autoSave) autoSave?: string ### `Optional`children[](#children) children?: ReactNode ### `Optional`className[](#className) className?: string ### `Optional`color[](#color) color?: string ### `Optional`content[](#content) content?: string ### `Optional`contentEditable[](#contentEditable) contentEditable?: Booleanish | "inherit" ### `Optional`contextMenu[](#contextMenu) contextMenu?: string ### `Optional`dangerouslySetInnerHTML[](#dangerouslySetInnerHTML) dangerouslySetInnerHTML?: {     \_\_html: string | TrustedHTML; } ### `Optional`datatype[](#datatype) datatype?: string ### `Optional`defaultChecked[](#defaultChecked) defaultChecked?: boolean ### `Optional`defaultValue[](#defaultValue) defaultValue?: string | number | readonly string\[\] ### `Optional`dir[](#dir) dir?: string ### `Optional`discover[](#discover) discover?: DiscoverBehavior ### `Optional`draggable[](#draggable) draggable?: Booleanish ### `Optional`encType[](#encType) encType?: "application/x-www-form-urlencoded" | "multipart/form-data" | "text/plain" The encoding type to use for the form submission. ### `Optional`fetcherKey[](#fetcherKey) fetcherKey?: string Indicates a specific fetcherKey to use when using `navigate={false}` so you can pick up the fetcher's state in a different component in a [useFetcher](../functions/react_router.useFetcher.html) . ### `Optional`hidden[](#hidden) hidden?: boolean ### `Optional`id[](#id) id?: string ### `Optional`inlist[](#inlist) inlist?: any ### `Optional`inputMode[](#inputMode) inputMode?:     | "search"     | "text"     | "url"     | "none"     | "tel"     | "email"     | "numeric"     | "decimal" Hints at the type of data that might be entered by the user while editing the element or its contents #### See[](#See-29) [https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute) ### `Optional`is[](#is) is?: string Specify that a standard HTML element should behave like a defined custom built-in element #### See[](#See-30) [https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is) ### `Optional`itemID[](#itemID) itemID?: string ### `Optional`itemProp[](#itemProp) itemProp?: string ### `Optional`itemRef[](#itemRef) itemRef?: string ### `Optional`itemScope[](#itemScope) itemScope?: boolean ### `Optional`itemType[](#itemType) itemType?: string ### `Optional`lang[](#lang) lang?: string ### `Optional`method[](#method) method?: [HTMLFormMethod](../types/react_router.HTMLFormMethod.html) The HTTP verb to use when the form is submitted. Supports "get", "post", "put", "delete", and "patch". Native `` only supports `get` and `post`, avoid the other verbs if you'd like to support progressive enhancement ### `Optional`name[](#name) name?: string ### `Optional`navigate[](#navigate) navigate?: boolean Skips the navigation and uses a [fetcher](../functions/react_router.useFetcher.html) internally when `false`. This is essentially a shorthand for `useFetcher()` + `` where you don't care about the resulting data in this component. ### `Optional`nonce[](#nonce) nonce?: string ### `Optional`noValidate[](#noValidate) noValidate?: boolean ### `Optional`onAbort[](#onAbort) onAbort?: ReactEventHandler ### `Optional`onAbortCapture[](#onAbortCapture) onAbortCapture?: ReactEventHandler ### `Optional`onAnimationEnd[](#onAnimationEnd) onAnimationEnd?: AnimationEventHandler ### `Optional`onAnimationEndCapture[](#onAnimationEndCapture) onAnimationEndCapture?: AnimationEventHandler ### `Optional`onAnimationIteration[](#onAnimationIteration) onAnimationIteration?: AnimationEventHandler ### `Optional`onAnimationIterationCapture[](#onAnimationIterationCapture) onAnimationIterationCapture?: AnimationEventHandler ### `Optional`onAnimationStart[](#onAnimationStart) onAnimationStart?: AnimationEventHandler ### `Optional`onAnimationStartCapture[](#onAnimationStartCapture) onAnimationStartCapture?: AnimationEventHandler ### `Optional`onAuxClick[](#onAuxClick) onAuxClick?: MouseEventHandler ### `Optional`onAuxClickCapture[](#onAuxClickCapture) onAuxClickCapture?: MouseEventHandler ### `Optional`onBeforeInput[](#onBeforeInput) onBeforeInput?: FormEventHandler ### `Optional`onBeforeInputCapture[](#onBeforeInputCapture) onBeforeInputCapture?: FormEventHandler ### `Optional`onBlur[](#onBlur) onBlur?: FocusEventHandler ### `Optional`onBlurCapture[](#onBlurCapture) onBlurCapture?: FocusEventHandler ### `Optional`onCanPlay[](#onCanPlay) onCanPlay?: ReactEventHandler ### `Optional`onCanPlayCapture[](#onCanPlayCapture) onCanPlayCapture?: ReactEventHandler ### `Optional`onCanPlayThrough[](#onCanPlayThrough) onCanPlayThrough?: ReactEventHandler ### `Optional`onCanPlayThroughCapture[](#onCanPlayThroughCapture) onCanPlayThroughCapture?: ReactEventHandler ### `Optional`onChange[](#onChange) onChange?: FormEventHandler ### `Optional`onChangeCapture[](#onChangeCapture) onChangeCapture?: FormEventHandler ### `Optional`onClick[](#onClick) onClick?: MouseEventHandler ### `Optional`onClickCapture[](#onClickCapture) onClickCapture?: MouseEventHandler ### `Optional`onCompositionEnd[](#onCompositionEnd) onCompositionEnd?: CompositionEventHandler ### `Optional`onCompositionEndCapture[](#onCompositionEndCapture) onCompositionEndCapture?: CompositionEventHandler ### `Optional`onCompositionStart[](#onCompositionStart) onCompositionStart?: CompositionEventHandler ### `Optional`onCompositionStartCapture[](#onCompositionStartCapture) onCompositionStartCapture?: CompositionEventHandler ### `Optional`onCompositionUpdate[](#onCompositionUpdate) onCompositionUpdate?: CompositionEventHandler ### `Optional`onCompositionUpdateCapture[](#onCompositionUpdateCapture) onCompositionUpdateCapture?: CompositionEventHandler ### `Optional`onContextMenu[](#onContextMenu) onContextMenu?: MouseEventHandler ### `Optional`onContextMenuCapture[](#onContextMenuCapture) onContextMenuCapture?: MouseEventHandler ### `Optional`onCopy[](#onCopy) onCopy?: ClipboardEventHandler ### `Optional`onCopyCapture[](#onCopyCapture) onCopyCapture?: ClipboardEventHandler ### `Optional`onCut[](#onCut) onCut?: ClipboardEventHandler ### `Optional`onCutCapture[](#onCutCapture) onCutCapture?: ClipboardEventHandler ### `Optional`onDoubleClick[](#onDoubleClick) onDoubleClick?: MouseEventHandler ### `Optional`onDoubleClickCapture[](#onDoubleClickCapture) onDoubleClickCapture?: MouseEventHandler ### `Optional`onDrag[](#onDrag) onDrag?: DragEventHandler ### `Optional`onDragCapture[](#onDragCapture) onDragCapture?: DragEventHandler ### `Optional`onDragEnd[](#onDragEnd) onDragEnd?: DragEventHandler ### `Optional`onDragEndCapture[](#onDragEndCapture) onDragEndCapture?: DragEventHandler ### `Optional`onDragEnter[](#onDragEnter) onDragEnter?: DragEventHandler ### `Optional`onDragEnterCapture[](#onDragEnterCapture) onDragEnterCapture?: DragEventHandler ### `Optional`onDragExit[](#onDragExit) onDragExit?: DragEventHandler ### `Optional`onDragExitCapture[](#onDragExitCapture) onDragExitCapture?: DragEventHandler ### `Optional`onDragLeave[](#onDragLeave) onDragLeave?: DragEventHandler ### `Optional`onDragLeaveCapture[](#onDragLeaveCapture) onDragLeaveCapture?: DragEventHandler ### `Optional`onDragOver[](#onDragOver) onDragOver?: DragEventHandler ### `Optional`onDragOverCapture[](#onDragOverCapture) onDragOverCapture?: DragEventHandler ### `Optional`onDragStart[](#onDragStart) onDragStart?: DragEventHandler ### `Optional`onDragStartCapture[](#onDragStartCapture) onDragStartCapture?: DragEventHandler ### `Optional`onDrop[](#onDrop) onDrop?: DragEventHandler ### `Optional`onDropCapture[](#onDropCapture) onDropCapture?: DragEventHandler ### `Optional`onDurationChange[](#onDurationChange) onDurationChange?: ReactEventHandler ### `Optional`onDurationChangeCapture[](#onDurationChangeCapture) onDurationChangeCapture?: ReactEventHandler ### `Optional`onEmptied[](#onEmptied) onEmptied?: ReactEventHandler ### `Optional`onEmptiedCapture[](#onEmptiedCapture) onEmptiedCapture?: ReactEventHandler ### `Optional`onEncrypted[](#onEncrypted) onEncrypted?: ReactEventHandler ### `Optional`onEncryptedCapture[](#onEncryptedCapture) onEncryptedCapture?: ReactEventHandler ### `Optional`onEnded[](#onEnded) onEnded?: ReactEventHandler ### `Optional`onEndedCapture[](#onEndedCapture) onEndedCapture?: ReactEventHandler ### `Optional`onError[](#onError) onError?: ReactEventHandler ### `Optional`onErrorCapture[](#onErrorCapture) onErrorCapture?: ReactEventHandler ### `Optional`onFocus[](#onFocus) onFocus?: FocusEventHandler ### `Optional`onFocusCapture[](#onFocusCapture) onFocusCapture?: FocusEventHandler ### `Optional`onGotPointerCapture[](#onGotPointerCapture) onGotPointerCapture?: PointerEventHandler ### `Optional`onGotPointerCaptureCapture[](#onGotPointerCaptureCapture) onGotPointerCaptureCapture?: PointerEventHandler ### `Optional`onInput[](#onInput) onInput?: FormEventHandler ### `Optional`onInputCapture[](#onInputCapture) onInputCapture?: FormEventHandler ### `Optional`onInvalid[](#onInvalid) onInvalid?: FormEventHandler ### `Optional`onInvalidCapture[](#onInvalidCapture) onInvalidCapture?: FormEventHandler ### `Optional`onKeyDown[](#onKeyDown) onKeyDown?: KeyboardEventHandler ### `Optional`onKeyDownCapture[](#onKeyDownCapture) onKeyDownCapture?: KeyboardEventHandler ### `Optional`onKeyPress[](#onKeyPress) onKeyPress?: KeyboardEventHandler #### Deprecated[](#Deprecated-2) ### `Optional`onKeyPressCapture[](#onKeyPressCapture) onKeyPressCapture?: KeyboardEventHandler #### Deprecated[](#Deprecated-3) ### `Optional`onKeyUp[](#onKeyUp) onKeyUp?: KeyboardEventHandler ### `Optional`onKeyUpCapture[](#onKeyUpCapture) onKeyUpCapture?: KeyboardEventHandler ### `Optional`onLoad[](#onLoad) onLoad?: ReactEventHandler ### `Optional`onLoadCapture[](#onLoadCapture) onLoadCapture?: ReactEventHandler ### `Optional`onLoadedData[](#onLoadedData) onLoadedData?: ReactEventHandler ### `Optional`onLoadedDataCapture[](#onLoadedDataCapture) onLoadedDataCapture?: ReactEventHandler ### `Optional`onLoadedMetadata[](#onLoadedMetadata) onLoadedMetadata?: ReactEventHandler ### `Optional`onLoadedMetadataCapture[](#onLoadedMetadataCapture) onLoadedMetadataCapture?: ReactEventHandler ### `Optional`onLoadStart[](#onLoadStart) onLoadStart?: ReactEventHandler ### `Optional`onLoadStartCapture[](#onLoadStartCapture) onLoadStartCapture?: ReactEventHandler ### `Optional`onLostPointerCapture[](#onLostPointerCapture) onLostPointerCapture?: PointerEventHandler ### `Optional`onLostPointerCaptureCapture[](#onLostPointerCaptureCapture) onLostPointerCaptureCapture?: PointerEventHandler ### `Optional`onMouseDown[](#onMouseDown) onMouseDown?: MouseEventHandler ### `Optional`onMouseDownCapture[](#onMouseDownCapture) onMouseDownCapture?: MouseEventHandler ### `Optional`onMouseEnter[](#onMouseEnter) onMouseEnter?: MouseEventHandler ### `Optional`onMouseLeave[](#onMouseLeave) onMouseLeave?: MouseEventHandler ### `Optional`onMouseMove[](#onMouseMove) onMouseMove?: MouseEventHandler ### `Optional`onMouseMoveCapture[](#onMouseMoveCapture) onMouseMoveCapture?: MouseEventHandler ### `Optional`onMouseOut[](#onMouseOut) onMouseOut?: MouseEventHandler ### `Optional`onMouseOutCapture[](#onMouseOutCapture) onMouseOutCapture?: MouseEventHandler ### `Optional`onMouseOver[](#onMouseOver) onMouseOver?: MouseEventHandler ### `Optional`onMouseOverCapture[](#onMouseOverCapture) onMouseOverCapture?: MouseEventHandler ### `Optional`onMouseUp[](#onMouseUp) onMouseUp?: MouseEventHandler ### `Optional`onMouseUpCapture[](#onMouseUpCapture) onMouseUpCapture?: MouseEventHandler ### `Optional`onPaste[](#onPaste) onPaste?: ClipboardEventHandler ### `Optional`onPasteCapture[](#onPasteCapture) onPasteCapture?: ClipboardEventHandler ### `Optional`onPause[](#onPause) onPause?: ReactEventHandler ### `Optional`onPauseCapture[](#onPauseCapture) onPauseCapture?: ReactEventHandler ### `Optional`onPlay[](#onPlay) onPlay?: ReactEventHandler ### `Optional`onPlayCapture[](#onPlayCapture) onPlayCapture?: ReactEventHandler ### `Optional`onPlaying[](#onPlaying) onPlaying?: ReactEventHandler ### `Optional`onPlayingCapture[](#onPlayingCapture) onPlayingCapture?: ReactEventHandler ### `Optional`onPointerCancel[](#onPointerCancel) onPointerCancel?: PointerEventHandler ### `Optional`onPointerCancelCapture[](#onPointerCancelCapture) onPointerCancelCapture?: PointerEventHandler ### `Optional`onPointerDown[](#onPointerDown) onPointerDown?: PointerEventHandler ### `Optional`onPointerDownCapture[](#onPointerDownCapture) onPointerDownCapture?: PointerEventHandler ### `Optional`onPointerEnter[](#onPointerEnter) onPointerEnter?: PointerEventHandler ### `Optional`onPointerEnterCapture[](#onPointerEnterCapture) onPointerEnterCapture?: PointerEventHandler ### `Optional`onPointerLeave[](#onPointerLeave) onPointerLeave?: PointerEventHandler ### `Optional`onPointerLeaveCapture[](#onPointerLeaveCapture) onPointerLeaveCapture?: PointerEventHandler ### `Optional`onPointerMove[](#onPointerMove) onPointerMove?: PointerEventHandler ### `Optional`onPointerMoveCapture[](#onPointerMoveCapture) onPointerMoveCapture?: PointerEventHandler ### `Optional`onPointerOut[](#onPointerOut) onPointerOut?: PointerEventHandler ### `Optional`onPointerOutCapture[](#onPointerOutCapture) onPointerOutCapture?: PointerEventHandler ### `Optional`onPointerOver[](#onPointerOver) onPointerOver?: PointerEventHandler ### `Optional`onPointerOverCapture[](#onPointerOverCapture) onPointerOverCapture?: PointerEventHandler ### `Optional`onPointerUp[](#onPointerUp) onPointerUp?: PointerEventHandler ### `Optional`onPointerUpCapture[](#onPointerUpCapture) onPointerUpCapture?: PointerEventHandler ### `Optional`onProgress[](#onProgress) onProgress?: ReactEventHandler ### `Optional`onProgressCapture[](#onProgressCapture) onProgressCapture?: ReactEventHandler ### `Optional`onRateChange[](#onRateChange) onRateChange?: ReactEventHandler ### `Optional`onRateChangeCapture[](#onRateChangeCapture) onRateChangeCapture?: ReactEventHandler ### `Optional`onReset[](#onReset) onReset?: FormEventHandler ### `Optional`onResetCapture[](#onResetCapture) onResetCapture?: FormEventHandler ### `Optional`onResize[](#onResize) onResize?: ReactEventHandler ### `Optional`onResizeCapture[](#onResizeCapture) onResizeCapture?: ReactEventHandler ### `Optional`onScroll[](#onScroll) onScroll?: UIEventHandler ### `Optional`onScrollCapture[](#onScrollCapture) onScrollCapture?: UIEventHandler ### `Optional`onSeeked[](#onSeeked) onSeeked?: ReactEventHandler ### `Optional`onSeekedCapture[](#onSeekedCapture) onSeekedCapture?: ReactEventHandler ### `Optional`onSeeking[](#onSeeking) onSeeking?: ReactEventHandler ### `Optional`onSeekingCapture[](#onSeekingCapture) onSeekingCapture?: ReactEventHandler ### `Optional`onSelect[](#onSelect) onSelect?: ReactEventHandler ### `Optional`onSelectCapture[](#onSelectCapture) onSelectCapture?: ReactEventHandler ### `Optional`onStalled[](#onStalled) onStalled?: ReactEventHandler ### `Optional`onStalledCapture[](#onStalledCapture) onStalledCapture?: ReactEventHandler ### `Optional`onSubmit[](#onSubmit) onSubmit?: FormEventHandler A function to call when the form is submitted. If you call `event.preventDefault()` then this form will not do anything. ### `Optional`onSubmitCapture[](#onSubmitCapture) onSubmitCapture?: FormEventHandler ### `Optional`onSuspend[](#onSuspend) onSuspend?: ReactEventHandler ### `Optional`onSuspendCapture[](#onSuspendCapture) onSuspendCapture?: ReactEventHandler ### `Optional`onTimeUpdate[](#onTimeUpdate) onTimeUpdate?: ReactEventHandler ### `Optional`onTimeUpdateCapture[](#onTimeUpdateCapture) onTimeUpdateCapture?: ReactEventHandler ### `Optional`onTouchCancel[](#onTouchCancel) onTouchCancel?: TouchEventHandler ### `Optional`onTouchCancelCapture[](#onTouchCancelCapture) onTouchCancelCapture?: TouchEventHandler ### `Optional`onTouchEnd[](#onTouchEnd) onTouchEnd?: TouchEventHandler ### `Optional`onTouchEndCapture[](#onTouchEndCapture) onTouchEndCapture?: TouchEventHandler ### `Optional`onTouchMove[](#onTouchMove) onTouchMove?: TouchEventHandler ### `Optional`onTouchMoveCapture[](#onTouchMoveCapture) onTouchMoveCapture?: TouchEventHandler ### `Optional`onTouchStart[](#onTouchStart) onTouchStart?: TouchEventHandler ### `Optional`onTouchStartCapture[](#onTouchStartCapture) onTouchStartCapture?: TouchEventHandler ### `Optional`onTransitionEnd[](#onTransitionEnd) onTransitionEnd?: TransitionEventHandler ### `Optional`onTransitionEndCapture[](#onTransitionEndCapture) onTransitionEndCapture?: TransitionEventHandler ### `Optional`onVolumeChange[](#onVolumeChange) onVolumeChange?: ReactEventHandler ### `Optional`onVolumeChangeCapture[](#onVolumeChangeCapture) onVolumeChangeCapture?: ReactEventHandler ### `Optional`onWaiting[](#onWaiting) onWaiting?: ReactEventHandler ### `Optional`onWaitingCapture[](#onWaitingCapture) onWaitingCapture?: ReactEventHandler ### `Optional`onWheel[](#onWheel) onWheel?: WheelEventHandler ### `Optional`onWheelCapture[](#onWheelCapture) onWheelCapture?: WheelEventHandler ### `Optional`placeholder[](#placeholder) placeholder?: string ### `Optional`prefix[](#prefix) prefix?: string ### `Optional`preventScrollReset[](#preventScrollReset) preventScrollReset?: boolean Prevent the scroll position from resetting to the top of the viewport on completion of the navigation when using the component ### `Optional`property[](#property) property?: string ### `Optional`radioGroup[](#radioGroup) radioGroup?: string ### `Optional`rel[](#rel) rel?: string ### `Optional`relative[](#relative) relative?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) Determines whether the form action is relative to the route hierarchy or the pathname. Use this if you want to opt out of navigating the route hierarchy and want to instead route based on /-delimited URL segments ### `Optional`reloadDocument[](#reloadDocument) reloadDocument?: boolean Forces a full document navigation instead of client side routing + data fetch. ### `Optional`replace[](#replace) replace?: boolean Replaces the current entry in the browser history stack when the form navigates. Use this if you don't want the user to be able to click "back" to the page with the form on it. ### `Optional`resource[](#resource) resource?: string ### `Optional`results[](#results) results?: number ### `Optional`rev[](#rev) rev?: string ### `Optional`role[](#role) role?: AriaRole ### `Optional`security[](#security) security?: string ### `Optional`slot[](#slot) slot?: string ### `Optional`spellCheck[](#spellCheck) spellCheck?: Booleanish ### `Optional`state[](#state) state?: any State object to add to the history stack entry for this navigation ### `Optional`style[](#style) style?: CSSProperties ### `Optional`suppressContentEditableWarning[](#suppressContentEditableWarning) suppressContentEditableWarning?: boolean ### `Optional`suppressHydrationWarning[](#suppressHydrationWarning) suppressHydrationWarning?: boolean ### `Optional`tabIndex[](#tabIndex) tabIndex?: number ### `Optional`target[](#target) target?: string ### `Optional`title[](#title) title?: string ### `Optional`translate[](#translate) translate?: "yes" | "no" ### `Optional`typeof[](#typeof) typeof?: string ### `Optional`unselectable[](#unselectable) unselectable?: "on" | "off" ### `Optional`viewTransition[](#viewTransition) viewTransition?: boolean Enables a [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API) for this navigation. To apply specific styles during the transition see [useViewTransitionState](../functions/react_router.useViewTransitionState.html) . ### `Optional`vocab[](#vocab) vocab?: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [about](#about) [acceptCharset](#acceptCharset) [accessKey](#accessKey) [action](#action) [aria-activedescendant](#aria_activedescendant) [aria-atomic](#aria_atomic) [aria-autocomplete](#aria_autocomplete) [aria-braillelabel](#aria_braillelabel) [aria-brailleroledescription](#aria_brailleroledescription) [aria-busy](#aria_busy) [aria-checked](#aria_checked) [aria-colcount](#aria_colcount) [aria-colindex](#aria_colindex) [aria-colindextext](#aria_colindextext) [aria-colspan](#aria_colspan) [aria-controls](#aria_controls) [aria-current](#aria_current) [aria-describedby](#aria_describedby) [aria-description](#aria_description) [aria-details](#aria_details) [aria-disabled](#aria_disabled) [aria-dropeffect](#aria_dropeffect) [aria-errormessage](#aria_errormessage) [aria-expanded](#aria_expanded) [aria-flowto](#aria_flowto) [aria-grabbed](#aria_grabbed) [aria-haspopup](#aria_haspopup) [aria-hidden](#aria_hidden) [aria-invalid](#aria_invalid) [aria-keyshortcuts](#aria_keyshortcuts) [aria-label](#aria_label) [aria-labelledby](#aria_labelledby) [aria-level](#aria_level) [aria-live](#aria_live) [aria-modal](#aria_modal) [aria-multiline](#aria_multiline) [aria-multiselectable](#aria_multiselectable) [aria-orientation](#aria_orientation) [aria-owns](#aria_owns) [aria-placeholder](#aria_placeholder) [aria-posinset](#aria_posinset) [aria-pressed](#aria_pressed) [aria-readonly](#aria_readonly) [aria-relevant](#aria_relevant) [aria-required](#aria_required) [aria-roledescription](#aria_roledescription) [aria-rowcount](#aria_rowcount) [aria-rowindex](#aria_rowindex) [aria-rowindextext](#aria_rowindextext) [aria-rowspan](#aria_rowspan) [aria-selected](#aria_selected) [aria-setsize](#aria_setsize) [aria-sort](#aria_sort) [aria-valuemax](#aria_valuemax) [aria-valuemin](#aria_valuemin) [aria-valuenow](#aria_valuenow) [aria-valuetext](#aria_valuetext) [autoCapitalize](#autoCapitalize) [autoComplete](#autoComplete) [autoCorrect](#autoCorrect) [autoFocus](#autoFocus) [autoSave](#autoSave) [children](#children) [className](#className) [color](#color) [content](#content) [contentEditable](#contentEditable) [contextMenu](#contextMenu) [dangerouslySetInnerHTML](#dangerouslySetInnerHTML) [datatype](#datatype) [defaultChecked](#defaultChecked) [defaultValue](#defaultValue) [dir](#dir) [discover](#discover) [draggable](#draggable) [encType](#encType) [fetcherKey](#fetcherKey) [hidden](#hidden) [id](#id) [inlist](#inlist) [inputMode](#inputMode) [is](#is) [itemID](#itemID) [itemProp](#itemProp) [itemRef](#itemRef) [itemScope](#itemScope) [itemType](#itemType) [lang](#lang) [method](#method) [name](#name) [navigate](#navigate) [nonce](#nonce) [noValidate](#noValidate) [onAbort](#onAbort) [onAbortCapture](#onAbortCapture) [onAnimationEnd](#onAnimationEnd) [onAnimationEndCapture](#onAnimationEndCapture) [onAnimationIteration](#onAnimationIteration) [onAnimationIterationCapture](#onAnimationIterationCapture) [onAnimationStart](#onAnimationStart) [onAnimationStartCapture](#onAnimationStartCapture) [onAuxClick](#onAuxClick) [onAuxClickCapture](#onAuxClickCapture) [onBeforeInput](#onBeforeInput) [onBeforeInputCapture](#onBeforeInputCapture) [onBlur](#onBlur) [onBlurCapture](#onBlurCapture) [onCanPlay](#onCanPlay) [onCanPlayCapture](#onCanPlayCapture) [onCanPlayThrough](#onCanPlayThrough) [onCanPlayThroughCapture](#onCanPlayThroughCapture) [onChange](#onChange) [onChangeCapture](#onChangeCapture) [onClick](#onClick) [onClickCapture](#onClickCapture) [onCompositionEnd](#onCompositionEnd) [onCompositionEndCapture](#onCompositionEndCapture) [onCompositionStart](#onCompositionStart) [onCompositionStartCapture](#onCompositionStartCapture) [onCompositionUpdate](#onCompositionUpdate) [onCompositionUpdateCapture](#onCompositionUpdateCapture) [onContextMenu](#onContextMenu) [onContextMenuCapture](#onContextMenuCapture) [onCopy](#onCopy) [onCopyCapture](#onCopyCapture) [onCut](#onCut) [onCutCapture](#onCutCapture) [onDoubleClick](#onDoubleClick) [onDoubleClickCapture](#onDoubleClickCapture) [onDrag](#onDrag) [onDragCapture](#onDragCapture) [onDragEnd](#onDragEnd) [onDragEndCapture](#onDragEndCapture) [onDragEnter](#onDragEnter) [onDragEnterCapture](#onDragEnterCapture) [onDragExit](#onDragExit) [onDragExitCapture](#onDragExitCapture) [onDragLeave](#onDragLeave) [onDragLeaveCapture](#onDragLeaveCapture) [onDragOver](#onDragOver) [onDragOverCapture](#onDragOverCapture) [onDragStart](#onDragStart) [onDragStartCapture](#onDragStartCapture) [onDrop](#onDrop) [onDropCapture](#onDropCapture) [onDurationChange](#onDurationChange) [onDurationChangeCapture](#onDurationChangeCapture) [onEmptied](#onEmptied) [onEmptiedCapture](#onEmptiedCapture) [onEncrypted](#onEncrypted) [onEncryptedCapture](#onEncryptedCapture) [onEnded](#onEnded) [onEndedCapture](#onEndedCapture) [onError](#onError) [onErrorCapture](#onErrorCapture) [onFocus](#onFocus) [onFocusCapture](#onFocusCapture) [onGotPointerCapture](#onGotPointerCapture) [onGotPointerCaptureCapture](#onGotPointerCaptureCapture) [onInput](#onInput) [onInputCapture](#onInputCapture) [onInvalid](#onInvalid) [onInvalidCapture](#onInvalidCapture) [onKeyDown](#onKeyDown) [onKeyDownCapture](#onKeyDownCapture) [onKeyPress](#onKeyPress) [onKeyPressCapture](#onKeyPressCapture) [onKeyUp](#onKeyUp) [onKeyUpCapture](#onKeyUpCapture) [onLoad](#onLoad) [onLoadCapture](#onLoadCapture) [onLoadedData](#onLoadedData) [onLoadedDataCapture](#onLoadedDataCapture) [onLoadedMetadata](#onLoadedMetadata) [onLoadedMetadataCapture](#onLoadedMetadataCapture) [onLoadStart](#onLoadStart) [onLoadStartCapture](#onLoadStartCapture) [onLostPointerCapture](#onLostPointerCapture) [onLostPointerCaptureCapture](#onLostPointerCaptureCapture) [onMouseDown](#onMouseDown) [onMouseDownCapture](#onMouseDownCapture) [onMouseEnter](#onMouseEnter) [onMouseLeave](#onMouseLeave) [onMouseMove](#onMouseMove) [onMouseMoveCapture](#onMouseMoveCapture) [onMouseOut](#onMouseOut) [onMouseOutCapture](#onMouseOutCapture) [onMouseOver](#onMouseOver) [onMouseOverCapture](#onMouseOverCapture) [onMouseUp](#onMouseUp) [onMouseUpCapture](#onMouseUpCapture) [onPaste](#onPaste) [onPasteCapture](#onPasteCapture) [onPause](#onPause) [onPauseCapture](#onPauseCapture) [onPlay](#onPlay) [onPlayCapture](#onPlayCapture) [onPlaying](#onPlaying) [onPlayingCapture](#onPlayingCapture) [onPointerCancel](#onPointerCancel) [onPointerCancelCapture](#onPointerCancelCapture) [onPointerDown](#onPointerDown) [onPointerDownCapture](#onPointerDownCapture) [onPointerEnter](#onPointerEnter) [onPointerEnterCapture](#onPointerEnterCapture) [onPointerLeave](#onPointerLeave) [onPointerLeaveCapture](#onPointerLeaveCapture) [onPointerMove](#onPointerMove) [onPointerMoveCapture](#onPointerMoveCapture) [onPointerOut](#onPointerOut) [onPointerOutCapture](#onPointerOutCapture) [onPointerOver](#onPointerOver) [onPointerOverCapture](#onPointerOverCapture) [onPointerUp](#onPointerUp) [onPointerUpCapture](#onPointerUpCapture) [onProgress](#onProgress) [onProgressCapture](#onProgressCapture) [onRateChange](#onRateChange) [onRateChangeCapture](#onRateChangeCapture) [onReset](#onReset) [onResetCapture](#onResetCapture) [onResize](#onResize) [onResizeCapture](#onResizeCapture) [onScroll](#onScroll) [onScrollCapture](#onScrollCapture) [onSeeked](#onSeeked) [onSeekedCapture](#onSeekedCapture) [onSeeking](#onSeeking) [onSeekingCapture](#onSeekingCapture) [onSelect](#onSelect) [onSelectCapture](#onSelectCapture) [onStalled](#onStalled) [onStalledCapture](#onStalledCapture) [onSubmit](#onSubmit) [onSubmitCapture](#onSubmitCapture) [onSuspend](#onSuspend) [onSuspendCapture](#onSuspendCapture) [onTimeUpdate](#onTimeUpdate) [onTimeUpdateCapture](#onTimeUpdateCapture) [onTouchCancel](#onTouchCancel) [onTouchCancelCapture](#onTouchCancelCapture) [onTouchEnd](#onTouchEnd) [onTouchEndCapture](#onTouchEndCapture) [onTouchMove](#onTouchMove) [onTouchMoveCapture](#onTouchMoveCapture) [onTouchStart](#onTouchStart) [onTouchStartCapture](#onTouchStartCapture) [onTransitionEnd](#onTransitionEnd) [onTransitionEndCapture](#onTransitionEndCapture) [onVolumeChange](#onVolumeChange) [onVolumeChangeCapture](#onVolumeChangeCapture) [onWaiting](#onWaiting) [onWaitingCapture](#onWaitingCapture) [onWheel](#onWheel) [onWheelCapture](#onWheelCapture) [placeholder](#placeholder) [prefix](#prefix) [preventScrollReset](#preventScrollReset) [property](#property) [radioGroup](#radioGroup) [rel](#rel) [relative](#relative) [reloadDocument](#reloadDocument) [replace](#replace) [resource](#resource) [results](#results) [rev](#rev) [role](#role) [security](#security) [slot](#slot) [spellCheck](#spellCheck) [state](#state) [style](#style) [suppressContentEditableWarning](#suppressContentEditableWarning) [suppressHydrationWarning](#suppressHydrationWarning) [tabIndex](#tabIndex) [target](#target) [title](#title) [translate](#translate) [typeof](#typeof) [unselectable](#unselectable) [viewTransition](#viewTransition) [vocab](#vocab) --- # HistoryRouterProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [HistoryRouterProps](react_router.HistoryRouterProps.html) Interface HistoryRouterProps ============================ interface HistoryRouterProps {     [basename](react_router.HistoryRouterProps.html#basename) ?: string;     [children](react_router.HistoryRouterProps.html#children) ?: ReactNode;     [history](react_router.HistoryRouterProps.html#history) : History; } ##### Index ### Properties [basename?](react_router.HistoryRouterProps.html#basename) [children?](react_router.HistoryRouterProps.html#children) [history](react_router.HistoryRouterProps.html#history) Properties ---------- ### `Optional`basename[](#basename) basename?: string ### `Optional`children[](#children) children?: ReactNode ### history[](#history) history: History ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [basename](#basename) [children](#children) [history](#history) --- # IndexRouteProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [IndexRouteProps](react_router.IndexRouteProps.html) Interface IndexRouteProps ========================= interface IndexRouteProps {     [action](react_router.IndexRouteProps.html#action) ?: boolean | [ActionFunction](react_router.ActionFunction.html) ;     [caseSensitive](react_router.IndexRouteProps.html#caseSensitive) ?: boolean;     [children](react_router.IndexRouteProps.html#children) ?: undefined;     [Component](react_router.IndexRouteProps.html#Component) ?: null | ComponentType<{}\>;     [element](react_router.IndexRouteProps.html#element) ?: ReactNode;     [ErrorBoundary](react_router.IndexRouteProps.html#ErrorBoundary) ?: null | ComponentType<{}\>;     [errorElement](react_router.IndexRouteProps.html#errorElement) ?: ReactNode;     [handle](react_router.IndexRouteProps.html#handle) ?: any;     [hasErrorBoundary](react_router.IndexRouteProps.html#hasErrorBoundary) ?: boolean;     [HydrateFallback](react_router.IndexRouteProps.html#HydrateFallback) ?: null | ComponentType<{}\>;     [hydrateFallbackElement](react_router.IndexRouteProps.html#hydrateFallbackElement) ?: ReactNode;     [id](react_router.IndexRouteProps.html#id) ?: string;     [index](react_router.IndexRouteProps.html#index) : true;     [lazy](react_router.IndexRouteProps.html#lazy) ?: [LazyRouteFunction](react_router.LazyRouteFunction.html) <[IndexRouteObject](react_router.IndexRouteObject.html) \>;     [loader](react_router.IndexRouteProps.html#loader) ?: boolean | [LoaderFunction](../types/react_router.LoaderFunction.html) ;     [path](react_router.IndexRouteProps.html#path) ?: string;     [shouldRevalidate](react_router.IndexRouteProps.html#shouldRevalidate) ?: [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) ; } ##### Index ### Properties [action?](react_router.IndexRouteProps.html#action) [caseSensitive?](react_router.IndexRouteProps.html#caseSensitive) [children?](react_router.IndexRouteProps.html#children) [Component?](react_router.IndexRouteProps.html#Component) [element?](react_router.IndexRouteProps.html#element) [ErrorBoundary?](react_router.IndexRouteProps.html#ErrorBoundary) [errorElement?](react_router.IndexRouteProps.html#errorElement) [handle?](react_router.IndexRouteProps.html#handle) [hasErrorBoundary?](react_router.IndexRouteProps.html#hasErrorBoundary) [HydrateFallback?](react_router.IndexRouteProps.html#HydrateFallback) [hydrateFallbackElement?](react_router.IndexRouteProps.html#hydrateFallbackElement) [id?](react_router.IndexRouteProps.html#id) [index](react_router.IndexRouteProps.html#index) [lazy?](react_router.IndexRouteProps.html#lazy) [loader?](react_router.IndexRouteProps.html#loader) [path?](react_router.IndexRouteProps.html#path) [shouldRevalidate?](react_router.IndexRouteProps.html#shouldRevalidate) Properties ---------- ### `Optional`action[](#action) action?: boolean | [ActionFunction](react_router.ActionFunction.html) ### `Optional`caseSensitive[](#caseSensitive) caseSensitive?: boolean ### `Optional`children[](#children) children?: undefined ### `Optional`Component[](#Component) Component?: null | ComponentType<{}\> ### `Optional`element[](#element) element?: ReactNode ### `Optional`ErrorBoundary[](#ErrorBoundary) ErrorBoundary?: null | ComponentType<{}\> ### `Optional`errorElement[](#errorElement) errorElement?: ReactNode ### `Optional`handle[](#handle) handle?: any ### `Optional`hasErrorBoundary[](#hasErrorBoundary) hasErrorBoundary?: boolean ### `Optional`HydrateFallback[](#HydrateFallback) HydrateFallback?: null | ComponentType<{}\> ### `Optional`hydrateFallbackElement[](#hydrateFallbackElement) hydrateFallbackElement?: ReactNode ### `Optional`id[](#id) id?: string ### index[](#index) index ### `Optional`lazy[](#lazy) lazy?: [LazyRouteFunction](react_router.LazyRouteFunction.html) <[IndexRouteObject](react_router.IndexRouteObject.html) \> ### `Optional`loader[](#loader) loader?: boolean | [LoaderFunction](../types/react_router.LoaderFunction.html) ### `Optional`path[](#path) path?: string ### `Optional`shouldRevalidate[](#shouldRevalidate) shouldRevalidate?: [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [action](#action) [caseSensitive](#caseSensitive) [children](#children) [Component](#Component) [element](#element) [ErrorBoundary](#ErrorBoundary) [errorElement](#errorElement) [handle](#handle) [hasErrorBoundary](#hasErrorBoundary) [HydrateFallback](#HydrateFallback) [hydrateFallbackElement](#hydrateFallbackElement) [id](#id) [index](#index) [lazy](#lazy) [loader](#loader) [path](#path) [shouldRevalidate](#shouldRevalidate) --- # IndexRouteObject | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [IndexRouteObject](react_router.IndexRouteObject.html) Interface IndexRouteObject ========================== interface IndexRouteObject {     [action](react_router.IndexRouteObject.html#action) ?: boolean | [ActionFunction](react_router.ActionFunction.html) ;     [caseSensitive](react_router.IndexRouteObject.html#caseSensitive) ?: boolean;     [children](react_router.IndexRouteObject.html#children) ?: undefined;     [Component](react_router.IndexRouteObject.html#Component) ?: null | ComponentType<{}\>;     [element](react_router.IndexRouteObject.html#element) ?: ReactNode;     [ErrorBoundary](react_router.IndexRouteObject.html#ErrorBoundary) ?: null | ComponentType<{}\>;     [errorElement](react_router.IndexRouteObject.html#errorElement) ?: ReactNode;     [handle](react_router.IndexRouteObject.html#handle) ?: any;     [hasErrorBoundary](react_router.IndexRouteObject.html#hasErrorBoundary) ?: boolean;     [HydrateFallback](react_router.IndexRouteObject.html#HydrateFallback) ?: null | ComponentType<{}\>;     [hydrateFallbackElement](react_router.IndexRouteObject.html#hydrateFallbackElement) ?: ReactNode;     [id](react_router.IndexRouteObject.html#id) ?: string;     [index](react_router.IndexRouteObject.html#index) : true;     [lazy](react_router.IndexRouteObject.html#lazy) ?: [LazyRouteFunction](react_router.LazyRouteFunction.html) <[RouteObject](../types/react_router.RouteObject.html) \>;     [loader](react_router.IndexRouteObject.html#loader) ?: boolean | [LoaderFunction](../types/react_router.LoaderFunction.html) ;     [path](react_router.IndexRouteObject.html#path) ?: string;     [shouldRevalidate](react_router.IndexRouteObject.html#shouldRevalidate) ?: [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) ; } ##### Index ### Properties [action?](react_router.IndexRouteObject.html#action) [caseSensitive?](react_router.IndexRouteObject.html#caseSensitive) [children?](react_router.IndexRouteObject.html#children) [Component?](react_router.IndexRouteObject.html#Component) [element?](react_router.IndexRouteObject.html#element) [ErrorBoundary?](react_router.IndexRouteObject.html#ErrorBoundary) [errorElement?](react_router.IndexRouteObject.html#errorElement) [handle?](react_router.IndexRouteObject.html#handle) [hasErrorBoundary?](react_router.IndexRouteObject.html#hasErrorBoundary) [HydrateFallback?](react_router.IndexRouteObject.html#HydrateFallback) [hydrateFallbackElement?](react_router.IndexRouteObject.html#hydrateFallbackElement) [id?](react_router.IndexRouteObject.html#id) [index](react_router.IndexRouteObject.html#index) [lazy?](react_router.IndexRouteObject.html#lazy) [loader?](react_router.IndexRouteObject.html#loader) [path?](react_router.IndexRouteObject.html#path) [shouldRevalidate?](react_router.IndexRouteObject.html#shouldRevalidate) Properties ---------- ### `Optional`action[](#action) action?: boolean | [ActionFunction](react_router.ActionFunction.html) ### `Optional`caseSensitive[](#caseSensitive) caseSensitive?: boolean ### `Optional`children[](#children) children?: undefined ### `Optional`Component[](#Component) Component?: null | ComponentType<{}\> ### `Optional`element[](#element) element?: ReactNode ### `Optional`ErrorBoundary[](#ErrorBoundary) ErrorBoundary?: null | ComponentType<{}\> ### `Optional`errorElement[](#errorElement) errorElement?: ReactNode ### `Optional`handle[](#handle) handle?: any ### `Optional`hasErrorBoundary[](#hasErrorBoundary) hasErrorBoundary?: boolean ### `Optional`HydrateFallback[](#HydrateFallback) HydrateFallback?: null | ComponentType<{}\> ### `Optional`hydrateFallbackElement[](#hydrateFallbackElement) hydrateFallbackElement?: ReactNode ### `Optional`id[](#id) id?: string ### index[](#index) index ### `Optional`lazy[](#lazy) lazy?: [LazyRouteFunction](react_router.LazyRouteFunction.html) <[RouteObject](../types/react_router.RouteObject.html) \> ### `Optional`loader[](#loader) loader?: boolean | [LoaderFunction](../types/react_router.LoaderFunction.html) ### `Optional`path[](#path) path?: string ### `Optional`shouldRevalidate[](#shouldRevalidate) shouldRevalidate?: [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [action](#action) [caseSensitive](#caseSensitive) [children](#children) [Component](#Component) [element](#element) [ErrorBoundary](#ErrorBoundary) [errorElement](#errorElement) [handle](#handle) [hasErrorBoundary](#hasErrorBoundary) [HydrateFallback](#HydrateFallback) [hydrateFallbackElement](#hydrateFallbackElement) [id](#id) [index](#index) [lazy](#lazy) [loader](#loader) [path](#path) [shouldRevalidate](#shouldRevalidate) --- # LayoutRouteProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [LayoutRouteProps](react_router.LayoutRouteProps.html) Interface LayoutRouteProps ========================== interface LayoutRouteProps {     [action](react_router.LayoutRouteProps.html#action) ?: boolean | [ActionFunction](react_router.ActionFunction.html) ;     [caseSensitive](react_router.LayoutRouteProps.html#caseSensitive) ?: boolean;     [children](react_router.LayoutRouteProps.html#children) ?: ReactNode;     [Component](react_router.LayoutRouteProps.html#Component) ?: null | ComponentType<{}\>;     [element](react_router.LayoutRouteProps.html#element) ?: ReactNode;     [ErrorBoundary](react_router.LayoutRouteProps.html#ErrorBoundary) ?: null | ComponentType<{}\>;     [errorElement](react_router.LayoutRouteProps.html#errorElement) ?: ReactNode;     [handle](react_router.LayoutRouteProps.html#handle) ?: any;     [hasErrorBoundary](react_router.LayoutRouteProps.html#hasErrorBoundary) ?: boolean;     [HydrateFallback](react_router.LayoutRouteProps.html#HydrateFallback) ?: null | ComponentType<{}\>;     [hydrateFallbackElement](react_router.LayoutRouteProps.html#hydrateFallbackElement) ?: ReactNode;     [id](react_router.LayoutRouteProps.html#id) ?: string;     [index](react_router.LayoutRouteProps.html#index) ?: false;     [lazy](react_router.LayoutRouteProps.html#lazy) ?: [LazyRouteFunction](react_router.LazyRouteFunction.html) <[NonIndexRouteObject](react_router.NonIndexRouteObject.html) \>;     [loader](react_router.LayoutRouteProps.html#loader) ?: boolean | [LoaderFunction](../types/react_router.LoaderFunction.html) ;     [path](react_router.LayoutRouteProps.html#path) ?: string;     [shouldRevalidate](react_router.LayoutRouteProps.html#shouldRevalidate) ?: [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) ; } #### Hierarchy ([view full](../hierarchy.html#react-router.LayoutRouteProps) ) * [PathRouteProps](react_router.PathRouteProps.html) * LayoutRouteProps ##### Index ### Properties [action?](react_router.LayoutRouteProps.html#action) [caseSensitive?](react_router.LayoutRouteProps.html#caseSensitive) [children?](react_router.LayoutRouteProps.html#children) [Component?](react_router.LayoutRouteProps.html#Component) [element?](react_router.LayoutRouteProps.html#element) [ErrorBoundary?](react_router.LayoutRouteProps.html#ErrorBoundary) [errorElement?](react_router.LayoutRouteProps.html#errorElement) [handle?](react_router.LayoutRouteProps.html#handle) [hasErrorBoundary?](react_router.LayoutRouteProps.html#hasErrorBoundary) [HydrateFallback?](react_router.LayoutRouteProps.html#HydrateFallback) [hydrateFallbackElement?](react_router.LayoutRouteProps.html#hydrateFallbackElement) [id?](react_router.LayoutRouteProps.html#id) [index?](react_router.LayoutRouteProps.html#index) [lazy?](react_router.LayoutRouteProps.html#lazy) [loader?](react_router.LayoutRouteProps.html#loader) [path?](react_router.LayoutRouteProps.html#path) [shouldRevalidate?](react_router.LayoutRouteProps.html#shouldRevalidate) Properties ---------- ### `Optional`action[](#action) action?: boolean | [ActionFunction](react_router.ActionFunction.html) ### `Optional`caseSensitive[](#caseSensitive) caseSensitive?: boolean ### `Optional`children[](#children) children?: ReactNode ### `Optional`Component[](#Component) Component?: null | ComponentType<{}\> ### `Optional`element[](#element) element?: ReactNode ### `Optional`ErrorBoundary[](#ErrorBoundary) ErrorBoundary?: null | ComponentType<{}\> ### `Optional`errorElement[](#errorElement) errorElement?: ReactNode ### `Optional`handle[](#handle) handle?: any ### `Optional`hasErrorBoundary[](#hasErrorBoundary) hasErrorBoundary?: boolean ### `Optional`HydrateFallback[](#HydrateFallback) HydrateFallback?: null | ComponentType<{}\> ### `Optional`hydrateFallbackElement[](#hydrateFallbackElement) hydrateFallbackElement?: ReactNode ### `Optional`id[](#id) id?: string ### `Optional`index[](#index) index ### `Optional`lazy[](#lazy) lazy?: [LazyRouteFunction](react_router.LazyRouteFunction.html) <[NonIndexRouteObject](react_router.NonIndexRouteObject.html) \> ### `Optional`loader[](#loader) loader?: boolean | [LoaderFunction](../types/react_router.LoaderFunction.html) ### `Optional`path[](#path) path?: string ### `Optional`shouldRevalidate[](#shouldRevalidate) shouldRevalidate?: [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [action](#action) [caseSensitive](#caseSensitive) [children](#children) [Component](#Component) [element](#element) [ErrorBoundary](#ErrorBoundary) [errorElement](#errorElement) [handle](#handle) [hasErrorBoundary](#hasErrorBoundary) [HydrateFallback](#HydrateFallback) [hydrateFallbackElement](#hydrateFallbackElement) [id](#id) [index](#index) [lazy](#lazy) [loader](#loader) [path](#path) [shouldRevalidate](#shouldRevalidate) --- # LazyRouteFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [LazyRouteFunction](react_router.LazyRouteFunction.html) Interface LazyRouteFunction ============================== lazy() function to load a route definition, which can add non-matching related properties to a route #### Type Parameters * R extends AgnosticRouteObject * LazyRouteFunction(): Promise         ? Omit, K\> & Required, K\>\>         : never }\[Exclude\], undefined\>\>[](#LazyRouteFunction) * #### Returns Promise         ? Omit, K\> & Required, K\>\>         : never }\[Exclude\], undefined\>\> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LinksFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [LinksFunction](react_router.LinksFunction.html) Interface LinksFunction ======================= A function that defines `` tags to be inserted into the `` of the document on route transitions. #### See[](#See) [https://remix.run/route/meta](https://remix.run/route/meta) * LinksFunction(): [LinkDescriptor](../types/react_router.LinkDescriptor.html) \[\][](#LinksFunction) * #### Returns [LinkDescriptor](../types/react_router.LinkDescriptor.html) \[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LoaderFunctionArgs | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [LoaderFunctionArgs](react_router.LoaderFunctionArgs.html) Interface LoaderFunctionArgs ===================================== Arguments passed to loader functions interface LoaderFunctionArgs<[Context](react_router.LoaderFunctionArgs.html#Context) \> {     [context](react_router.LoaderFunctionArgs.html#context-1) ?: [Context](react_router.LoaderFunctionArgs.html#Context) ;     [params](react_router.LoaderFunctionArgs.html#params) : [Params](../types/react_router.Params.html) ;     [request](react_router.LoaderFunctionArgs.html#request) : Request; } #### Type Parameters * Context = any #### Hierarchy * DataFunctionArgs<[Context](react_router.LoaderFunctionArgs.html#Context) \> * LoaderFunctionArgs ##### Index ### Properties [context?](react_router.LoaderFunctionArgs.html#context-1) [params](react_router.LoaderFunctionArgs.html#params) [request](react_router.LoaderFunctionArgs.html#request) Properties ---------- ### `Optional`context[](#context-1) context?: [Context](react_router.LoaderFunctionArgs.html#Context) ### params[](#params) params: [Params](../types/react_router.Params.html) ### request[](#request) request: Request ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [context](#context-1) [params](#params) [request](#request) --- # Location | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [Location](react_router.Location.html) Interface Location ========================= An entry in a history stack. A location contains information about the URL path, as well as possibly some arbitrary state and a key. interface Location<[State](react_router.Location.html#State) \> {     [hash](react_router.Location.html#hash) : string;     [key](react_router.Location.html#key) : string;     [pathname](react_router.Location.html#pathname) : string;     [search](react_router.Location.html#search) : string;     [state](react_router.Location.html#state-1) : [State](react_router.Location.html#State) ; } #### Type Parameters * State = any #### Hierarchy ([view full](../hierarchy.html#react-router.Location) ) * [Path](react_router.Path.html) * Location ##### Index ### Properties [hash](react_router.Location.html#hash) [key](react_router.Location.html#key) [pathname](react_router.Location.html#pathname) [search](react_router.Location.html#search) [state](react_router.Location.html#state-1) Properties ---------- ### hash[](#hash) hash: string A URL fragment identifier, beginning with a #. ### key[](#key) key: string A unique string associated with this location. May be used to safely store and retrieve data in some other storage API, like `localStorage`. Note: This value is always "default" on the initial location. ### pathname[](#pathname) pathname: string A URL pathname, beginning with a /. ### search[](#search) search: string A URL search string, beginning with a ?. ### state[](#state-1) state: [State](react_router.Location.html#State) A value of arbitrary data associated with this location. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [hash](#hash) [key](#key) [pathname](#pathname) [search](#search) [state](#state-1) --- # MemoryRouterProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [MemoryRouterProps](react_router.MemoryRouterProps.html) Interface MemoryRouterProps =========================== interface MemoryRouterProps {     [basename](react_router.MemoryRouterProps.html#basename) ?: string;     [children](react_router.MemoryRouterProps.html#children) ?: ReactNode;     [initialEntries](react_router.MemoryRouterProps.html#initialEntries) ?: [InitialEntry](../types/react_router.InitialEntry.html) \[\];     [initialIndex](react_router.MemoryRouterProps.html#initialIndex) ?: number; } ##### Index ### Properties [basename?](react_router.MemoryRouterProps.html#basename) [children?](react_router.MemoryRouterProps.html#children) [initialEntries?](react_router.MemoryRouterProps.html#initialEntries) [initialIndex?](react_router.MemoryRouterProps.html#initialIndex) Properties ---------- ### `Optional`basename[](#basename) basename?: string ### `Optional`children[](#children) children?: ReactNode ### `Optional`initialEntries[](#initialEntries) initialEntries?: [InitialEntry](../types/react_router.InitialEntry.html) \[\] ### `Optional`initialIndex[](#initialIndex) initialIndex?: number ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [basename](#basename) [children](#children) [initialEntries](#initialEntries) [initialIndex](#initialIndex) --- # MetaArgs | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [MetaArgs](react_router.MetaArgs.html) Interface MetaArgs ======================================== interface MetaArgs<[Loader](react_router.MetaArgs.html#Loader) , [MatchLoaders](react_router.MetaArgs.html#MatchLoaders) \> {     [data](react_router.MetaArgs.html#data) : undefined | ([Loader](react_router.MetaArgs.html#Loader) extends [LoaderFunction](../types/react_router.LoaderFunction.html) | [ClientLoaderFunction](../types/react_router.ClientLoaderFunction.html)         ? SerializeFrom<[Loader](react_router.MetaArgs.html#Loader) <[Loader](react_router.MetaArgs.html#Loader) \>\>         : unknown);     [error](react_router.MetaArgs.html#error) ?: unknown;     [location](react_router.MetaArgs.html#location) : [Location](react_router.Location.html) ;     [matches](react_router.MetaArgs.html#matches) : MetaMatches<[MatchLoaders](react_router.MetaArgs.html#MatchLoaders) \>;     [params](react_router.MetaArgs.html#params) : [Params](../types/react_router.Params.html) ; } #### Type Parameters * Loader extends [LoaderFunction](../types/react_router.LoaderFunction.html) | [ClientLoaderFunction](../types/react_router.ClientLoaderFunction.html) | unknown = unknown * MatchLoaders extends Record = Record ##### Index ### Properties [data](react_router.MetaArgs.html#data) [error?](react_router.MetaArgs.html#error) [location](react_router.MetaArgs.html#location) [matches](react_router.MetaArgs.html#matches) [params](react_router.MetaArgs.html#params) Properties ---------- ### data[](#data) data: undefined | ([Loader](react_router.MetaArgs.html#Loader) extends [LoaderFunction](../types/react_router.LoaderFunction.html) | [ClientLoaderFunction](../types/react_router.ClientLoaderFunction.html)     ? SerializeFrom<[Loader](react_router.MetaArgs.html#Loader) <[Loader](react_router.MetaArgs.html#Loader) \>\>     : unknown) ### `Optional`error[](#error) error?: unknown ### location[](#location) location: [Location](react_router.Location.html) ### matches[](#matches) matches: MetaMatches<[MatchLoaders](react_router.MetaArgs.html#MatchLoaders) \> ### params[](#params) params: [Params](../types/react_router.Params.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [data](#data) [error](#error) [location](#location) [matches](#matches) [params](#params) --- # MetaFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [MetaFunction](react_router.MetaFunction.html) Interface MetaFunction ============================================ A function that returns an array of data objects to use for rendering metadata HTML tags in a route. These tags are not rendered on descendant routes in the route hierarchy. In other words, they will only be rendered on the route in which they are exported. #### Type Parameters * Loader extends [LoaderFunction](../types/react_router.LoaderFunction.html) | [ClientLoaderFunction](../types/react_router.ClientLoaderFunction.html) | unknown = unknown The type of the current route's loader function * MatchLoaders extends Record = Record Mapping from a parent route's filepath to its loader function type Note that parent route filepaths are relative to the `app/` directory. For example, if this meta function is for `/sales/customers/$customerId`: // app/root.tsxconst loader = () => ({ hello: "world" })export type Loader = typeof loader// app/routes/sales.tsxconst loader = () => ({ salesCount: 1074 })export type Loader = typeof loader// app/routes/sales/customers.tsxconst loader = () => ({ customerCount: 74 })export type Loader = typeof loader// app/routes/sales/customers/$customersId.tsximport type { Loader as RootLoader } from "../../../root"import type { Loader as SalesLoader } from "../../sales"import type { Loader as CustomersLoader } from "../../sales/customers"const loader = () => ({ name: "Customer name" })const meta: MetaFunction = ({ data, matches }) => { const { name } = data // ^? string const { customerCount } = matches.find((match) => match.id === "routes/sales/customers").data // ^? number const { salesCount } = matches.find((match) => match.id === "routes/sales").data // ^? number const { hello } = matches.find((match) => match.id === "root").data // ^? "world"} * MetaFunction(args): undefined | [MetaDescriptor](../types/react_router.MetaDescriptor.html) \[\][](#MetaFunction) * #### Parameters * args: [MetaArgs](react_router.MetaArgs.html) <[Loader](react_router.MetaFunction.html#Loader) , [MatchLoaders](react_router.MetaFunction.html#MatchLoaders) \> #### Returns undefined | [MetaDescriptor](../types/react_router.MetaDescriptor.html) \[\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NavigateFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [NavigateFunction](react_router.NavigateFunction.html) Interface NavigateFunction ========================== The interface for the navigate() function returned from useNavigate(). * NavigateFunction(to, options?): void | Promise[](#NavigateFunction) * #### Parameters * to: [To](../types/react_router.To.html) * `Optional`options: [NavigateOptions](react_router.NavigateOptions.html) #### Returns void | Promise * NavigateFunction(delta): void | Promise[](#NavigateFunction-1) * #### Parameters * delta: number #### Returns void | Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NavigateProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [NavigateProps](react_router.NavigateProps.html) Interface NavigateProps ======================= interface NavigateProps {     [relative](react_router.NavigateProps.html#relative) ?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) ;     [replace](react_router.NavigateProps.html#replace) ?: boolean;     [state](react_router.NavigateProps.html#state) ?: any;     [to](react_router.NavigateProps.html#to) : [To](../types/react_router.To.html) ; } ##### Index ### Properties [relative?](react_router.NavigateProps.html#relative) [replace?](react_router.NavigateProps.html#replace) [state?](react_router.NavigateProps.html#state) [to](react_router.NavigateProps.html#to) Properties ---------- ### `Optional`relative[](#relative) relative?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) ### `Optional`replace[](#replace) replace?: boolean ### `Optional`state[](#state) state?: any ### to[](#to) to: [To](../types/react_router.To.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [relative](#relative) [replace](#replace) [state](#state) [to](#to) --- # NavigateOptions | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [NavigateOptions](react_router.NavigateOptions.html) Interface NavigateOptions ========================= interface NavigateOptions {     [flushSync](react_router.NavigateOptions.html#flushSync) ?: boolean;     [preventScrollReset](react_router.NavigateOptions.html#preventScrollReset) ?: boolean;     [relative](react_router.NavigateOptions.html#relative) ?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) ;     [replace](react_router.NavigateOptions.html#replace) ?: boolean;     [state](react_router.NavigateOptions.html#state) ?: any;     [viewTransition](react_router.NavigateOptions.html#viewTransition) ?: boolean; } ##### Index ### Properties [flushSync?](react_router.NavigateOptions.html#flushSync) [preventScrollReset?](react_router.NavigateOptions.html#preventScrollReset) [relative?](react_router.NavigateOptions.html#relative) [replace?](react_router.NavigateOptions.html#replace) [state?](react_router.NavigateOptions.html#state) [viewTransition?](react_router.NavigateOptions.html#viewTransition) Properties ---------- ### `Optional`flushSync[](#flushSync) flushSync?: boolean ### `Optional`preventScrollReset[](#preventScrollReset) preventScrollReset?: boolean ### `Optional`relative[](#relative) relative?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) ### `Optional`replace[](#replace) replace?: boolean ### `Optional`state[](#state) state?: any ### `Optional`viewTransition[](#viewTransition) viewTransition?: boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [flushSync](#flushSync) [preventScrollReset](#preventScrollReset) [relative](#relative) [replace](#replace) [state](#state) [viewTransition](#viewTransition) --- # OutletProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [OutletProps](react_router.OutletProps.html) Interface OutletProps ===================== interface OutletProps {     [context](react_router.OutletProps.html#context) ?: unknown; } ##### Index ### Properties [context?](react_router.OutletProps.html#context) Properties ---------- ### `Optional`context[](#context) context?: unknown Provides a context value to the element tree below the outlet. Use when the parent route needs to provide values to child routes. Access the context with [useOutletContext](../functions/react_router.useOutletContext.html) . ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [context](#context) --- # PageLinkDescriptor | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [PageLinkDescriptor](react_router.PageLinkDescriptor.html) Interface PageLinkDescriptor ============================ interface PageLinkDescriptor {     [crossOrigin](react_router.PageLinkDescriptor.html#crossOrigin) ?: "anonymous" | "use-credentials";     [disabled](react_router.PageLinkDescriptor.html#disabled) ?: boolean;     [hrefLang](react_router.PageLinkDescriptor.html#hrefLang) ?: string;     [integrity](react_router.PageLinkDescriptor.html#integrity) ?: string;     [media](react_router.PageLinkDescriptor.html#media) ?: string;     [page](react_router.PageLinkDescriptor.html#page) : string;     [referrerPolicy](react_router.PageLinkDescriptor.html#referrerPolicy) ?:         | ""         | "no-referrer"         | "no-referrer-when-downgrade"         | "same-origin"         | "origin"         | "strict-origin"         | "origin-when-cross-origin"         | "strict-origin-when-cross-origin"         | "unsafe-url"; } #### Hierarchy * Omit<[HtmlLinkDescriptor](../types/react_router.HtmlLinkDescriptor.html) ,     | "href"     | "rel"     | "type"     | "sizes"     | "imageSrcSet"     | "imageSizes"     | "as"     | "color"     | "title"\> * PageLinkDescriptor ##### Index ### Properties [crossOrigin?](react_router.PageLinkDescriptor.html#crossOrigin) [disabled?](react_router.PageLinkDescriptor.html#disabled) [hrefLang?](react_router.PageLinkDescriptor.html#hrefLang) [integrity?](react_router.PageLinkDescriptor.html#integrity) [media?](react_router.PageLinkDescriptor.html#media) [page](react_router.PageLinkDescriptor.html#page) [referrerPolicy?](react_router.PageLinkDescriptor.html#referrerPolicy) Properties ---------- ### `Optional`crossOrigin[](#crossOrigin) crossOrigin?: "anonymous" | "use-credentials" How the element handles crossorigin requests ### `Optional`disabled[](#disabled) disabled?: boolean Whether the link is disabled ### `Optional`hrefLang[](#hrefLang) hrefLang?: string Language of the linked resource ### `Optional`integrity[](#integrity) integrity?: string Integrity metadata used in Subresource Integrity checks ### `Optional`media[](#media) media?: string Applicable media: "screen", "print", "(max-width: 764px)" ### page[](#page) page: string The absolute path of the page to prefetch. ### `Optional`referrerPolicy[](#referrerPolicy) referrerPolicy?:     | ""     | "no-referrer"     | "no-referrer-when-downgrade"     | "same-origin"     | "origin"     | "strict-origin"     | "origin-when-cross-origin"     | "strict-origin-when-cross-origin"     | "unsafe-url" Referrer policy for fetches initiated by the element ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [crossOrigin](#crossOrigin) [disabled](#disabled) [hrefLang](#hrefLang) [integrity](#integrity) [media](#media) [page](#page) [referrerPolicy](#referrerPolicy) --- # Path | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [Path](react_router.Path.html) Interface Path ============== The pathname, search, and hash values of a URL. interface Path {     [hash](react_router.Path.html#hash) : string;     [pathname](react_router.Path.html#pathname) : string;     [search](react_router.Path.html#search) : string; } #### Hierarchy ([view full](../hierarchy.html#react-router.Path) ) * Path * [Location](react_router.Location.html) ##### Index ### Properties [hash](react_router.Path.html#hash) [pathname](react_router.Path.html#pathname) [search](react_router.Path.html#search) Properties ---------- ### hash[](#hash) hash: string A URL fragment identifier, beginning with a #. ### pathname[](#pathname) pathname: string A URL pathname, beginning with a /. ### search[](#search) search: string A URL search string, beginning with a ?. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [hash](#hash) [pathname](#pathname) [search](#search) --- # PathMatch | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [PathMatch](react_router.PathMatch.html) Interface PathMatch ============================= A PathMatch contains info about how a PathPattern matched on a URL pathname. interface PathMatch<[ParamKey](react_router.PathMatch.html#ParamKey) \> {     [params](react_router.PathMatch.html#params) : [Params](../types/react_router.Params.html) <[ParamKey](react_router.PathMatch.html#ParamKey) \>;     [pathname](react_router.PathMatch.html#pathname) : string;     [pathnameBase](react_router.PathMatch.html#pathnameBase) : string;     [pattern](react_router.PathMatch.html#pattern) : [PathPattern](react_router.PathPattern.html) ; } #### Type Parameters * ParamKey extends string = string ##### Index ### Properties [params](react_router.PathMatch.html#params) [pathname](react_router.PathMatch.html#pathname) [pathnameBase](react_router.PathMatch.html#pathnameBase) [pattern](react_router.PathMatch.html#pattern) Properties ---------- ### params[](#params) params: [Params](../types/react_router.Params.html) <[ParamKey](react_router.PathMatch.html#ParamKey) \> The names and values of dynamic parameters in the URL. ### pathname[](#pathname) pathname: string The portion of the URL pathname that was matched. ### pathnameBase[](#pathnameBase) pathnameBase: string The portion of the URL pathname that was matched before child routes. ### pattern[](#pattern) pattern: [PathPattern](react_router.PathPattern.html) The pattern that was used to match. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [params](#params) [pathname](#pathname) [pathnameBase](#pathnameBase) [pattern](#pattern) --- # LinkProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [LinkProps](react_router.LinkProps.html) Interface LinkProps =================== interface LinkProps {     [about](react_router.LinkProps.html#about) ?: string;     [accessKey](react_router.LinkProps.html#accessKey) ?: string;     [aria-activedescendant](react_router.LinkProps.html#aria_activedescendant) ?: string;     [aria-atomic](react_router.LinkProps.html#aria_atomic) ?: Booleanish;     [aria-autocomplete](react_router.LinkProps.html#aria_autocomplete) ?:         | "none"         | "list"         | "inline"         | "both";     [aria-braillelabel](react_router.LinkProps.html#aria_braillelabel) ?: string;     [aria-brailleroledescription](react_router.LinkProps.html#aria_brailleroledescription) ?: string;     [aria-busy](react_router.LinkProps.html#aria_busy) ?: Booleanish;     [aria-checked](react_router.LinkProps.html#aria_checked) ?:         | boolean         | "true"         | "false"         | "mixed";     [aria-colcount](react_router.LinkProps.html#aria_colcount) ?: number;     [aria-colindex](react_router.LinkProps.html#aria_colindex) ?: number;     [aria-colindextext](react_router.LinkProps.html#aria_colindextext) ?: string;     [aria-colspan](react_router.LinkProps.html#aria_colspan) ?: number;     [aria-controls](react_router.LinkProps.html#aria_controls) ?: string;     [aria-current](react_router.LinkProps.html#aria_current) ?:         | boolean         | "time"         | "true"         | "location"         | "page"         | "step"         | "false"         | "date";     [aria-describedby](react_router.LinkProps.html#aria_describedby) ?: string;     [aria-description](react_router.LinkProps.html#aria_description) ?: string;     [aria-details](react_router.LinkProps.html#aria_details) ?: string;     [aria-disabled](react_router.LinkProps.html#aria_disabled) ?: Booleanish;     [aria-dropeffect](react_router.LinkProps.html#aria_dropeffect) ?:         | "link"         | "copy"         | "none"         | "execute"         | "move"         | "popup";     [aria-errormessage](react_router.LinkProps.html#aria_errormessage) ?: string;     [aria-expanded](react_router.LinkProps.html#aria_expanded) ?: Booleanish;     [aria-flowto](react_router.LinkProps.html#aria_flowto) ?: string;     [aria-grabbed](react_router.LinkProps.html#aria_grabbed) ?: Booleanish;     [aria-haspopup](react_router.LinkProps.html#aria_haspopup) ?:         | boolean         | "dialog"         | "menu"         | "true"         | "false"         | "grid"         | "listbox"         | "tree";     [aria-hidden](react_router.LinkProps.html#aria_hidden) ?: Booleanish;     [aria-invalid](react_router.LinkProps.html#aria_invalid) ?:         | boolean         | "true"         | "false"         | "grammar"         | "spelling";     [aria-keyshortcuts](react_router.LinkProps.html#aria_keyshortcuts) ?: string;     [aria-label](react_router.LinkProps.html#aria_label) ?: string;     [aria-labelledby](react_router.LinkProps.html#aria_labelledby) ?: string;     [aria-level](react_router.LinkProps.html#aria_level) ?: number;     [aria-live](react_router.LinkProps.html#aria_live) ?: "off" | "assertive" | "polite";     [aria-modal](react_router.LinkProps.html#aria_modal) ?: Booleanish;     [aria-multiline](react_router.LinkProps.html#aria_multiline) ?: Booleanish;     [aria-multiselectable](react_router.LinkProps.html#aria_multiselectable) ?: Booleanish;     [aria-orientation](react_router.LinkProps.html#aria_orientation) ?: "horizontal" | "vertical";     [aria-owns](react_router.LinkProps.html#aria_owns) ?: string;     [aria-placeholder](react_router.LinkProps.html#aria_placeholder) ?: string;     [aria-posinset](react_router.LinkProps.html#aria_posinset) ?: number;     [aria-pressed](react_router.LinkProps.html#aria_pressed) ?:         | boolean         | "true"         | "false"         | "mixed";     [aria-readonly](react_router.LinkProps.html#aria_readonly) ?: Booleanish;     [aria-relevant](react_router.LinkProps.html#aria_relevant) ?:         | "text"         | "additions"         | "additions removals"         | "additions text"         | "all"         | "removals"         | "removals additions"         | "removals text"         | "text additions"         | "text removals";     [aria-required](react_router.LinkProps.html#aria_required) ?: Booleanish;     [aria-roledescription](react_router.LinkProps.html#aria_roledescription) ?: string;     [aria-rowcount](react_router.LinkProps.html#aria_rowcount) ?: number;     [aria-rowindex](react_router.LinkProps.html#aria_rowindex) ?: number;     [aria-rowindextext](react_router.LinkProps.html#aria_rowindextext) ?: string;     [aria-rowspan](react_router.LinkProps.html#aria_rowspan) ?: number;     [aria-selected](react_router.LinkProps.html#aria_selected) ?: Booleanish;     [aria-setsize](react_router.LinkProps.html#aria_setsize) ?: number;     [aria-sort](react_router.LinkProps.html#aria_sort) ?:         | "none"         | "ascending"         | "descending"         | "other";     [aria-valuemax](react_router.LinkProps.html#aria_valuemax) ?: number;     [aria-valuemin](react_router.LinkProps.html#aria_valuemin) ?: number;     [aria-valuenow](react_router.LinkProps.html#aria_valuenow) ?: number;     [aria-valuetext](react_router.LinkProps.html#aria_valuetext) ?: string;     [autoCapitalize](react_router.LinkProps.html#autoCapitalize) ?: string;     [autoCorrect](react_router.LinkProps.html#autoCorrect) ?: string;     [autoFocus](react_router.LinkProps.html#autoFocus) ?: boolean;     [autoSave](react_router.LinkProps.html#autoSave) ?: string;     [children](react_router.LinkProps.html#children) ?: ReactNode;     [className](react_router.LinkProps.html#className) ?: string;     [color](react_router.LinkProps.html#color) ?: string;     [content](react_router.LinkProps.html#content) ?: string;     [contentEditable](react_router.LinkProps.html#contentEditable) ?: Booleanish | "inherit";     [contextMenu](react_router.LinkProps.html#contextMenu) ?: string;     [dangerouslySetInnerHTML](react_router.LinkProps.html#dangerouslySetInnerHTML) ?: {         \_\_html: string | TrustedHTML;     };     [datatype](react_router.LinkProps.html#datatype) ?: string;     [defaultChecked](react_router.LinkProps.html#defaultChecked) ?: boolean;     [defaultValue](react_router.LinkProps.html#defaultValue) ?: string | number | readonly string\[\];     [dir](react_router.LinkProps.html#dir) ?: string;     [discover](react_router.LinkProps.html#discover) ?: DiscoverBehavior;     [download](react_router.LinkProps.html#download) ?: any;     [draggable](react_router.LinkProps.html#draggable) ?: Booleanish;     [hidden](react_router.LinkProps.html#hidden) ?: boolean;     [hrefLang](react_router.LinkProps.html#hrefLang) ?: string;     [id](react_router.LinkProps.html#id) ?: string;     [inlist](react_router.LinkProps.html#inlist) ?: any;     [inputMode](react_router.LinkProps.html#inputMode) ?:         | "search"         | "text"         | "url"         | "none"         | "tel"         | "email"         | "numeric"         | "decimal";     [is](react_router.LinkProps.html#is) ?: string;     [itemID](react_router.LinkProps.html#itemID) ?: string;     [itemProp](react_router.LinkProps.html#itemProp) ?: string;     [itemRef](react_router.LinkProps.html#itemRef) ?: string;     [itemScope](react_router.LinkProps.html#itemScope) ?: boolean;     [itemType](react_router.LinkProps.html#itemType) ?: string;     [lang](react_router.LinkProps.html#lang) ?: string;     [media](react_router.LinkProps.html#media) ?: string;     [nonce](react_router.LinkProps.html#nonce) ?: string;     [onAbort](react_router.LinkProps.html#onAbort) ?: ReactEventHandler;     [onAbortCapture](react_router.LinkProps.html#onAbortCapture) ?: ReactEventHandler;     [onAnimationEnd](react_router.LinkProps.html#onAnimationEnd) ?: AnimationEventHandler;     [onAnimationEndCapture](react_router.LinkProps.html#onAnimationEndCapture) ?: AnimationEventHandler;     [onAnimationIteration](react_router.LinkProps.html#onAnimationIteration) ?: AnimationEventHandler;     [onAnimationIterationCapture](react_router.LinkProps.html#onAnimationIterationCapture) ?: AnimationEventHandler;     [onAnimationStart](react_router.LinkProps.html#onAnimationStart) ?: AnimationEventHandler;     [onAnimationStartCapture](react_router.LinkProps.html#onAnimationStartCapture) ?: AnimationEventHandler;     [onAuxClick](react_router.LinkProps.html#onAuxClick) ?: MouseEventHandler;     [onAuxClickCapture](react_router.LinkProps.html#onAuxClickCapture) ?: MouseEventHandler;     [onBeforeInput](react_router.LinkProps.html#onBeforeInput) ?: FormEventHandler;     [onBeforeInputCapture](react_router.LinkProps.html#onBeforeInputCapture) ?: FormEventHandler;     [onBlur](react_router.LinkProps.html#onBlur) ?: FocusEventHandler;     [onBlurCapture](react_router.LinkProps.html#onBlurCapture) ?: FocusEventHandler;     [onCanPlay](react_router.LinkProps.html#onCanPlay) ?: ReactEventHandler;     [onCanPlayCapture](react_router.LinkProps.html#onCanPlayCapture) ?: ReactEventHandler;     [onCanPlayThrough](react_router.LinkProps.html#onCanPlayThrough) ?: ReactEventHandler;     [onCanPlayThroughCapture](react_router.LinkProps.html#onCanPlayThroughCapture) ?: ReactEventHandler;     [onChange](react_router.LinkProps.html#onChange) ?: FormEventHandler;     [onChangeCapture](react_router.LinkProps.html#onChangeCapture) ?: FormEventHandler;     [onClick](react_router.LinkProps.html#onClick) ?: MouseEventHandler;     [onClickCapture](react_router.LinkProps.html#onClickCapture) ?: MouseEventHandler;     [onCompositionEnd](react_router.LinkProps.html#onCompositionEnd) ?: CompositionEventHandler;     [onCompositionEndCapture](react_router.LinkProps.html#onCompositionEndCapture) ?: CompositionEventHandler;     [onCompositionStart](react_router.LinkProps.html#onCompositionStart) ?: CompositionEventHandler;     [onCompositionStartCapture](react_router.LinkProps.html#onCompositionStartCapture) ?: CompositionEventHandler;     [onCompositionUpdate](react_router.LinkProps.html#onCompositionUpdate) ?: CompositionEventHandler;     [onCompositionUpdateCapture](react_router.LinkProps.html#onCompositionUpdateCapture) ?: CompositionEventHandler;     [onContextMenu](react_router.LinkProps.html#onContextMenu) ?: MouseEventHandler;     [onContextMenuCapture](react_router.LinkProps.html#onContextMenuCapture) ?: MouseEventHandler;     [onCopy](react_router.LinkProps.html#onCopy) ?: ClipboardEventHandler;     [onCopyCapture](react_router.LinkProps.html#onCopyCapture) ?: ClipboardEventHandler;     [onCut](react_router.LinkProps.html#onCut) ?: ClipboardEventHandler;     [onCutCapture](react_router.LinkProps.html#onCutCapture) ?: ClipboardEventHandler;     [onDoubleClick](react_router.LinkProps.html#onDoubleClick) ?: MouseEventHandler;     [onDoubleClickCapture](react_router.LinkProps.html#onDoubleClickCapture) ?: MouseEventHandler;     [onDrag](react_router.LinkProps.html#onDrag) ?: DragEventHandler;     [onDragCapture](react_router.LinkProps.html#onDragCapture) ?: DragEventHandler;     [onDragEnd](react_router.LinkProps.html#onDragEnd) ?: DragEventHandler;     [onDragEndCapture](react_router.LinkProps.html#onDragEndCapture) ?: DragEventHandler;     [onDragEnter](react_router.LinkProps.html#onDragEnter) ?: DragEventHandler;     [onDragEnterCapture](react_router.LinkProps.html#onDragEnterCapture) ?: DragEventHandler;     [onDragExit](react_router.LinkProps.html#onDragExit) ?: DragEventHandler;     [onDragExitCapture](react_router.LinkProps.html#onDragExitCapture) ?: DragEventHandler;     [onDragLeave](react_router.LinkProps.html#onDragLeave) ?: DragEventHandler;     [onDragLeaveCapture](react_router.LinkProps.html#onDragLeaveCapture) ?: DragEventHandler;     [onDragOver](react_router.LinkProps.html#onDragOver) ?: DragEventHandler;     [onDragOverCapture](react_router.LinkProps.html#onDragOverCapture) ?: DragEventHandler;     [onDragStart](react_router.LinkProps.html#onDragStart) ?: DragEventHandler;     [onDragStartCapture](react_router.LinkProps.html#onDragStartCapture) ?: DragEventHandler;     [onDrop](react_router.LinkProps.html#onDrop) ?: DragEventHandler;     [onDropCapture](react_router.LinkProps.html#onDropCapture) ?: DragEventHandler;     [onDurationChange](react_router.LinkProps.html#onDurationChange) ?: ReactEventHandler;     [onDurationChangeCapture](react_router.LinkProps.html#onDurationChangeCapture) ?: ReactEventHandler;     [onEmptied](react_router.LinkProps.html#onEmptied) ?: ReactEventHandler;     [onEmptiedCapture](react_router.LinkProps.html#onEmptiedCapture) ?: ReactEventHandler;     [onEncrypted](react_router.LinkProps.html#onEncrypted) ?: ReactEventHandler;     [onEncryptedCapture](react_router.LinkProps.html#onEncryptedCapture) ?: ReactEventHandler;     [onEnded](react_router.LinkProps.html#onEnded) ?: ReactEventHandler;     [onEndedCapture](react_router.LinkProps.html#onEndedCapture) ?: ReactEventHandler;     [onError](react_router.LinkProps.html#onError) ?: ReactEventHandler;     [onErrorCapture](react_router.LinkProps.html#onErrorCapture) ?: ReactEventHandler;     [onFocus](react_router.LinkProps.html#onFocus) ?: FocusEventHandler;     [onFocusCapture](react_router.LinkProps.html#onFocusCapture) ?: FocusEventHandler;     [onGotPointerCapture](react_router.LinkProps.html#onGotPointerCapture) ?: PointerEventHandler;     [onGotPointerCaptureCapture](react_router.LinkProps.html#onGotPointerCaptureCapture) ?: PointerEventHandler;     [onInput](react_router.LinkProps.html#onInput) ?: FormEventHandler;     [onInputCapture](react_router.LinkProps.html#onInputCapture) ?: FormEventHandler;     [onInvalid](react_router.LinkProps.html#onInvalid) ?: FormEventHandler;     [onInvalidCapture](react_router.LinkProps.html#onInvalidCapture) ?: FormEventHandler;     [onKeyDown](react_router.LinkProps.html#onKeyDown) ?: KeyboardEventHandler;     [onKeyDownCapture](react_router.LinkProps.html#onKeyDownCapture) ?: KeyboardEventHandler;     [onKeyPress](react_router.LinkProps.html#onKeyPress) ?: KeyboardEventHandler;     [onKeyPressCapture](react_router.LinkProps.html#onKeyPressCapture) ?: KeyboardEventHandler;     [onKeyUp](react_router.LinkProps.html#onKeyUp) ?: KeyboardEventHandler;     [onKeyUpCapture](react_router.LinkProps.html#onKeyUpCapture) ?: KeyboardEventHandler;     [onLoad](react_router.LinkProps.html#onLoad) ?: ReactEventHandler;     [onLoadCapture](react_router.LinkProps.html#onLoadCapture) ?: ReactEventHandler;     [onLoadedData](react_router.LinkProps.html#onLoadedData) ?: ReactEventHandler;     [onLoadedDataCapture](react_router.LinkProps.html#onLoadedDataCapture) ?: ReactEventHandler;     [onLoadedMetadata](react_router.LinkProps.html#onLoadedMetadata) ?: ReactEventHandler;     [onLoadedMetadataCapture](react_router.LinkProps.html#onLoadedMetadataCapture) ?: ReactEventHandler;     [onLoadStart](react_router.LinkProps.html#onLoadStart) ?: ReactEventHandler;     [onLoadStartCapture](react_router.LinkProps.html#onLoadStartCapture) ?: ReactEventHandler;     [onLostPointerCapture](react_router.LinkProps.html#onLostPointerCapture) ?: PointerEventHandler;     [onLostPointerCaptureCapture](react_router.LinkProps.html#onLostPointerCaptureCapture) ?: PointerEventHandler;     [onMouseDown](react_router.LinkProps.html#onMouseDown) ?: MouseEventHandler;     [onMouseDownCapture](react_router.LinkProps.html#onMouseDownCapture) ?: MouseEventHandler;     [onMouseEnter](react_router.LinkProps.html#onMouseEnter) ?: MouseEventHandler;     [onMouseLeave](react_router.LinkProps.html#onMouseLeave) ?: MouseEventHandler;     [onMouseMove](react_router.LinkProps.html#onMouseMove) ?: MouseEventHandler;     [onMouseMoveCapture](react_router.LinkProps.html#onMouseMoveCapture) ?: MouseEventHandler;     [onMouseOut](react_router.LinkProps.html#onMouseOut) ?: MouseEventHandler;     [onMouseOutCapture](react_router.LinkProps.html#onMouseOutCapture) ?: MouseEventHandler;     [onMouseOver](react_router.LinkProps.html#onMouseOver) ?: MouseEventHandler;     [onMouseOverCapture](react_router.LinkProps.html#onMouseOverCapture) ?: MouseEventHandler;     [onMouseUp](react_router.LinkProps.html#onMouseUp) ?: MouseEventHandler;     [onMouseUpCapture](react_router.LinkProps.html#onMouseUpCapture) ?: MouseEventHandler;     [onPaste](react_router.LinkProps.html#onPaste) ?: ClipboardEventHandler;     [onPasteCapture](react_router.LinkProps.html#onPasteCapture) ?: ClipboardEventHandler;     [onPause](react_router.LinkProps.html#onPause) ?: ReactEventHandler;     [onPauseCapture](react_router.LinkProps.html#onPauseCapture) ?: ReactEventHandler;     [onPlay](react_router.LinkProps.html#onPlay) ?: ReactEventHandler;     [onPlayCapture](react_router.LinkProps.html#onPlayCapture) ?: ReactEventHandler;     [onPlaying](react_router.LinkProps.html#onPlaying) ?: ReactEventHandler;     [onPlayingCapture](react_router.LinkProps.html#onPlayingCapture) ?: ReactEventHandler;     [onPointerCancel](react_router.LinkProps.html#onPointerCancel) ?: PointerEventHandler;     [onPointerCancelCapture](react_router.LinkProps.html#onPointerCancelCapture) ?: PointerEventHandler;     [onPointerDown](react_router.LinkProps.html#onPointerDown) ?: PointerEventHandler;     [onPointerDownCapture](react_router.LinkProps.html#onPointerDownCapture) ?: PointerEventHandler;     [onPointerEnter](react_router.LinkProps.html#onPointerEnter) ?: PointerEventHandler;     [onPointerEnterCapture](react_router.LinkProps.html#onPointerEnterCapture) ?: PointerEventHandler;     [onPointerLeave](react_router.LinkProps.html#onPointerLeave) ?: PointerEventHandler;     [onPointerLeaveCapture](react_router.LinkProps.html#onPointerLeaveCapture) ?: PointerEventHandler;     [onPointerMove](react_router.LinkProps.html#onPointerMove) ?: PointerEventHandler;     [onPointerMoveCapture](react_router.LinkProps.html#onPointerMoveCapture) ?: PointerEventHandler;     [onPointerOut](react_router.LinkProps.html#onPointerOut) ?: PointerEventHandler;     [onPointerOutCapture](react_router.LinkProps.html#onPointerOutCapture) ?: PointerEventHandler;     [onPointerOver](react_router.LinkProps.html#onPointerOver) ?: PointerEventHandler;     [onPointerOverCapture](react_router.LinkProps.html#onPointerOverCapture) ?: PointerEventHandler;     [onPointerUp](react_router.LinkProps.html#onPointerUp) ?: PointerEventHandler;     [onPointerUpCapture](react_router.LinkProps.html#onPointerUpCapture) ?: PointerEventHandler;     [onProgress](react_router.LinkProps.html#onProgress) ?: ReactEventHandler;     [onProgressCapture](react_router.LinkProps.html#onProgressCapture) ?: ReactEventHandler;     [onRateChange](react_router.LinkProps.html#onRateChange) ?: ReactEventHandler;     [onRateChangeCapture](react_router.LinkProps.html#onRateChangeCapture) ?: ReactEventHandler;     [onReset](react_router.LinkProps.html#onReset) ?: FormEventHandler;     [onResetCapture](react_router.LinkProps.html#onResetCapture) ?: FormEventHandler;     [onResize](react_router.LinkProps.html#onResize) ?: ReactEventHandler;     [onResizeCapture](react_router.LinkProps.html#onResizeCapture) ?: ReactEventHandler;     [onScroll](react_router.LinkProps.html#onScroll) ?: UIEventHandler;     [onScrollCapture](react_router.LinkProps.html#onScrollCapture) ?: UIEventHandler;     [onSeeked](react_router.LinkProps.html#onSeeked) ?: ReactEventHandler;     [onSeekedCapture](react_router.LinkProps.html#onSeekedCapture) ?: ReactEventHandler;     [onSeeking](react_router.LinkProps.html#onSeeking) ?: ReactEventHandler;     [onSeekingCapture](react_router.LinkProps.html#onSeekingCapture) ?: ReactEventHandler;     [onSelect](react_router.LinkProps.html#onSelect) ?: ReactEventHandler;     [onSelectCapture](react_router.LinkProps.html#onSelectCapture) ?: ReactEventHandler;     [onStalled](react_router.LinkProps.html#onStalled) ?: ReactEventHandler;     [onStalledCapture](react_router.LinkProps.html#onStalledCapture) ?: ReactEventHandler;     [onSubmit](react_router.LinkProps.html#onSubmit) ?: FormEventHandler;     [onSubmitCapture](react_router.LinkProps.html#onSubmitCapture) ?: FormEventHandler;     [onSuspend](react_router.LinkProps.html#onSuspend) ?: ReactEventHandler;     [onSuspendCapture](react_router.LinkProps.html#onSuspendCapture) ?: ReactEventHandler;     [onTimeUpdate](react_router.LinkProps.html#onTimeUpdate) ?: ReactEventHandler;     [onTimeUpdateCapture](react_router.LinkProps.html#onTimeUpdateCapture) ?: ReactEventHandler;     [onTouchCancel](react_router.LinkProps.html#onTouchCancel) ?: TouchEventHandler;     [onTouchCancelCapture](react_router.LinkProps.html#onTouchCancelCapture) ?: TouchEventHandler;     [onTouchEnd](react_router.LinkProps.html#onTouchEnd) ?: TouchEventHandler;     [onTouchEndCapture](react_router.LinkProps.html#onTouchEndCapture) ?: TouchEventHandler;     [onTouchMove](react_router.LinkProps.html#onTouchMove) ?: TouchEventHandler;     [onTouchMoveCapture](react_router.LinkProps.html#onTouchMoveCapture) ?: TouchEventHandler;     [onTouchStart](react_router.LinkProps.html#onTouchStart) ?: TouchEventHandler;     [onTouchStartCapture](react_router.LinkProps.html#onTouchStartCapture) ?: TouchEventHandler;     [onTransitionEnd](react_router.LinkProps.html#onTransitionEnd) ?: TransitionEventHandler;     [onTransitionEndCapture](react_router.LinkProps.html#onTransitionEndCapture) ?: TransitionEventHandler;     [onVolumeChange](react_router.LinkProps.html#onVolumeChange) ?: ReactEventHandler;     [onVolumeChangeCapture](react_router.LinkProps.html#onVolumeChangeCapture) ?: ReactEventHandler;     [onWaiting](react_router.LinkProps.html#onWaiting) ?: ReactEventHandler;     [onWaitingCapture](react_router.LinkProps.html#onWaitingCapture) ?: ReactEventHandler;     [onWheel](react_router.LinkProps.html#onWheel) ?: WheelEventHandler;     [onWheelCapture](react_router.LinkProps.html#onWheelCapture) ?: WheelEventHandler;     [ping](react_router.LinkProps.html#ping) ?: string;     [placeholder](react_router.LinkProps.html#placeholder) ?: string;     [prefetch](react_router.LinkProps.html#prefetch) ?: PrefetchBehavior;     [prefix](react_router.LinkProps.html#prefix) ?: string;     [preventScrollReset](react_router.LinkProps.html#preventScrollReset) ?: boolean;     [property](react_router.LinkProps.html#property) ?: string;     [radioGroup](react_router.LinkProps.html#radioGroup) ?: string;     [referrerPolicy](react_router.LinkProps.html#referrerPolicy) ?: HTMLAttributeReferrerPolicy;     [rel](react_router.LinkProps.html#rel) ?: string;     [relative](react_router.LinkProps.html#relative) ?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) ;     [reloadDocument](react_router.LinkProps.html#reloadDocument) ?: boolean;     [replace](react_router.LinkProps.html#replace) ?: boolean;     [resource](react_router.LinkProps.html#resource) ?: string;     [results](react_router.LinkProps.html#results) ?: number;     [rev](react_router.LinkProps.html#rev) ?: string;     [role](react_router.LinkProps.html#role) ?: AriaRole;     [security](react_router.LinkProps.html#security) ?: string;     [slot](react_router.LinkProps.html#slot) ?: string;     [spellCheck](react_router.LinkProps.html#spellCheck) ?: Booleanish;     [state](react_router.LinkProps.html#state) ?: any;     [style](react_router.LinkProps.html#style) ?: CSSProperties;     [suppressContentEditableWarning](react_router.LinkProps.html#suppressContentEditableWarning) ?: boolean;     [suppressHydrationWarning](react_router.LinkProps.html#suppressHydrationWarning) ?: boolean;     [tabIndex](react_router.LinkProps.html#tabIndex) ?: number;     [target](react_router.LinkProps.html#target) ?: HTMLAttributeAnchorTarget;     [title](react_router.LinkProps.html#title) ?: string;     [to](react_router.LinkProps.html#to) : [To](../types/react_router.To.html) ;     [translate](react_router.LinkProps.html#translate) ?: "yes" | "no";     [type](react_router.LinkProps.html#type) ?: string;     [typeof](react_router.LinkProps.html#typeof) ?: string;     [unselectable](react_router.LinkProps.html#unselectable) ?: "on" | "off";     [viewTransition](react_router.LinkProps.html#viewTransition) ?: boolean;     [vocab](react_router.LinkProps.html#vocab) ?: string; } #### Hierarchy * Omit, "href"\> * LinkProps ##### Index ### Properties [about?](react_router.LinkProps.html#about) [accessKey?](react_router.LinkProps.html#accessKey) [aria-activedescendant?](react_router.LinkProps.html#aria_activedescendant) [aria-atomic?](react_router.LinkProps.html#aria_atomic) [aria-autocomplete?](react_router.LinkProps.html#aria_autocomplete) [aria-braillelabel?](react_router.LinkProps.html#aria_braillelabel) [aria-brailleroledescription?](react_router.LinkProps.html#aria_brailleroledescription) [aria-busy?](react_router.LinkProps.html#aria_busy) [aria-checked?](react_router.LinkProps.html#aria_checked) [aria-colcount?](react_router.LinkProps.html#aria_colcount) [aria-colindex?](react_router.LinkProps.html#aria_colindex) [aria-colindextext?](react_router.LinkProps.html#aria_colindextext) [aria-colspan?](react_router.LinkProps.html#aria_colspan) [aria-controls?](react_router.LinkProps.html#aria_controls) [aria-current?](react_router.LinkProps.html#aria_current) [aria-describedby?](react_router.LinkProps.html#aria_describedby) [aria-description?](react_router.LinkProps.html#aria_description) [aria-details?](react_router.LinkProps.html#aria_details) [aria-disabled?](react_router.LinkProps.html#aria_disabled) [aria-dropeffect?](react_router.LinkProps.html#aria_dropeffect) [aria-errormessage?](react_router.LinkProps.html#aria_errormessage) [aria-expanded?](react_router.LinkProps.html#aria_expanded) [aria-flowto?](react_router.LinkProps.html#aria_flowto) [aria-grabbed?](react_router.LinkProps.html#aria_grabbed) [aria-haspopup?](react_router.LinkProps.html#aria_haspopup) [aria-hidden?](react_router.LinkProps.html#aria_hidden) [aria-invalid?](react_router.LinkProps.html#aria_invalid) [aria-keyshortcuts?](react_router.LinkProps.html#aria_keyshortcuts) [aria-label?](react_router.LinkProps.html#aria_label) [aria-labelledby?](react_router.LinkProps.html#aria_labelledby) [aria-level?](react_router.LinkProps.html#aria_level) [aria-live?](react_router.LinkProps.html#aria_live) [aria-modal?](react_router.LinkProps.html#aria_modal) [aria-multiline?](react_router.LinkProps.html#aria_multiline) [aria-multiselectable?](react_router.LinkProps.html#aria_multiselectable) [aria-orientation?](react_router.LinkProps.html#aria_orientation) [aria-owns?](react_router.LinkProps.html#aria_owns) [aria-placeholder?](react_router.LinkProps.html#aria_placeholder) [aria-posinset?](react_router.LinkProps.html#aria_posinset) [aria-pressed?](react_router.LinkProps.html#aria_pressed) [aria-readonly?](react_router.LinkProps.html#aria_readonly) [aria-relevant?](react_router.LinkProps.html#aria_relevant) [aria-required?](react_router.LinkProps.html#aria_required) [aria-roledescription?](react_router.LinkProps.html#aria_roledescription) [aria-rowcount?](react_router.LinkProps.html#aria_rowcount) [aria-rowindex?](react_router.LinkProps.html#aria_rowindex) [aria-rowindextext?](react_router.LinkProps.html#aria_rowindextext) [aria-rowspan?](react_router.LinkProps.html#aria_rowspan) [aria-selected?](react_router.LinkProps.html#aria_selected) [aria-setsize?](react_router.LinkProps.html#aria_setsize) [aria-sort?](react_router.LinkProps.html#aria_sort) [aria-valuemax?](react_router.LinkProps.html#aria_valuemax) [aria-valuemin?](react_router.LinkProps.html#aria_valuemin) [aria-valuenow?](react_router.LinkProps.html#aria_valuenow) [aria-valuetext?](react_router.LinkProps.html#aria_valuetext) [autoCapitalize?](react_router.LinkProps.html#autoCapitalize) [autoCorrect?](react_router.LinkProps.html#autoCorrect) [autoFocus?](react_router.LinkProps.html#autoFocus) [autoSave?](react_router.LinkProps.html#autoSave) [children?](react_router.LinkProps.html#children) [className?](react_router.LinkProps.html#className) [color?](react_router.LinkProps.html#color) [content?](react_router.LinkProps.html#content) [contentEditable?](react_router.LinkProps.html#contentEditable) [contextMenu?](react_router.LinkProps.html#contextMenu) [dangerouslySetInnerHTML?](react_router.LinkProps.html#dangerouslySetInnerHTML) [datatype?](react_router.LinkProps.html#datatype) [defaultChecked?](react_router.LinkProps.html#defaultChecked) [defaultValue?](react_router.LinkProps.html#defaultValue) [dir?](react_router.LinkProps.html#dir) [discover?](react_router.LinkProps.html#discover) [download?](react_router.LinkProps.html#download) [draggable?](react_router.LinkProps.html#draggable) [hidden?](react_router.LinkProps.html#hidden) [hrefLang?](react_router.LinkProps.html#hrefLang) [id?](react_router.LinkProps.html#id) [inlist?](react_router.LinkProps.html#inlist) [inputMode?](react_router.LinkProps.html#inputMode) [is?](react_router.LinkProps.html#is) [itemID?](react_router.LinkProps.html#itemID) [itemProp?](react_router.LinkProps.html#itemProp) [itemRef?](react_router.LinkProps.html#itemRef) [itemScope?](react_router.LinkProps.html#itemScope) [itemType?](react_router.LinkProps.html#itemType) [lang?](react_router.LinkProps.html#lang) [media?](react_router.LinkProps.html#media) [nonce?](react_router.LinkProps.html#nonce) [onAbort?](react_router.LinkProps.html#onAbort) [onAbortCapture?](react_router.LinkProps.html#onAbortCapture) [onAnimationEnd?](react_router.LinkProps.html#onAnimationEnd) [onAnimationEndCapture?](react_router.LinkProps.html#onAnimationEndCapture) [onAnimationIteration?](react_router.LinkProps.html#onAnimationIteration) [onAnimationIterationCapture?](react_router.LinkProps.html#onAnimationIterationCapture) [onAnimationStart?](react_router.LinkProps.html#onAnimationStart) [onAnimationStartCapture?](react_router.LinkProps.html#onAnimationStartCapture) [onAuxClick?](react_router.LinkProps.html#onAuxClick) [onAuxClickCapture?](react_router.LinkProps.html#onAuxClickCapture) [onBeforeInput?](react_router.LinkProps.html#onBeforeInput) [onBeforeInputCapture?](react_router.LinkProps.html#onBeforeInputCapture) [onBlur?](react_router.LinkProps.html#onBlur) [onBlurCapture?](react_router.LinkProps.html#onBlurCapture) [onCanPlay?](react_router.LinkProps.html#onCanPlay) [onCanPlayCapture?](react_router.LinkProps.html#onCanPlayCapture) [onCanPlayThrough?](react_router.LinkProps.html#onCanPlayThrough) [onCanPlayThroughCapture?](react_router.LinkProps.html#onCanPlayThroughCapture) [onChange?](react_router.LinkProps.html#onChange) [onChangeCapture?](react_router.LinkProps.html#onChangeCapture) [onClick?](react_router.LinkProps.html#onClick) [onClickCapture?](react_router.LinkProps.html#onClickCapture) [onCompositionEnd?](react_router.LinkProps.html#onCompositionEnd) [onCompositionEndCapture?](react_router.LinkProps.html#onCompositionEndCapture) [onCompositionStart?](react_router.LinkProps.html#onCompositionStart) [onCompositionStartCapture?](react_router.LinkProps.html#onCompositionStartCapture) [onCompositionUpdate?](react_router.LinkProps.html#onCompositionUpdate) [onCompositionUpdateCapture?](react_router.LinkProps.html#onCompositionUpdateCapture) [onContextMenu?](react_router.LinkProps.html#onContextMenu) [onContextMenuCapture?](react_router.LinkProps.html#onContextMenuCapture) [onCopy?](react_router.LinkProps.html#onCopy) [onCopyCapture?](react_router.LinkProps.html#onCopyCapture) [onCut?](react_router.LinkProps.html#onCut) [onCutCapture?](react_router.LinkProps.html#onCutCapture) [onDoubleClick?](react_router.LinkProps.html#onDoubleClick) [onDoubleClickCapture?](react_router.LinkProps.html#onDoubleClickCapture) [onDrag?](react_router.LinkProps.html#onDrag) [onDragCapture?](react_router.LinkProps.html#onDragCapture) [onDragEnd?](react_router.LinkProps.html#onDragEnd) [onDragEndCapture?](react_router.LinkProps.html#onDragEndCapture) [onDragEnter?](react_router.LinkProps.html#onDragEnter) [onDragEnterCapture?](react_router.LinkProps.html#onDragEnterCapture) [onDragExit?](react_router.LinkProps.html#onDragExit) [onDragExitCapture?](react_router.LinkProps.html#onDragExitCapture) [onDragLeave?](react_router.LinkProps.html#onDragLeave) [onDragLeaveCapture?](react_router.LinkProps.html#onDragLeaveCapture) [onDragOver?](react_router.LinkProps.html#onDragOver) [onDragOverCapture?](react_router.LinkProps.html#onDragOverCapture) [onDragStart?](react_router.LinkProps.html#onDragStart) [onDragStartCapture?](react_router.LinkProps.html#onDragStartCapture) [onDrop?](react_router.LinkProps.html#onDrop) [onDropCapture?](react_router.LinkProps.html#onDropCapture) [onDurationChange?](react_router.LinkProps.html#onDurationChange) [onDurationChangeCapture?](react_router.LinkProps.html#onDurationChangeCapture) [onEmptied?](react_router.LinkProps.html#onEmptied) [onEmptiedCapture?](react_router.LinkProps.html#onEmptiedCapture) [onEncrypted?](react_router.LinkProps.html#onEncrypted) [onEncryptedCapture?](react_router.LinkProps.html#onEncryptedCapture) [onEnded?](react_router.LinkProps.html#onEnded) [onEndedCapture?](react_router.LinkProps.html#onEndedCapture) [onError?](react_router.LinkProps.html#onError) [onErrorCapture?](react_router.LinkProps.html#onErrorCapture) [onFocus?](react_router.LinkProps.html#onFocus) [onFocusCapture?](react_router.LinkProps.html#onFocusCapture) [onGotPointerCapture?](react_router.LinkProps.html#onGotPointerCapture) [onGotPointerCaptureCapture?](react_router.LinkProps.html#onGotPointerCaptureCapture) [onInput?](react_router.LinkProps.html#onInput) [onInputCapture?](react_router.LinkProps.html#onInputCapture) [onInvalid?](react_router.LinkProps.html#onInvalid) [onInvalidCapture?](react_router.LinkProps.html#onInvalidCapture) [onKeyDown?](react_router.LinkProps.html#onKeyDown) [onKeyDownCapture?](react_router.LinkProps.html#onKeyDownCapture) [onKeyPress?](react_router.LinkProps.html#onKeyPress) [onKeyPressCapture?](react_router.LinkProps.html#onKeyPressCapture) [onKeyUp?](react_router.LinkProps.html#onKeyUp) [onKeyUpCapture?](react_router.LinkProps.html#onKeyUpCapture) [onLoad?](react_router.LinkProps.html#onLoad) [onLoadCapture?](react_router.LinkProps.html#onLoadCapture) [onLoadedData?](react_router.LinkProps.html#onLoadedData) [onLoadedDataCapture?](react_router.LinkProps.html#onLoadedDataCapture) [onLoadedMetadata?](react_router.LinkProps.html#onLoadedMetadata) [onLoadedMetadataCapture?](react_router.LinkProps.html#onLoadedMetadataCapture) [onLoadStart?](react_router.LinkProps.html#onLoadStart) [onLoadStartCapture?](react_router.LinkProps.html#onLoadStartCapture) [onLostPointerCapture?](react_router.LinkProps.html#onLostPointerCapture) [onLostPointerCaptureCapture?](react_router.LinkProps.html#onLostPointerCaptureCapture) [onMouseDown?](react_router.LinkProps.html#onMouseDown) [onMouseDownCapture?](react_router.LinkProps.html#onMouseDownCapture) [onMouseEnter?](react_router.LinkProps.html#onMouseEnter) [onMouseLeave?](react_router.LinkProps.html#onMouseLeave) [onMouseMove?](react_router.LinkProps.html#onMouseMove) [onMouseMoveCapture?](react_router.LinkProps.html#onMouseMoveCapture) [onMouseOut?](react_router.LinkProps.html#onMouseOut) [onMouseOutCapture?](react_router.LinkProps.html#onMouseOutCapture) [onMouseOver?](react_router.LinkProps.html#onMouseOver) [onMouseOverCapture?](react_router.LinkProps.html#onMouseOverCapture) [onMouseUp?](react_router.LinkProps.html#onMouseUp) [onMouseUpCapture?](react_router.LinkProps.html#onMouseUpCapture) [onPaste?](react_router.LinkProps.html#onPaste) [onPasteCapture?](react_router.LinkProps.html#onPasteCapture) [onPause?](react_router.LinkProps.html#onPause) [onPauseCapture?](react_router.LinkProps.html#onPauseCapture) [onPlay?](react_router.LinkProps.html#onPlay) [onPlayCapture?](react_router.LinkProps.html#onPlayCapture) [onPlaying?](react_router.LinkProps.html#onPlaying) [onPlayingCapture?](react_router.LinkProps.html#onPlayingCapture) [onPointerCancel?](react_router.LinkProps.html#onPointerCancel) [onPointerCancelCapture?](react_router.LinkProps.html#onPointerCancelCapture) [onPointerDown?](react_router.LinkProps.html#onPointerDown) [onPointerDownCapture?](react_router.LinkProps.html#onPointerDownCapture) [onPointerEnter?](react_router.LinkProps.html#onPointerEnter) [onPointerEnterCapture?](react_router.LinkProps.html#onPointerEnterCapture) [onPointerLeave?](react_router.LinkProps.html#onPointerLeave) [onPointerLeaveCapture?](react_router.LinkProps.html#onPointerLeaveCapture) [onPointerMove?](react_router.LinkProps.html#onPointerMove) [onPointerMoveCapture?](react_router.LinkProps.html#onPointerMoveCapture) [onPointerOut?](react_router.LinkProps.html#onPointerOut) [onPointerOutCapture?](react_router.LinkProps.html#onPointerOutCapture) [onPointerOver?](react_router.LinkProps.html#onPointerOver) [onPointerOverCapture?](react_router.LinkProps.html#onPointerOverCapture) [onPointerUp?](react_router.LinkProps.html#onPointerUp) [onPointerUpCapture?](react_router.LinkProps.html#onPointerUpCapture) [onProgress?](react_router.LinkProps.html#onProgress) [onProgressCapture?](react_router.LinkProps.html#onProgressCapture) [onRateChange?](react_router.LinkProps.html#onRateChange) [onRateChangeCapture?](react_router.LinkProps.html#onRateChangeCapture) [onReset?](react_router.LinkProps.html#onReset) [onResetCapture?](react_router.LinkProps.html#onResetCapture) [onResize?](react_router.LinkProps.html#onResize) [onResizeCapture?](react_router.LinkProps.html#onResizeCapture) [onScroll?](react_router.LinkProps.html#onScroll) [onScrollCapture?](react_router.LinkProps.html#onScrollCapture) [onSeeked?](react_router.LinkProps.html#onSeeked) [onSeekedCapture?](react_router.LinkProps.html#onSeekedCapture) [onSeeking?](react_router.LinkProps.html#onSeeking) [onSeekingCapture?](react_router.LinkProps.html#onSeekingCapture) [onSelect?](react_router.LinkProps.html#onSelect) [onSelectCapture?](react_router.LinkProps.html#onSelectCapture) [onStalled?](react_router.LinkProps.html#onStalled) [onStalledCapture?](react_router.LinkProps.html#onStalledCapture) [onSubmit?](react_router.LinkProps.html#onSubmit) [onSubmitCapture?](react_router.LinkProps.html#onSubmitCapture) [onSuspend?](react_router.LinkProps.html#onSuspend) [onSuspendCapture?](react_router.LinkProps.html#onSuspendCapture) [onTimeUpdate?](react_router.LinkProps.html#onTimeUpdate) [onTimeUpdateCapture?](react_router.LinkProps.html#onTimeUpdateCapture) [onTouchCancel?](react_router.LinkProps.html#onTouchCancel) [onTouchCancelCapture?](react_router.LinkProps.html#onTouchCancelCapture) [onTouchEnd?](react_router.LinkProps.html#onTouchEnd) [onTouchEndCapture?](react_router.LinkProps.html#onTouchEndCapture) [onTouchMove?](react_router.LinkProps.html#onTouchMove) [onTouchMoveCapture?](react_router.LinkProps.html#onTouchMoveCapture) [onTouchStart?](react_router.LinkProps.html#onTouchStart) [onTouchStartCapture?](react_router.LinkProps.html#onTouchStartCapture) [onTransitionEnd?](react_router.LinkProps.html#onTransitionEnd) [onTransitionEndCapture?](react_router.LinkProps.html#onTransitionEndCapture) [onVolumeChange?](react_router.LinkProps.html#onVolumeChange) [onVolumeChangeCapture?](react_router.LinkProps.html#onVolumeChangeCapture) [onWaiting?](react_router.LinkProps.html#onWaiting) [onWaitingCapture?](react_router.LinkProps.html#onWaitingCapture) [onWheel?](react_router.LinkProps.html#onWheel) [onWheelCapture?](react_router.LinkProps.html#onWheelCapture) [ping?](react_router.LinkProps.html#ping) [placeholder?](react_router.LinkProps.html#placeholder) [prefetch?](react_router.LinkProps.html#prefetch) [prefix?](react_router.LinkProps.html#prefix) [preventScrollReset?](react_router.LinkProps.html#preventScrollReset) [property?](react_router.LinkProps.html#property) [radioGroup?](react_router.LinkProps.html#radioGroup) [referrerPolicy?](react_router.LinkProps.html#referrerPolicy) [rel?](react_router.LinkProps.html#rel) [relative?](react_router.LinkProps.html#relative) [reloadDocument?](react_router.LinkProps.html#reloadDocument) [replace?](react_router.LinkProps.html#replace) [resource?](react_router.LinkProps.html#resource) [results?](react_router.LinkProps.html#results) [rev?](react_router.LinkProps.html#rev) [role?](react_router.LinkProps.html#role) [security?](react_router.LinkProps.html#security) [slot?](react_router.LinkProps.html#slot) [spellCheck?](react_router.LinkProps.html#spellCheck) [state?](react_router.LinkProps.html#state) [style?](react_router.LinkProps.html#style) [suppressContentEditableWarning?](react_router.LinkProps.html#suppressContentEditableWarning) [suppressHydrationWarning?](react_router.LinkProps.html#suppressHydrationWarning) [tabIndex?](react_router.LinkProps.html#tabIndex) [target?](react_router.LinkProps.html#target) [title?](react_router.LinkProps.html#title) [to](react_router.LinkProps.html#to) [translate?](react_router.LinkProps.html#translate) [type?](react_router.LinkProps.html#type) [typeof?](react_router.LinkProps.html#typeof) [unselectable?](react_router.LinkProps.html#unselectable) [viewTransition?](react_router.LinkProps.html#viewTransition) [vocab?](react_router.LinkProps.html#vocab) Properties ---------- ### `Optional`about[](#about) about?: string ### `Optional`accessKey[](#accessKey) accessKey?: string ### `Optional`aria-activedescendant[](#aria_activedescendant) aria-activedescendant?: string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. ### `Optional`aria-atomic[](#aria_atomic) aria-atomic?: Booleanish Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. ### `Optional`aria-autocomplete[](#aria_autocomplete) aria-autocomplete?:     | "none"     | "list"     | "inline"     | "both" Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. ### `Optional`aria-braillelabel[](#aria_braillelabel) aria-braillelabel?: string Defines a string value that labels the current element, which is intended to be converted into Braille. #### See[](#See) aria-label. ### `Optional`aria-brailleroledescription[](#aria_brailleroledescription) aria-brailleroledescription?: string Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. #### See[](#See-1) aria-roledescription. ### `Optional`aria-busy[](#aria_busy) aria-busy?: Booleanish ### `Optional`aria-checked[](#aria_checked) aria-checked?:     | boolean     | "true"     | "false"     | "mixed" Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. #### See[](#See-2) * aria-pressed * aria-selected. ### `Optional`aria-colcount[](#aria_colcount) aria-colcount?: number Defines the total number of columns in a table, grid, or treegrid. #### See[](#See-3) aria-colindex. ### `Optional`aria-colindex[](#aria_colindex) aria-colindex?: number Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. #### See[](#See-4) * aria-colcount * aria-colspan. ### `Optional`aria-colindextext[](#aria_colindextext) aria-colindextext?: string Defines a human readable text alternative of aria-colindex. #### See[](#See-5) aria-rowindextext. ### `Optional`aria-colspan[](#aria_colspan) aria-colspan?: number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. #### See[](#See-6) * aria-colindex * aria-rowspan. ### `Optional`aria-controls[](#aria_controls) aria-controls?: string Identifies the element (or elements) whose contents or presence are controlled by the current element. #### See[](#See-7) aria-owns. ### `Optional`aria-current[](#aria_current) aria-current?:     | boolean     | "time"     | "true"     | "location"     | "page"     | "step"     | "false"     | "date" Indicates the element that represents the current item within a container or set of related elements. ### `Optional`aria-describedby[](#aria_describedby) aria-describedby?: string Identifies the element (or elements) that describes the object. #### See[](#See-8) aria-labelledby ### `Optional`aria-description[](#aria_description) aria-description?: string Defines a string value that describes or annotates the current element. #### See[](#See-9) related aria-describedby. ### `Optional`aria-details[](#aria_details) aria-details?: string Identifies the element that provides a detailed, extended description for the object. #### See[](#See-10) aria-describedby. ### `Optional`aria-disabled[](#aria_disabled) aria-disabled?: Booleanish Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. #### See[](#See-11) * aria-hidden * aria-readonly. ### `Optional`aria-dropeffect[](#aria_dropeffect) aria-dropeffect?:     | "link"     | "copy"     | "none"     | "execute"     | "move"     | "popup" Indicates what functions can be performed when a dragged object is released on the drop target. #### Deprecated[](#Deprecated) in ARIA 1.1 ### `Optional`aria-errormessage[](#aria_errormessage) aria-errormessage?: string Identifies the element that provides an error message for the object. #### See[](#See-12) * aria-invalid * aria-describedby. ### `Optional`aria-expanded[](#aria_expanded) aria-expanded?: Booleanish Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. ### `Optional`aria-flowto[](#aria_flowto) aria-flowto?: string Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. ### `Optional`aria-grabbed[](#aria_grabbed) aria-grabbed?: Booleanish Indicates an element's "grabbed" state in a drag-and-drop operation. #### Deprecated[](#Deprecated-1) in ARIA 1.1 ### `Optional`aria-haspopup[](#aria_haspopup) aria-haspopup?:     | boolean     | "dialog"     | "menu"     | "true"     | "false"     | "grid"     | "listbox"     | "tree" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. ### `Optional`aria-hidden[](#aria_hidden) aria-hidden?: Booleanish Indicates whether the element is exposed to an accessibility API. #### See[](#See-13) aria-disabled. ### `Optional`aria-invalid[](#aria_invalid) aria-invalid?:     | boolean     | "true"     | "false"     | "grammar"     | "spelling" Indicates the entered value does not conform to the format expected by the application. #### See[](#See-14) aria-errormessage. ### `Optional`aria-keyshortcuts[](#aria_keyshortcuts) aria-keyshortcuts?: string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. ### `Optional`aria-label[](#aria_label) aria-label?: string Defines a string value that labels the current element. #### See[](#See-15) aria-labelledby. ### `Optional`aria-labelledby[](#aria_labelledby) aria-labelledby?: string Identifies the element (or elements) that labels the current element. #### See[](#See-16) aria-describedby. ### `Optional`aria-level[](#aria_level) aria-level?: number Defines the hierarchical level of an element within a structure. ### `Optional`aria-live[](#aria_live) aria-live?: "off" | "assertive" | "polite" Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. ### `Optional`aria-modal[](#aria_modal) aria-modal?: Booleanish Indicates whether an element is modal when displayed. ### `Optional`aria-multiline[](#aria_multiline) aria-multiline?: Booleanish Indicates whether a text box accepts multiple lines of input or only a single line. ### `Optional`aria-multiselectable[](#aria_multiselectable) aria-multiselectable?: Booleanish Indicates that the user may select more than one item from the current selectable descendants. ### `Optional`aria-orientation[](#aria_orientation) aria-orientation?: "horizontal" | "vertical" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. ### `Optional`aria-owns[](#aria_owns) aria-owns?: string Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. #### See[](#See-17) aria-controls. ### `Optional`aria-placeholder[](#aria_placeholder) aria-placeholder?: string Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. ### `Optional`aria-posinset[](#aria_posinset) aria-posinset?: number Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. #### See[](#See-18) aria-setsize. ### `Optional`aria-pressed[](#aria_pressed) aria-pressed?:     | boolean     | "true"     | "false"     | "mixed" Indicates the current "pressed" state of toggle buttons. #### See[](#See-19) * aria-checked * aria-selected. ### `Optional`aria-readonly[](#aria_readonly) aria-readonly?: Booleanish Indicates that the element is not editable, but is otherwise operable. #### See[](#See-20) aria-disabled. ### `Optional`aria-relevant[](#aria_relevant) aria-relevant?:     | "text"     | "additions"     | "additions removals"     | "additions text"     | "all"     | "removals"     | "removals additions"     | "removals text"     | "text additions"     | "text removals" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. #### See[](#See-21) aria-atomic. ### `Optional`aria-required[](#aria_required) aria-required?: Booleanish Indicates that user input is required on the element before a form may be submitted. ### `Optional`aria-roledescription[](#aria_roledescription) aria-roledescription?: string Defines a human-readable, author-localized description for the role of an element. ### `Optional`aria-rowcount[](#aria_rowcount) aria-rowcount?: number Defines the total number of rows in a table, grid, or treegrid. #### See[](#See-22) aria-rowindex. ### `Optional`aria-rowindex[](#aria_rowindex) aria-rowindex?: number Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. #### See[](#See-23) * aria-rowcount * aria-rowspan. ### `Optional`aria-rowindextext[](#aria_rowindextext) aria-rowindextext?: string Defines a human readable text alternative of aria-rowindex. #### See[](#See-24) aria-colindextext. ### `Optional`aria-rowspan[](#aria_rowspan) aria-rowspan?: number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. #### See[](#See-25) * aria-rowindex * aria-colspan. ### `Optional`aria-selected[](#aria_selected) aria-selected?: Booleanish Indicates the current "selected" state of various widgets. #### See[](#See-26) * aria-checked * aria-pressed. ### `Optional`aria-setsize[](#aria_setsize) aria-setsize?: number Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. #### See[](#See-27) aria-posinset. ### `Optional`aria-sort[](#aria_sort) aria-sort?:     | "none"     | "ascending"     | "descending"     | "other" Indicates if items in a table or grid are sorted in ascending or descending order. ### `Optional`aria-valuemax[](#aria_valuemax) aria-valuemax?: number Defines the maximum allowed value for a range widget. ### `Optional`aria-valuemin[](#aria_valuemin) aria-valuemin?: number Defines the minimum allowed value for a range widget. ### `Optional`aria-valuenow[](#aria_valuenow) aria-valuenow?: number Defines the current value for a range widget. #### See[](#See-28) aria-valuetext. ### `Optional`aria-valuetext[](#aria_valuetext) aria-valuetext?: string Defines the human readable text alternative of aria-valuenow for a range widget. ### `Optional`autoCapitalize[](#autoCapitalize) autoCapitalize?: string ### `Optional`autoCorrect[](#autoCorrect) autoCorrect?: string ### `Optional`autoFocus[](#autoFocus) autoFocus?: boolean ### `Optional`autoSave[](#autoSave) autoSave?: string ### `Optional`children[](#children) children?: ReactNode ### `Optional`className[](#className) className?: string ### `Optional`color[](#color) color?: string ### `Optional`content[](#content) content?: string ### `Optional`contentEditable[](#contentEditable) contentEditable?: Booleanish | "inherit" ### `Optional`contextMenu[](#contextMenu) contextMenu?: string ### `Optional`dangerouslySetInnerHTML[](#dangerouslySetInnerHTML) dangerouslySetInnerHTML?: {     \_\_html: string | TrustedHTML; } ### `Optional`datatype[](#datatype) datatype?: string ### `Optional`defaultChecked[](#defaultChecked) defaultChecked?: boolean ### `Optional`defaultValue[](#defaultValue) defaultValue?: string | number | readonly string\[\] ### `Optional`dir[](#dir) dir?: string ### `Optional`discover[](#discover) discover?: DiscoverBehavior Defines the link discovery behavior // default ("render") * **render** - default, discover the route when the link renders * **none** - don't eagerly discover, only discover if the link is clicked ### `Optional`download[](#download) download?: any ### `Optional`draggable[](#draggable) draggable?: Booleanish ### `Optional`hidden[](#hidden) hidden?: boolean ### `Optional`hrefLang[](#hrefLang) hrefLang?: string ### `Optional`id[](#id) id?: string ### `Optional`inlist[](#inlist) inlist?: any ### `Optional`inputMode[](#inputMode) inputMode?:     | "search"     | "text"     | "url"     | "none"     | "tel"     | "email"     | "numeric"     | "decimal" Hints at the type of data that might be entered by the user while editing the element or its contents #### See[](#See-29) [https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute) ### `Optional`is[](#is) is?: string Specify that a standard HTML element should behave like a defined custom built-in element #### See[](#See-30) [https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is) ### `Optional`itemID[](#itemID) itemID?: string ### `Optional`itemProp[](#itemProp) itemProp?: string ### `Optional`itemRef[](#itemRef) itemRef?: string ### `Optional`itemScope[](#itemScope) itemScope?: boolean ### `Optional`itemType[](#itemType) itemType?: string ### `Optional`lang[](#lang) lang?: string ### `Optional`media[](#media) media?: string ### `Optional`nonce[](#nonce) nonce?: string ### `Optional`onAbort[](#onAbort) onAbort?: ReactEventHandler ### `Optional`onAbortCapture[](#onAbortCapture) onAbortCapture?: ReactEventHandler ### `Optional`onAnimationEnd[](#onAnimationEnd) onAnimationEnd?: AnimationEventHandler ### `Optional`onAnimationEndCapture[](#onAnimationEndCapture) onAnimationEndCapture?: AnimationEventHandler ### `Optional`onAnimationIteration[](#onAnimationIteration) onAnimationIteration?: AnimationEventHandler ### `Optional`onAnimationIterationCapture[](#onAnimationIterationCapture) onAnimationIterationCapture?: AnimationEventHandler ### `Optional`onAnimationStart[](#onAnimationStart) onAnimationStart?: AnimationEventHandler ### `Optional`onAnimationStartCapture[](#onAnimationStartCapture) onAnimationStartCapture?: AnimationEventHandler ### `Optional`onAuxClick[](#onAuxClick) onAuxClick?: MouseEventHandler ### `Optional`onAuxClickCapture[](#onAuxClickCapture) onAuxClickCapture?: MouseEventHandler ### `Optional`onBeforeInput[](#onBeforeInput) onBeforeInput?: FormEventHandler ### `Optional`onBeforeInputCapture[](#onBeforeInputCapture) onBeforeInputCapture?: FormEventHandler ### `Optional`onBlur[](#onBlur) onBlur?: FocusEventHandler ### `Optional`onBlurCapture[](#onBlurCapture) onBlurCapture?: FocusEventHandler ### `Optional`onCanPlay[](#onCanPlay) onCanPlay?: ReactEventHandler ### `Optional`onCanPlayCapture[](#onCanPlayCapture) onCanPlayCapture?: ReactEventHandler ### `Optional`onCanPlayThrough[](#onCanPlayThrough) onCanPlayThrough?: ReactEventHandler ### `Optional`onCanPlayThroughCapture[](#onCanPlayThroughCapture) onCanPlayThroughCapture?: ReactEventHandler ### `Optional`onChange[](#onChange) onChange?: FormEventHandler ### `Optional`onChangeCapture[](#onChangeCapture) onChangeCapture?: FormEventHandler ### `Optional`onClick[](#onClick) onClick?: MouseEventHandler ### `Optional`onClickCapture[](#onClickCapture) onClickCapture?: MouseEventHandler ### `Optional`onCompositionEnd[](#onCompositionEnd) onCompositionEnd?: CompositionEventHandler ### `Optional`onCompositionEndCapture[](#onCompositionEndCapture) onCompositionEndCapture?: CompositionEventHandler ### `Optional`onCompositionStart[](#onCompositionStart) onCompositionStart?: CompositionEventHandler ### `Optional`onCompositionStartCapture[](#onCompositionStartCapture) onCompositionStartCapture?: CompositionEventHandler ### `Optional`onCompositionUpdate[](#onCompositionUpdate) onCompositionUpdate?: CompositionEventHandler ### `Optional`onCompositionUpdateCapture[](#onCompositionUpdateCapture) onCompositionUpdateCapture?: CompositionEventHandler ### `Optional`onContextMenu[](#onContextMenu) onContextMenu?: MouseEventHandler ### `Optional`onContextMenuCapture[](#onContextMenuCapture) onContextMenuCapture?: MouseEventHandler ### `Optional`onCopy[](#onCopy) onCopy?: ClipboardEventHandler ### `Optional`onCopyCapture[](#onCopyCapture) onCopyCapture?: ClipboardEventHandler ### `Optional`onCut[](#onCut) onCut?: ClipboardEventHandler ### `Optional`onCutCapture[](#onCutCapture) onCutCapture?: ClipboardEventHandler ### `Optional`onDoubleClick[](#onDoubleClick) onDoubleClick?: MouseEventHandler ### `Optional`onDoubleClickCapture[](#onDoubleClickCapture) onDoubleClickCapture?: MouseEventHandler ### `Optional`onDrag[](#onDrag) onDrag?: DragEventHandler ### `Optional`onDragCapture[](#onDragCapture) onDragCapture?: DragEventHandler ### `Optional`onDragEnd[](#onDragEnd) onDragEnd?: DragEventHandler ### `Optional`onDragEndCapture[](#onDragEndCapture) onDragEndCapture?: DragEventHandler ### `Optional`onDragEnter[](#onDragEnter) onDragEnter?: DragEventHandler ### `Optional`onDragEnterCapture[](#onDragEnterCapture) onDragEnterCapture?: DragEventHandler ### `Optional`onDragExit[](#onDragExit) onDragExit?: DragEventHandler ### `Optional`onDragExitCapture[](#onDragExitCapture) onDragExitCapture?: DragEventHandler ### `Optional`onDragLeave[](#onDragLeave) onDragLeave?: DragEventHandler ### `Optional`onDragLeaveCapture[](#onDragLeaveCapture) onDragLeaveCapture?: DragEventHandler ### `Optional`onDragOver[](#onDragOver) onDragOver?: DragEventHandler ### `Optional`onDragOverCapture[](#onDragOverCapture) onDragOverCapture?: DragEventHandler ### `Optional`onDragStart[](#onDragStart) onDragStart?: DragEventHandler ### `Optional`onDragStartCapture[](#onDragStartCapture) onDragStartCapture?: DragEventHandler ### `Optional`onDrop[](#onDrop) onDrop?: DragEventHandler ### `Optional`onDropCapture[](#onDropCapture) onDropCapture?: DragEventHandler ### `Optional`onDurationChange[](#onDurationChange) onDurationChange?: ReactEventHandler ### `Optional`onDurationChangeCapture[](#onDurationChangeCapture) onDurationChangeCapture?: ReactEventHandler ### `Optional`onEmptied[](#onEmptied) onEmptied?: ReactEventHandler ### `Optional`onEmptiedCapture[](#onEmptiedCapture) onEmptiedCapture?: ReactEventHandler ### `Optional`onEncrypted[](#onEncrypted) onEncrypted?: ReactEventHandler ### `Optional`onEncryptedCapture[](#onEncryptedCapture) onEncryptedCapture?: ReactEventHandler ### `Optional`onEnded[](#onEnded) onEnded?: ReactEventHandler ### `Optional`onEndedCapture[](#onEndedCapture) onEndedCapture?: ReactEventHandler ### `Optional`onError[](#onError) onError?: ReactEventHandler ### `Optional`onErrorCapture[](#onErrorCapture) onErrorCapture?: ReactEventHandler ### `Optional`onFocus[](#onFocus) onFocus?: FocusEventHandler ### `Optional`onFocusCapture[](#onFocusCapture) onFocusCapture?: FocusEventHandler ### `Optional`onGotPointerCapture[](#onGotPointerCapture) onGotPointerCapture?: PointerEventHandler ### `Optional`onGotPointerCaptureCapture[](#onGotPointerCaptureCapture) onGotPointerCaptureCapture?: PointerEventHandler ### `Optional`onInput[](#onInput) onInput?: FormEventHandler ### `Optional`onInputCapture[](#onInputCapture) onInputCapture?: FormEventHandler ### `Optional`onInvalid[](#onInvalid) onInvalid?: FormEventHandler ### `Optional`onInvalidCapture[](#onInvalidCapture) onInvalidCapture?: FormEventHandler ### `Optional`onKeyDown[](#onKeyDown) onKeyDown?: KeyboardEventHandler ### `Optional`onKeyDownCapture[](#onKeyDownCapture) onKeyDownCapture?: KeyboardEventHandler ### `Optional`onKeyPress[](#onKeyPress) onKeyPress?: KeyboardEventHandler #### Deprecated[](#Deprecated-2) ### `Optional`onKeyPressCapture[](#onKeyPressCapture) onKeyPressCapture?: KeyboardEventHandler #### Deprecated[](#Deprecated-3) ### `Optional`onKeyUp[](#onKeyUp) onKeyUp?: KeyboardEventHandler ### `Optional`onKeyUpCapture[](#onKeyUpCapture) onKeyUpCapture?: KeyboardEventHandler ### `Optional`onLoad[](#onLoad) onLoad?: ReactEventHandler ### `Optional`onLoadCapture[](#onLoadCapture) onLoadCapture?: ReactEventHandler ### `Optional`onLoadedData[](#onLoadedData) onLoadedData?: ReactEventHandler ### `Optional`onLoadedDataCapture[](#onLoadedDataCapture) onLoadedDataCapture?: ReactEventHandler ### `Optional`onLoadedMetadata[](#onLoadedMetadata) onLoadedMetadata?: ReactEventHandler ### `Optional`onLoadedMetadataCapture[](#onLoadedMetadataCapture) onLoadedMetadataCapture?: ReactEventHandler ### `Optional`onLoadStart[](#onLoadStart) onLoadStart?: ReactEventHandler ### `Optional`onLoadStartCapture[](#onLoadStartCapture) onLoadStartCapture?: ReactEventHandler ### `Optional`onLostPointerCapture[](#onLostPointerCapture) onLostPointerCapture?: PointerEventHandler ### `Optional`onLostPointerCaptureCapture[](#onLostPointerCaptureCapture) onLostPointerCaptureCapture?: PointerEventHandler ### `Optional`onMouseDown[](#onMouseDown) onMouseDown?: MouseEventHandler ### `Optional`onMouseDownCapture[](#onMouseDownCapture) onMouseDownCapture?: MouseEventHandler ### `Optional`onMouseEnter[](#onMouseEnter) onMouseEnter?: MouseEventHandler ### `Optional`onMouseLeave[](#onMouseLeave) onMouseLeave?: MouseEventHandler ### `Optional`onMouseMove[](#onMouseMove) onMouseMove?: MouseEventHandler ### `Optional`onMouseMoveCapture[](#onMouseMoveCapture) onMouseMoveCapture?: MouseEventHandler ### `Optional`onMouseOut[](#onMouseOut) onMouseOut?: MouseEventHandler ### `Optional`onMouseOutCapture[](#onMouseOutCapture) onMouseOutCapture?: MouseEventHandler ### `Optional`onMouseOver[](#onMouseOver) onMouseOver?: MouseEventHandler ### `Optional`onMouseOverCapture[](#onMouseOverCapture) onMouseOverCapture?: MouseEventHandler ### `Optional`onMouseUp[](#onMouseUp) onMouseUp?: MouseEventHandler ### `Optional`onMouseUpCapture[](#onMouseUpCapture) onMouseUpCapture?: MouseEventHandler ### `Optional`onPaste[](#onPaste) onPaste?: ClipboardEventHandler ### `Optional`onPasteCapture[](#onPasteCapture) onPasteCapture?: ClipboardEventHandler ### `Optional`onPause[](#onPause) onPause?: ReactEventHandler ### `Optional`onPauseCapture[](#onPauseCapture) onPauseCapture?: ReactEventHandler ### `Optional`onPlay[](#onPlay) onPlay?: ReactEventHandler ### `Optional`onPlayCapture[](#onPlayCapture) onPlayCapture?: ReactEventHandler ### `Optional`onPlaying[](#onPlaying) onPlaying?: ReactEventHandler ### `Optional`onPlayingCapture[](#onPlayingCapture) onPlayingCapture?: ReactEventHandler ### `Optional`onPointerCancel[](#onPointerCancel) onPointerCancel?: PointerEventHandler ### `Optional`onPointerCancelCapture[](#onPointerCancelCapture) onPointerCancelCapture?: PointerEventHandler ### `Optional`onPointerDown[](#onPointerDown) onPointerDown?: PointerEventHandler ### `Optional`onPointerDownCapture[](#onPointerDownCapture) onPointerDownCapture?: PointerEventHandler ### `Optional`onPointerEnter[](#onPointerEnter) onPointerEnter?: PointerEventHandler ### `Optional`onPointerEnterCapture[](#onPointerEnterCapture) onPointerEnterCapture?: PointerEventHandler ### `Optional`onPointerLeave[](#onPointerLeave) onPointerLeave?: PointerEventHandler ### `Optional`onPointerLeaveCapture[](#onPointerLeaveCapture) onPointerLeaveCapture?: PointerEventHandler ### `Optional`onPointerMove[](#onPointerMove) onPointerMove?: PointerEventHandler ### `Optional`onPointerMoveCapture[](#onPointerMoveCapture) onPointerMoveCapture?: PointerEventHandler ### `Optional`onPointerOut[](#onPointerOut) onPointerOut?: PointerEventHandler ### `Optional`onPointerOutCapture[](#onPointerOutCapture) onPointerOutCapture?: PointerEventHandler ### `Optional`onPointerOver[](#onPointerOver) onPointerOver?: PointerEventHandler ### `Optional`onPointerOverCapture[](#onPointerOverCapture) onPointerOverCapture?: PointerEventHandler ### `Optional`onPointerUp[](#onPointerUp) onPointerUp?: PointerEventHandler ### `Optional`onPointerUpCapture[](#onPointerUpCapture) onPointerUpCapture?: PointerEventHandler ### `Optional`onProgress[](#onProgress) onProgress?: ReactEventHandler ### `Optional`onProgressCapture[](#onProgressCapture) onProgressCapture?: ReactEventHandler ### `Optional`onRateChange[](#onRateChange) onRateChange?: ReactEventHandler ### `Optional`onRateChangeCapture[](#onRateChangeCapture) onRateChangeCapture?: ReactEventHandler ### `Optional`onReset[](#onReset) onReset?: FormEventHandler ### `Optional`onResetCapture[](#onResetCapture) onResetCapture?: FormEventHandler ### `Optional`onResize[](#onResize) onResize?: ReactEventHandler ### `Optional`onResizeCapture[](#onResizeCapture) onResizeCapture?: ReactEventHandler ### `Optional`onScroll[](#onScroll) onScroll?: UIEventHandler ### `Optional`onScrollCapture[](#onScrollCapture) onScrollCapture?: UIEventHandler ### `Optional`onSeeked[](#onSeeked) onSeeked?: ReactEventHandler ### `Optional`onSeekedCapture[](#onSeekedCapture) onSeekedCapture?: ReactEventHandler ### `Optional`onSeeking[](#onSeeking) onSeeking?: ReactEventHandler ### `Optional`onSeekingCapture[](#onSeekingCapture) onSeekingCapture?: ReactEventHandler ### `Optional`onSelect[](#onSelect) onSelect?: ReactEventHandler ### `Optional`onSelectCapture[](#onSelectCapture) onSelectCapture?: ReactEventHandler ### `Optional`onStalled[](#onStalled) onStalled?: ReactEventHandler ### `Optional`onStalledCapture[](#onStalledCapture) onStalledCapture?: ReactEventHandler ### `Optional`onSubmit[](#onSubmit) onSubmit?: FormEventHandler ### `Optional`onSubmitCapture[](#onSubmitCapture) onSubmitCapture?: FormEventHandler ### `Optional`onSuspend[](#onSuspend) onSuspend?: ReactEventHandler ### `Optional`onSuspendCapture[](#onSuspendCapture) onSuspendCapture?: ReactEventHandler ### `Optional`onTimeUpdate[](#onTimeUpdate) onTimeUpdate?: ReactEventHandler ### `Optional`onTimeUpdateCapture[](#onTimeUpdateCapture) onTimeUpdateCapture?: ReactEventHandler ### `Optional`onTouchCancel[](#onTouchCancel) onTouchCancel?: TouchEventHandler ### `Optional`onTouchCancelCapture[](#onTouchCancelCapture) onTouchCancelCapture?: TouchEventHandler ### `Optional`onTouchEnd[](#onTouchEnd) onTouchEnd?: TouchEventHandler ### `Optional`onTouchEndCapture[](#onTouchEndCapture) onTouchEndCapture?: TouchEventHandler ### `Optional`onTouchMove[](#onTouchMove) onTouchMove?: TouchEventHandler ### `Optional`onTouchMoveCapture[](#onTouchMoveCapture) onTouchMoveCapture?: TouchEventHandler ### `Optional`onTouchStart[](#onTouchStart) onTouchStart?: TouchEventHandler ### `Optional`onTouchStartCapture[](#onTouchStartCapture) onTouchStartCapture?: TouchEventHandler ### `Optional`onTransitionEnd[](#onTransitionEnd) onTransitionEnd?: TransitionEventHandler ### `Optional`onTransitionEndCapture[](#onTransitionEndCapture) onTransitionEndCapture?: TransitionEventHandler ### `Optional`onVolumeChange[](#onVolumeChange) onVolumeChange?: ReactEventHandler ### `Optional`onVolumeChangeCapture[](#onVolumeChangeCapture) onVolumeChangeCapture?: ReactEventHandler ### `Optional`onWaiting[](#onWaiting) onWaiting?: ReactEventHandler ### `Optional`onWaitingCapture[](#onWaitingCapture) onWaitingCapture?: ReactEventHandler ### `Optional`onWheel[](#onWheel) onWheel?: WheelEventHandler ### `Optional`onWheelCapture[](#onWheelCapture) onWheelCapture?: WheelEventHandler ### `Optional`ping[](#ping) ping?: string ### `Optional`placeholder[](#placeholder) placeholder?: string ### `Optional`prefetch[](#prefetch) prefetch?: PrefetchBehavior Defines the data and module prefetching behavior for the link. // default * **none** - default, no prefetching * **intent** - prefetches when the user hovers or focuses the link * **render** - prefetches when the link renders * **viewport** - prefetches when the link is in the viewport, very useful for mobile Prefetching is done with HTML `` tags. They are inserted after the link. // might conditionally render Because of this, if you are using `nav :last-child` you will need to use `nav :last-of-type` so the styles don't conditionally fall off your last link (and any other similar selectors). ### `Optional`prefix[](#prefix) prefix?: string ### `Optional`preventScrollReset[](#preventScrollReset) preventScrollReset?: boolean Prevents the scroll position from being reset to the top of the window when the link is clicked and the app is using [ScrollRestoration](../functions/react_router.ScrollRestoration.html) . This only prevents new locations reseting scroll to the top, scroll position will be restored for back/forward button navigation. ### `Optional`property[](#property) property?: string ### `Optional`radioGroup[](#radioGroup) radioGroup?: string ### `Optional`referrerPolicy[](#referrerPolicy) referrerPolicy?: HTMLAttributeReferrerPolicy ### `Optional`rel[](#rel) rel?: string ### `Optional`relative[](#relative) relative?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) Defines the relative path behavior for the link. // default: "route" Consider a route hierarchy where a parent route pattern is "blog" and a child route pattern is "blog/:slug/edit". * **route** - default, resolves the link relative to the route pattern. In the example above a relative link of `".."` will remove both `:slug/edit` segments back to "/blog". * **path** - relative to the path so `..` will only remove one URL segment up to "/blog/:slug" ### `Optional`reloadDocument[](#reloadDocument) reloadDocument?: boolean Will use document navigation instead of client side routing when the link is clicked: the browser will handle the transition normally (as if it were an ``). ### `Optional`replace[](#replace) replace?: boolean Replaces the current entry in the history stack instead of pushing a new one onto it. # with a history stack like thisA -> B# normal link click pushes a new entryA -> B -> C# but with `replace`, B is replaced by CA -> C ### `Optional`resource[](#resource) resource?: string ### `Optional`results[](#results) results?: number ### `Optional`rev[](#rev) rev?: string ### `Optional`role[](#role) role?: AriaRole ### `Optional`security[](#security) security?: string ### `Optional`slot[](#slot) slot?: string ### `Optional`spellCheck[](#spellCheck) spellCheck?: Booleanish ### `Optional`state[](#state) state?: any Adds persistent client side routing state to the next location. The location state is accessed from the `location`. function SomeComp() { const location = useLocation() location.state; // { some: "value" }} This state is inaccessible on the server as it is implemented on top of [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state) ### `Optional`style[](#style) style?: CSSProperties ### `Optional`suppressContentEditableWarning[](#suppressContentEditableWarning) suppressContentEditableWarning?: boolean ### `Optional`suppressHydrationWarning[](#suppressHydrationWarning) suppressHydrationWarning?: boolean ### `Optional`tabIndex[](#tabIndex) tabIndex?: number ### `Optional`target[](#target) target?: HTMLAttributeAnchorTarget ### `Optional`title[](#title) title?: string ### to[](#to) to: [To](../types/react_router.To.html) Can be a string or a partial [Path](react_router.Path.html) : ### `Optional`translate[](#translate) translate?: "yes" | "no" ### `Optional`type[](#type) type?: string ### `Optional`typeof[](#typeof) typeof?: string ### `Optional`unselectable[](#unselectable) unselectable?: "on" | "off" ### `Optional`viewTransition[](#viewTransition) viewTransition?: boolean Enables a [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API) for this navigation. Click me To apply specific styles for the transition, see [useViewTransitionState](../functions/react_router.useViewTransitionState.html) ### `Optional`vocab[](#vocab) vocab?: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [about](#about) [accessKey](#accessKey) [aria-activedescendant](#aria_activedescendant) [aria-atomic](#aria_atomic) [aria-autocomplete](#aria_autocomplete) [aria-braillelabel](#aria_braillelabel) [aria-brailleroledescription](#aria_brailleroledescription) [aria-busy](#aria_busy) [aria-checked](#aria_checked) [aria-colcount](#aria_colcount) [aria-colindex](#aria_colindex) [aria-colindextext](#aria_colindextext) [aria-colspan](#aria_colspan) [aria-controls](#aria_controls) [aria-current](#aria_current) [aria-describedby](#aria_describedby) [aria-description](#aria_description) [aria-details](#aria_details) [aria-disabled](#aria_disabled) [aria-dropeffect](#aria_dropeffect) [aria-errormessage](#aria_errormessage) [aria-expanded](#aria_expanded) [aria-flowto](#aria_flowto) [aria-grabbed](#aria_grabbed) [aria-haspopup](#aria_haspopup) [aria-hidden](#aria_hidden) [aria-invalid](#aria_invalid) [aria-keyshortcuts](#aria_keyshortcuts) [aria-label](#aria_label) [aria-labelledby](#aria_labelledby) [aria-level](#aria_level) [aria-live](#aria_live) [aria-modal](#aria_modal) [aria-multiline](#aria_multiline) [aria-multiselectable](#aria_multiselectable) [aria-orientation](#aria_orientation) [aria-owns](#aria_owns) [aria-placeholder](#aria_placeholder) [aria-posinset](#aria_posinset) [aria-pressed](#aria_pressed) [aria-readonly](#aria_readonly) [aria-relevant](#aria_relevant) [aria-required](#aria_required) [aria-roledescription](#aria_roledescription) [aria-rowcount](#aria_rowcount) [aria-rowindex](#aria_rowindex) [aria-rowindextext](#aria_rowindextext) [aria-rowspan](#aria_rowspan) [aria-selected](#aria_selected) [aria-setsize](#aria_setsize) [aria-sort](#aria_sort) [aria-valuemax](#aria_valuemax) [aria-valuemin](#aria_valuemin) [aria-valuenow](#aria_valuenow) [aria-valuetext](#aria_valuetext) [autoCapitalize](#autoCapitalize) [autoCorrect](#autoCorrect) [autoFocus](#autoFocus) [autoSave](#autoSave) [children](#children) [className](#className) [color](#color) [content](#content) [contentEditable](#contentEditable) [contextMenu](#contextMenu) [dangerouslySetInnerHTML](#dangerouslySetInnerHTML) [datatype](#datatype) [defaultChecked](#defaultChecked) [defaultValue](#defaultValue) [dir](#dir) [discover](#discover) [download](#download) [draggable](#draggable) [hidden](#hidden) [hrefLang](#hrefLang) [id](#id) [inlist](#inlist) [inputMode](#inputMode) [is](#is) [itemID](#itemID) [itemProp](#itemProp) [itemRef](#itemRef) [itemScope](#itemScope) [itemType](#itemType) [lang](#lang) [media](#media) [nonce](#nonce) [onAbort](#onAbort) [onAbortCapture](#onAbortCapture) [onAnimationEnd](#onAnimationEnd) [onAnimationEndCapture](#onAnimationEndCapture) [onAnimationIteration](#onAnimationIteration) [onAnimationIterationCapture](#onAnimationIterationCapture) [onAnimationStart](#onAnimationStart) [onAnimationStartCapture](#onAnimationStartCapture) [onAuxClick](#onAuxClick) [onAuxClickCapture](#onAuxClickCapture) [onBeforeInput](#onBeforeInput) [onBeforeInputCapture](#onBeforeInputCapture) [onBlur](#onBlur) [onBlurCapture](#onBlurCapture) [onCanPlay](#onCanPlay) [onCanPlayCapture](#onCanPlayCapture) [onCanPlayThrough](#onCanPlayThrough) [onCanPlayThroughCapture](#onCanPlayThroughCapture) [onChange](#onChange) [onChangeCapture](#onChangeCapture) [onClick](#onClick) [onClickCapture](#onClickCapture) [onCompositionEnd](#onCompositionEnd) [onCompositionEndCapture](#onCompositionEndCapture) [onCompositionStart](#onCompositionStart) [onCompositionStartCapture](#onCompositionStartCapture) [onCompositionUpdate](#onCompositionUpdate) [onCompositionUpdateCapture](#onCompositionUpdateCapture) [onContextMenu](#onContextMenu) [onContextMenuCapture](#onContextMenuCapture) [onCopy](#onCopy) [onCopyCapture](#onCopyCapture) [onCut](#onCut) [onCutCapture](#onCutCapture) [onDoubleClick](#onDoubleClick) [onDoubleClickCapture](#onDoubleClickCapture) [onDrag](#onDrag) [onDragCapture](#onDragCapture) [onDragEnd](#onDragEnd) [onDragEndCapture](#onDragEndCapture) [onDragEnter](#onDragEnter) [onDragEnterCapture](#onDragEnterCapture) [onDragExit](#onDragExit) [onDragExitCapture](#onDragExitCapture) [onDragLeave](#onDragLeave) [onDragLeaveCapture](#onDragLeaveCapture) [onDragOver](#onDragOver) [onDragOverCapture](#onDragOverCapture) [onDragStart](#onDragStart) [onDragStartCapture](#onDragStartCapture) [onDrop](#onDrop) [onDropCapture](#onDropCapture) [onDurationChange](#onDurationChange) [onDurationChangeCapture](#onDurationChangeCapture) [onEmptied](#onEmptied) [onEmptiedCapture](#onEmptiedCapture) [onEncrypted](#onEncrypted) [onEncryptedCapture](#onEncryptedCapture) [onEnded](#onEnded) [onEndedCapture](#onEndedCapture) [onError](#onError) [onErrorCapture](#onErrorCapture) [onFocus](#onFocus) [onFocusCapture](#onFocusCapture) [onGotPointerCapture](#onGotPointerCapture) [onGotPointerCaptureCapture](#onGotPointerCaptureCapture) [onInput](#onInput) [onInputCapture](#onInputCapture) [onInvalid](#onInvalid) [onInvalidCapture](#onInvalidCapture) [onKeyDown](#onKeyDown) [onKeyDownCapture](#onKeyDownCapture) [onKeyPress](#onKeyPress) [onKeyPressCapture](#onKeyPressCapture) [onKeyUp](#onKeyUp) [onKeyUpCapture](#onKeyUpCapture) [onLoad](#onLoad) [onLoadCapture](#onLoadCapture) [onLoadedData](#onLoadedData) [onLoadedDataCapture](#onLoadedDataCapture) [onLoadedMetadata](#onLoadedMetadata) [onLoadedMetadataCapture](#onLoadedMetadataCapture) [onLoadStart](#onLoadStart) [onLoadStartCapture](#onLoadStartCapture) [onLostPointerCapture](#onLostPointerCapture) [onLostPointerCaptureCapture](#onLostPointerCaptureCapture) [onMouseDown](#onMouseDown) [onMouseDownCapture](#onMouseDownCapture) [onMouseEnter](#onMouseEnter) [onMouseLeave](#onMouseLeave) [onMouseMove](#onMouseMove) [onMouseMoveCapture](#onMouseMoveCapture) [onMouseOut](#onMouseOut) [onMouseOutCapture](#onMouseOutCapture) [onMouseOver](#onMouseOver) [onMouseOverCapture](#onMouseOverCapture) [onMouseUp](#onMouseUp) [onMouseUpCapture](#onMouseUpCapture) [onPaste](#onPaste) [onPasteCapture](#onPasteCapture) [onPause](#onPause) [onPauseCapture](#onPauseCapture) [onPlay](#onPlay) [onPlayCapture](#onPlayCapture) [onPlaying](#onPlaying) [onPlayingCapture](#onPlayingCapture) [onPointerCancel](#onPointerCancel) [onPointerCancelCapture](#onPointerCancelCapture) [onPointerDown](#onPointerDown) [onPointerDownCapture](#onPointerDownCapture) [onPointerEnter](#onPointerEnter) [onPointerEnterCapture](#onPointerEnterCapture) [onPointerLeave](#onPointerLeave) [onPointerLeaveCapture](#onPointerLeaveCapture) [onPointerMove](#onPointerMove) [onPointerMoveCapture](#onPointerMoveCapture) [onPointerOut](#onPointerOut) [onPointerOutCapture](#onPointerOutCapture) [onPointerOver](#onPointerOver) [onPointerOverCapture](#onPointerOverCapture) [onPointerUp](#onPointerUp) [onPointerUpCapture](#onPointerUpCapture) [onProgress](#onProgress) [onProgressCapture](#onProgressCapture) [onRateChange](#onRateChange) [onRateChangeCapture](#onRateChangeCapture) [onReset](#onReset) [onResetCapture](#onResetCapture) [onResize](#onResize) [onResizeCapture](#onResizeCapture) [onScroll](#onScroll) [onScrollCapture](#onScrollCapture) [onSeeked](#onSeeked) [onSeekedCapture](#onSeekedCapture) [onSeeking](#onSeeking) [onSeekingCapture](#onSeekingCapture) [onSelect](#onSelect) [onSelectCapture](#onSelectCapture) [onStalled](#onStalled) [onStalledCapture](#onStalledCapture) [onSubmit](#onSubmit) [onSubmitCapture](#onSubmitCapture) [onSuspend](#onSuspend) [onSuspendCapture](#onSuspendCapture) [onTimeUpdate](#onTimeUpdate) [onTimeUpdateCapture](#onTimeUpdateCapture) [onTouchCancel](#onTouchCancel) [onTouchCancelCapture](#onTouchCancelCapture) [onTouchEnd](#onTouchEnd) [onTouchEndCapture](#onTouchEndCapture) [onTouchMove](#onTouchMove) [onTouchMoveCapture](#onTouchMoveCapture) [onTouchStart](#onTouchStart) [onTouchStartCapture](#onTouchStartCapture) [onTransitionEnd](#onTransitionEnd) [onTransitionEndCapture](#onTransitionEndCapture) [onVolumeChange](#onVolumeChange) [onVolumeChangeCapture](#onVolumeChangeCapture) [onWaiting](#onWaiting) [onWaitingCapture](#onWaitingCapture) [onWheel](#onWheel) [onWheelCapture](#onWheelCapture) [ping](#ping) [placeholder](#placeholder) [prefetch](#prefetch) [prefix](#prefix) [preventScrollReset](#preventScrollReset) [property](#property) [radioGroup](#radioGroup) [referrerPolicy](#referrerPolicy) [rel](#rel) [relative](#relative) [reloadDocument](#reloadDocument) [replace](#replace) [resource](#resource) [results](#results) [rev](#rev) [role](#role) [security](#security) [slot](#slot) [spellCheck](#spellCheck) [state](#state) [style](#style) [suppressContentEditableWarning](#suppressContentEditableWarning) [suppressHydrationWarning](#suppressHydrationWarning) [tabIndex](#tabIndex) [target](#target) [title](#title) [to](#to) [translate](#translate) [type](#type) [typeof](#typeof) [unselectable](#unselectable) [viewTransition](#viewTransition) [vocab](#vocab) --- # Navigator | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [Navigator](react_router.Navigator.html) Interface Navigator =================== A Navigator is a "location changer"; it's how you get to different locations. Every history instance conforms to the Navigator interface, but the distinction is useful primarily when it comes to the low-level `` API where both the location and a navigator must be provided separately in order to avoid "tearing" that may occur in a suspense-enabled app if the action and/or location were to be read directly from the history instance. interface Navigator {     [createHref](react_router.Navigator.html#createHref) : ((to: [To](../types/react_router.To.html) ) => string);     [encodeLocation](react_router.Navigator.html#encodeLocation) ?: ((to: [To](../types/react_router.To.html) ) => [Path](react_router.Path.html) );     [go](react_router.Navigator.html#go) : ((delta: number) => void);     [push](react_router.Navigator.html#push.push-1) (to: [To](../types/react_router.To.html) , state?: any, opts?: [NavigateOptions](react_router.NavigateOptions.html) ): void;     [replace](react_router.Navigator.html#replace.replace-1) (to: [To](../types/react_router.To.html) , state?: any, opts?: [NavigateOptions](react_router.NavigateOptions.html) ): void; } ##### Index ### Properties [createHref](react_router.Navigator.html#createHref) [encodeLocation?](react_router.Navigator.html#encodeLocation) [go](react_router.Navigator.html#go) ### Methods [push](react_router.Navigator.html#push) [replace](react_router.Navigator.html#replace) Properties ---------- ### createHref[](#createHref) createHref: ((to: [To](../types/react_router.To.html) ) => string) #### Type declaration * * (to): string * Returns a valid href for the given `to` value that may be used as the value of an attribute. #### Parameters * to: [To](../types/react_router.To.html) The destination URL #### Returns string ### `Optional`encodeLocation[](#encodeLocation) encodeLocation?: ((to: [To](../types/react_router.To.html) ) => [Path](react_router.Path.html) ) #### Type declaration * * (to): [Path](react_router.Path.html) * Encode a location the same way window.history would do (no-op for memory history) so we ensure our PUSH/REPLACE navigations for data routers behave the same as POP #### Parameters * to: [To](../types/react_router.To.html) Unencoded path #### Returns [Path](react_router.Path.html) ### go[](#go) go: ((delta: number) => void) #### Type declaration * * (delta): void * Navigates `n` entries backward/forward in the history stack relative to the current index. For example, a "back" navigation would use go(-1). #### Parameters * delta: number The delta in the stack index #### Returns void Methods ------- ### push[](#push) * push(to, state?, opts?): void[](#push.push-1) * #### Parameters * to: [To](../types/react_router.To.html) * `Optional`state: any * `Optional`opts: [NavigateOptions](react_router.NavigateOptions.html) #### Returns void ### replace[](#replace) * replace(to, state?, opts?): void[](#replace.replace-1) * #### Parameters * to: [To](../types/react_router.To.html) * `Optional`state: any * `Optional`opts: [NavigateOptions](react_router.NavigateOptions.html) #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [createHref](#createHref) [encodeLocation](#encodeLocation) [go](#go) Methods [push](#push) [replace](#replace) --- # NavLinkProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [NavLinkProps](react_router.NavLinkProps.html) Interface NavLinkProps ====================== interface NavLinkProps {     [about](react_router.NavLinkProps.html#about) ?: string;     [accessKey](react_router.NavLinkProps.html#accessKey) ?: string;     [aria-activedescendant](react_router.NavLinkProps.html#aria_activedescendant) ?: string;     [aria-atomic](react_router.NavLinkProps.html#aria_atomic) ?: Booleanish;     [aria-autocomplete](react_router.NavLinkProps.html#aria_autocomplete) ?:         | "none"         | "list"         | "inline"         | "both";     [aria-braillelabel](react_router.NavLinkProps.html#aria_braillelabel) ?: string;     [aria-brailleroledescription](react_router.NavLinkProps.html#aria_brailleroledescription) ?: string;     [aria-busy](react_router.NavLinkProps.html#aria_busy) ?: Booleanish;     [aria-checked](react_router.NavLinkProps.html#aria_checked) ?:         | boolean         | "true"         | "false"         | "mixed";     [aria-colcount](react_router.NavLinkProps.html#aria_colcount) ?: number;     [aria-colindex](react_router.NavLinkProps.html#aria_colindex) ?: number;     [aria-colindextext](react_router.NavLinkProps.html#aria_colindextext) ?: string;     [aria-colspan](react_router.NavLinkProps.html#aria_colspan) ?: number;     [aria-controls](react_router.NavLinkProps.html#aria_controls) ?: string;     [aria-current](react_router.NavLinkProps.html#aria_current) ?:         | boolean         | "time"         | "true"         | "location"         | "page"         | "step"         | "false"         | "date";     [aria-describedby](react_router.NavLinkProps.html#aria_describedby) ?: string;     [aria-description](react_router.NavLinkProps.html#aria_description) ?: string;     [aria-details](react_router.NavLinkProps.html#aria_details) ?: string;     [aria-disabled](react_router.NavLinkProps.html#aria_disabled) ?: Booleanish;     [aria-dropeffect](react_router.NavLinkProps.html#aria_dropeffect) ?:         | "link"         | "copy"         | "none"         | "execute"         | "move"         | "popup";     [aria-errormessage](react_router.NavLinkProps.html#aria_errormessage) ?: string;     [aria-expanded](react_router.NavLinkProps.html#aria_expanded) ?: Booleanish;     [aria-flowto](react_router.NavLinkProps.html#aria_flowto) ?: string;     [aria-grabbed](react_router.NavLinkProps.html#aria_grabbed) ?: Booleanish;     [aria-haspopup](react_router.NavLinkProps.html#aria_haspopup) ?:         | boolean         | "dialog"         | "menu"         | "true"         | "false"         | "grid"         | "listbox"         | "tree";     [aria-hidden](react_router.NavLinkProps.html#aria_hidden) ?: Booleanish;     [aria-invalid](react_router.NavLinkProps.html#aria_invalid) ?:         | boolean         | "true"         | "false"         | "grammar"         | "spelling";     [aria-keyshortcuts](react_router.NavLinkProps.html#aria_keyshortcuts) ?: string;     [aria-label](react_router.NavLinkProps.html#aria_label) ?: string;     [aria-labelledby](react_router.NavLinkProps.html#aria_labelledby) ?: string;     [aria-level](react_router.NavLinkProps.html#aria_level) ?: number;     [aria-live](react_router.NavLinkProps.html#aria_live) ?: "off" | "assertive" | "polite";     [aria-modal](react_router.NavLinkProps.html#aria_modal) ?: Booleanish;     [aria-multiline](react_router.NavLinkProps.html#aria_multiline) ?: Booleanish;     [aria-multiselectable](react_router.NavLinkProps.html#aria_multiselectable) ?: Booleanish;     [aria-orientation](react_router.NavLinkProps.html#aria_orientation) ?: "horizontal" | "vertical";     [aria-owns](react_router.NavLinkProps.html#aria_owns) ?: string;     [aria-placeholder](react_router.NavLinkProps.html#aria_placeholder) ?: string;     [aria-posinset](react_router.NavLinkProps.html#aria_posinset) ?: number;     [aria-pressed](react_router.NavLinkProps.html#aria_pressed) ?:         | boolean         | "true"         | "false"         | "mixed";     [aria-readonly](react_router.NavLinkProps.html#aria_readonly) ?: Booleanish;     [aria-relevant](react_router.NavLinkProps.html#aria_relevant) ?:         | "text"         | "additions"         | "additions removals"         | "additions text"         | "all"         | "removals"         | "removals additions"         | "removals text"         | "text additions"         | "text removals";     [aria-required](react_router.NavLinkProps.html#aria_required) ?: Booleanish;     [aria-roledescription](react_router.NavLinkProps.html#aria_roledescription) ?: string;     [aria-rowcount](react_router.NavLinkProps.html#aria_rowcount) ?: number;     [aria-rowindex](react_router.NavLinkProps.html#aria_rowindex) ?: number;     [aria-rowindextext](react_router.NavLinkProps.html#aria_rowindextext) ?: string;     [aria-rowspan](react_router.NavLinkProps.html#aria_rowspan) ?: number;     [aria-selected](react_router.NavLinkProps.html#aria_selected) ?: Booleanish;     [aria-setsize](react_router.NavLinkProps.html#aria_setsize) ?: number;     [aria-sort](react_router.NavLinkProps.html#aria_sort) ?:         | "none"         | "ascending"         | "descending"         | "other";     [aria-valuemax](react_router.NavLinkProps.html#aria_valuemax) ?: number;     [aria-valuemin](react_router.NavLinkProps.html#aria_valuemin) ?: number;     [aria-valuenow](react_router.NavLinkProps.html#aria_valuenow) ?: number;     [aria-valuetext](react_router.NavLinkProps.html#aria_valuetext) ?: string;     [autoCapitalize](react_router.NavLinkProps.html#autoCapitalize) ?: string;     [autoCorrect](react_router.NavLinkProps.html#autoCorrect) ?: string;     [autoFocus](react_router.NavLinkProps.html#autoFocus) ?: boolean;     [autoSave](react_router.NavLinkProps.html#autoSave) ?: string;     [caseSensitive](react_router.NavLinkProps.html#caseSensitive) ?: boolean;     [children](react_router.NavLinkProps.html#children) ?: ReactNode | ((props: [NavLinkRenderProps](../types/react_router.NavLinkRenderProps.html) ) => ReactNode);     [className](react_router.NavLinkProps.html#className) ?: string | ((props: [NavLinkRenderProps](../types/react_router.NavLinkRenderProps.html) ) => undefined | string);     [color](react_router.NavLinkProps.html#color) ?: string;     [content](react_router.NavLinkProps.html#content) ?: string;     [contentEditable](react_router.NavLinkProps.html#contentEditable) ?: Booleanish | "inherit";     [contextMenu](react_router.NavLinkProps.html#contextMenu) ?: string;     [dangerouslySetInnerHTML](react_router.NavLinkProps.html#dangerouslySetInnerHTML) ?: {         \_\_html: string | TrustedHTML;     };     [datatype](react_router.NavLinkProps.html#datatype) ?: string;     [defaultChecked](react_router.NavLinkProps.html#defaultChecked) ?: boolean;     [defaultValue](react_router.NavLinkProps.html#defaultValue) ?: string | number | readonly string\[\];     [dir](react_router.NavLinkProps.html#dir) ?: string;     [discover](react_router.NavLinkProps.html#discover) ?: DiscoverBehavior;     [download](react_router.NavLinkProps.html#download) ?: any;     [draggable](react_router.NavLinkProps.html#draggable) ?: Booleanish;     [end](react_router.NavLinkProps.html#end) ?: boolean;     [hidden](react_router.NavLinkProps.html#hidden) ?: boolean;     [hrefLang](react_router.NavLinkProps.html#hrefLang) ?: string;     [id](react_router.NavLinkProps.html#id) ?: string;     [inlist](react_router.NavLinkProps.html#inlist) ?: any;     [inputMode](react_router.NavLinkProps.html#inputMode) ?:         | "search"         | "text"         | "url"         | "none"         | "tel"         | "email"         | "numeric"         | "decimal";     [is](react_router.NavLinkProps.html#is) ?: string;     [itemID](react_router.NavLinkProps.html#itemID) ?: string;     [itemProp](react_router.NavLinkProps.html#itemProp) ?: string;     [itemRef](react_router.NavLinkProps.html#itemRef) ?: string;     [itemScope](react_router.NavLinkProps.html#itemScope) ?: boolean;     [itemType](react_router.NavLinkProps.html#itemType) ?: string;     [lang](react_router.NavLinkProps.html#lang) ?: string;     [media](react_router.NavLinkProps.html#media) ?: string;     [nonce](react_router.NavLinkProps.html#nonce) ?: string;     [onAbort](react_router.NavLinkProps.html#onAbort) ?: ReactEventHandler;     [onAbortCapture](react_router.NavLinkProps.html#onAbortCapture) ?: ReactEventHandler;     [onAnimationEnd](react_router.NavLinkProps.html#onAnimationEnd) ?: AnimationEventHandler;     [onAnimationEndCapture](react_router.NavLinkProps.html#onAnimationEndCapture) ?: AnimationEventHandler;     [onAnimationIteration](react_router.NavLinkProps.html#onAnimationIteration) ?: AnimationEventHandler;     [onAnimationIterationCapture](react_router.NavLinkProps.html#onAnimationIterationCapture) ?: AnimationEventHandler;     [onAnimationStart](react_router.NavLinkProps.html#onAnimationStart) ?: AnimationEventHandler;     [onAnimationStartCapture](react_router.NavLinkProps.html#onAnimationStartCapture) ?: AnimationEventHandler;     [onAuxClick](react_router.NavLinkProps.html#onAuxClick) ?: MouseEventHandler;     [onAuxClickCapture](react_router.NavLinkProps.html#onAuxClickCapture) ?: MouseEventHandler;     [onBeforeInput](react_router.NavLinkProps.html#onBeforeInput) ?: FormEventHandler;     [onBeforeInputCapture](react_router.NavLinkProps.html#onBeforeInputCapture) ?: FormEventHandler;     [onBlur](react_router.NavLinkProps.html#onBlur) ?: FocusEventHandler;     [onBlurCapture](react_router.NavLinkProps.html#onBlurCapture) ?: FocusEventHandler;     [onCanPlay](react_router.NavLinkProps.html#onCanPlay) ?: ReactEventHandler;     [onCanPlayCapture](react_router.NavLinkProps.html#onCanPlayCapture) ?: ReactEventHandler;     [onCanPlayThrough](react_router.NavLinkProps.html#onCanPlayThrough) ?: ReactEventHandler;     [onCanPlayThroughCapture](react_router.NavLinkProps.html#onCanPlayThroughCapture) ?: ReactEventHandler;     [onChange](react_router.NavLinkProps.html#onChange) ?: FormEventHandler;     [onChangeCapture](react_router.NavLinkProps.html#onChangeCapture) ?: FormEventHandler;     [onClick](react_router.NavLinkProps.html#onClick) ?: MouseEventHandler;     [onClickCapture](react_router.NavLinkProps.html#onClickCapture) ?: MouseEventHandler;     [onCompositionEnd](react_router.NavLinkProps.html#onCompositionEnd) ?: CompositionEventHandler;     [onCompositionEndCapture](react_router.NavLinkProps.html#onCompositionEndCapture) ?: CompositionEventHandler;     [onCompositionStart](react_router.NavLinkProps.html#onCompositionStart) ?: CompositionEventHandler;     [onCompositionStartCapture](react_router.NavLinkProps.html#onCompositionStartCapture) ?: CompositionEventHandler;     [onCompositionUpdate](react_router.NavLinkProps.html#onCompositionUpdate) ?: CompositionEventHandler;     [onCompositionUpdateCapture](react_router.NavLinkProps.html#onCompositionUpdateCapture) ?: CompositionEventHandler;     [onContextMenu](react_router.NavLinkProps.html#onContextMenu) ?: MouseEventHandler;     [onContextMenuCapture](react_router.NavLinkProps.html#onContextMenuCapture) ?: MouseEventHandler;     [onCopy](react_router.NavLinkProps.html#onCopy) ?: ClipboardEventHandler;     [onCopyCapture](react_router.NavLinkProps.html#onCopyCapture) ?: ClipboardEventHandler;     [onCut](react_router.NavLinkProps.html#onCut) ?: ClipboardEventHandler;     [onCutCapture](react_router.NavLinkProps.html#onCutCapture) ?: ClipboardEventHandler;     [onDoubleClick](react_router.NavLinkProps.html#onDoubleClick) ?: MouseEventHandler;     [onDoubleClickCapture](react_router.NavLinkProps.html#onDoubleClickCapture) ?: MouseEventHandler;     [onDrag](react_router.NavLinkProps.html#onDrag) ?: DragEventHandler;     [onDragCapture](react_router.NavLinkProps.html#onDragCapture) ?: DragEventHandler;     [onDragEnd](react_router.NavLinkProps.html#onDragEnd) ?: DragEventHandler;     [onDragEndCapture](react_router.NavLinkProps.html#onDragEndCapture) ?: DragEventHandler;     [onDragEnter](react_router.NavLinkProps.html#onDragEnter) ?: DragEventHandler;     [onDragEnterCapture](react_router.NavLinkProps.html#onDragEnterCapture) ?: DragEventHandler;     [onDragExit](react_router.NavLinkProps.html#onDragExit) ?: DragEventHandler;     [onDragExitCapture](react_router.NavLinkProps.html#onDragExitCapture) ?: DragEventHandler;     [onDragLeave](react_router.NavLinkProps.html#onDragLeave) ?: DragEventHandler;     [onDragLeaveCapture](react_router.NavLinkProps.html#onDragLeaveCapture) ?: DragEventHandler;     [onDragOver](react_router.NavLinkProps.html#onDragOver) ?: DragEventHandler;     [onDragOverCapture](react_router.NavLinkProps.html#onDragOverCapture) ?: DragEventHandler;     [onDragStart](react_router.NavLinkProps.html#onDragStart) ?: DragEventHandler;     [onDragStartCapture](react_router.NavLinkProps.html#onDragStartCapture) ?: DragEventHandler;     [onDrop](react_router.NavLinkProps.html#onDrop) ?: DragEventHandler;     [onDropCapture](react_router.NavLinkProps.html#onDropCapture) ?: DragEventHandler;     [onDurationChange](react_router.NavLinkProps.html#onDurationChange) ?: ReactEventHandler;     [onDurationChangeCapture](react_router.NavLinkProps.html#onDurationChangeCapture) ?: ReactEventHandler;     [onEmptied](react_router.NavLinkProps.html#onEmptied) ?: ReactEventHandler;     [onEmptiedCapture](react_router.NavLinkProps.html#onEmptiedCapture) ?: ReactEventHandler;     [onEncrypted](react_router.NavLinkProps.html#onEncrypted) ?: ReactEventHandler;     [onEncryptedCapture](react_router.NavLinkProps.html#onEncryptedCapture) ?: ReactEventHandler;     [onEnded](react_router.NavLinkProps.html#onEnded) ?: ReactEventHandler;     [onEndedCapture](react_router.NavLinkProps.html#onEndedCapture) ?: ReactEventHandler;     [onError](react_router.NavLinkProps.html#onError) ?: ReactEventHandler;     [onErrorCapture](react_router.NavLinkProps.html#onErrorCapture) ?: ReactEventHandler;     [onFocus](react_router.NavLinkProps.html#onFocus) ?: FocusEventHandler;     [onFocusCapture](react_router.NavLinkProps.html#onFocusCapture) ?: FocusEventHandler;     [onGotPointerCapture](react_router.NavLinkProps.html#onGotPointerCapture) ?: PointerEventHandler;     [onGotPointerCaptureCapture](react_router.NavLinkProps.html#onGotPointerCaptureCapture) ?: PointerEventHandler;     [onInput](react_router.NavLinkProps.html#onInput) ?: FormEventHandler;     [onInputCapture](react_router.NavLinkProps.html#onInputCapture) ?: FormEventHandler;     [onInvalid](react_router.NavLinkProps.html#onInvalid) ?: FormEventHandler;     [onInvalidCapture](react_router.NavLinkProps.html#onInvalidCapture) ?: FormEventHandler;     [onKeyDown](react_router.NavLinkProps.html#onKeyDown) ?: KeyboardEventHandler;     [onKeyDownCapture](react_router.NavLinkProps.html#onKeyDownCapture) ?: KeyboardEventHandler;     [onKeyPress](react_router.NavLinkProps.html#onKeyPress) ?: KeyboardEventHandler;     [onKeyPressCapture](react_router.NavLinkProps.html#onKeyPressCapture) ?: KeyboardEventHandler;     [onKeyUp](react_router.NavLinkProps.html#onKeyUp) ?: KeyboardEventHandler;     [onKeyUpCapture](react_router.NavLinkProps.html#onKeyUpCapture) ?: KeyboardEventHandler;     [onLoad](react_router.NavLinkProps.html#onLoad) ?: ReactEventHandler;     [onLoadCapture](react_router.NavLinkProps.html#onLoadCapture) ?: ReactEventHandler;     [onLoadedData](react_router.NavLinkProps.html#onLoadedData) ?: ReactEventHandler;     [onLoadedDataCapture](react_router.NavLinkProps.html#onLoadedDataCapture) ?: ReactEventHandler;     [onLoadedMetadata](react_router.NavLinkProps.html#onLoadedMetadata) ?: ReactEventHandler;     [onLoadedMetadataCapture](react_router.NavLinkProps.html#onLoadedMetadataCapture) ?: ReactEventHandler;     [onLoadStart](react_router.NavLinkProps.html#onLoadStart) ?: ReactEventHandler;     [onLoadStartCapture](react_router.NavLinkProps.html#onLoadStartCapture) ?: ReactEventHandler;     [onLostPointerCapture](react_router.NavLinkProps.html#onLostPointerCapture) ?: PointerEventHandler;     [onLostPointerCaptureCapture](react_router.NavLinkProps.html#onLostPointerCaptureCapture) ?: PointerEventHandler;     [onMouseDown](react_router.NavLinkProps.html#onMouseDown) ?: MouseEventHandler;     [onMouseDownCapture](react_router.NavLinkProps.html#onMouseDownCapture) ?: MouseEventHandler;     [onMouseEnter](react_router.NavLinkProps.html#onMouseEnter) ?: MouseEventHandler;     [onMouseLeave](react_router.NavLinkProps.html#onMouseLeave) ?: MouseEventHandler;     [onMouseMove](react_router.NavLinkProps.html#onMouseMove) ?: MouseEventHandler;     [onMouseMoveCapture](react_router.NavLinkProps.html#onMouseMoveCapture) ?: MouseEventHandler;     [onMouseOut](react_router.NavLinkProps.html#onMouseOut) ?: MouseEventHandler;     [onMouseOutCapture](react_router.NavLinkProps.html#onMouseOutCapture) ?: MouseEventHandler;     [onMouseOver](react_router.NavLinkProps.html#onMouseOver) ?: MouseEventHandler;     [onMouseOverCapture](react_router.NavLinkProps.html#onMouseOverCapture) ?: MouseEventHandler;     [onMouseUp](react_router.NavLinkProps.html#onMouseUp) ?: MouseEventHandler;     [onMouseUpCapture](react_router.NavLinkProps.html#onMouseUpCapture) ?: MouseEventHandler;     [onPaste](react_router.NavLinkProps.html#onPaste) ?: ClipboardEventHandler;     [onPasteCapture](react_router.NavLinkProps.html#onPasteCapture) ?: ClipboardEventHandler;     [onPause](react_router.NavLinkProps.html#onPause) ?: ReactEventHandler;     [onPauseCapture](react_router.NavLinkProps.html#onPauseCapture) ?: ReactEventHandler;     [onPlay](react_router.NavLinkProps.html#onPlay) ?: ReactEventHandler;     [onPlayCapture](react_router.NavLinkProps.html#onPlayCapture) ?: ReactEventHandler;     [onPlaying](react_router.NavLinkProps.html#onPlaying) ?: ReactEventHandler;     [onPlayingCapture](react_router.NavLinkProps.html#onPlayingCapture) ?: ReactEventHandler;     [onPointerCancel](react_router.NavLinkProps.html#onPointerCancel) ?: PointerEventHandler;     [onPointerCancelCapture](react_router.NavLinkProps.html#onPointerCancelCapture) ?: PointerEventHandler;     [onPointerDown](react_router.NavLinkProps.html#onPointerDown) ?: PointerEventHandler;     [onPointerDownCapture](react_router.NavLinkProps.html#onPointerDownCapture) ?: PointerEventHandler;     [onPointerEnter](react_router.NavLinkProps.html#onPointerEnter) ?: PointerEventHandler;     [onPointerEnterCapture](react_router.NavLinkProps.html#onPointerEnterCapture) ?: PointerEventHandler;     [onPointerLeave](react_router.NavLinkProps.html#onPointerLeave) ?: PointerEventHandler;     [onPointerLeaveCapture](react_router.NavLinkProps.html#onPointerLeaveCapture) ?: PointerEventHandler;     [onPointerMove](react_router.NavLinkProps.html#onPointerMove) ?: PointerEventHandler;     [onPointerMoveCapture](react_router.NavLinkProps.html#onPointerMoveCapture) ?: PointerEventHandler;     [onPointerOut](react_router.NavLinkProps.html#onPointerOut) ?: PointerEventHandler;     [onPointerOutCapture](react_router.NavLinkProps.html#onPointerOutCapture) ?: PointerEventHandler;     [onPointerOver](react_router.NavLinkProps.html#onPointerOver) ?: PointerEventHandler;     [onPointerOverCapture](react_router.NavLinkProps.html#onPointerOverCapture) ?: PointerEventHandler;     [onPointerUp](react_router.NavLinkProps.html#onPointerUp) ?: PointerEventHandler;     [onPointerUpCapture](react_router.NavLinkProps.html#onPointerUpCapture) ?: PointerEventHandler;     [onProgress](react_router.NavLinkProps.html#onProgress) ?: ReactEventHandler;     [onProgressCapture](react_router.NavLinkProps.html#onProgressCapture) ?: ReactEventHandler;     [onRateChange](react_router.NavLinkProps.html#onRateChange) ?: ReactEventHandler;     [onRateChangeCapture](react_router.NavLinkProps.html#onRateChangeCapture) ?: ReactEventHandler;     [onReset](react_router.NavLinkProps.html#onReset) ?: FormEventHandler;     [onResetCapture](react_router.NavLinkProps.html#onResetCapture) ?: FormEventHandler;     [onResize](react_router.NavLinkProps.html#onResize) ?: ReactEventHandler;     [onResizeCapture](react_router.NavLinkProps.html#onResizeCapture) ?: ReactEventHandler;     [onScroll](react_router.NavLinkProps.html#onScroll) ?: UIEventHandler;     [onScrollCapture](react_router.NavLinkProps.html#onScrollCapture) ?: UIEventHandler;     [onSeeked](react_router.NavLinkProps.html#onSeeked) ?: ReactEventHandler;     [onSeekedCapture](react_router.NavLinkProps.html#onSeekedCapture) ?: ReactEventHandler;     [onSeeking](react_router.NavLinkProps.html#onSeeking) ?: ReactEventHandler;     [onSeekingCapture](react_router.NavLinkProps.html#onSeekingCapture) ?: ReactEventHandler;     [onSelect](react_router.NavLinkProps.html#onSelect) ?: ReactEventHandler;     [onSelectCapture](react_router.NavLinkProps.html#onSelectCapture) ?: ReactEventHandler;     [onStalled](react_router.NavLinkProps.html#onStalled) ?: ReactEventHandler;     [onStalledCapture](react_router.NavLinkProps.html#onStalledCapture) ?: ReactEventHandler;     [onSubmit](react_router.NavLinkProps.html#onSubmit) ?: FormEventHandler;     [onSubmitCapture](react_router.NavLinkProps.html#onSubmitCapture) ?: FormEventHandler;     [onSuspend](react_router.NavLinkProps.html#onSuspend) ?: ReactEventHandler;     [onSuspendCapture](react_router.NavLinkProps.html#onSuspendCapture) ?: ReactEventHandler;     [onTimeUpdate](react_router.NavLinkProps.html#onTimeUpdate) ?: ReactEventHandler;     [onTimeUpdateCapture](react_router.NavLinkProps.html#onTimeUpdateCapture) ?: ReactEventHandler;     [onTouchCancel](react_router.NavLinkProps.html#onTouchCancel) ?: TouchEventHandler;     [onTouchCancelCapture](react_router.NavLinkProps.html#onTouchCancelCapture) ?: TouchEventHandler;     [onTouchEnd](react_router.NavLinkProps.html#onTouchEnd) ?: TouchEventHandler;     [onTouchEndCapture](react_router.NavLinkProps.html#onTouchEndCapture) ?: TouchEventHandler;     [onTouchMove](react_router.NavLinkProps.html#onTouchMove) ?: TouchEventHandler;     [onTouchMoveCapture](react_router.NavLinkProps.html#onTouchMoveCapture) ?: TouchEventHandler;     [onTouchStart](react_router.NavLinkProps.html#onTouchStart) ?: TouchEventHandler;     [onTouchStartCapture](react_router.NavLinkProps.html#onTouchStartCapture) ?: TouchEventHandler;     [onTransitionEnd](react_router.NavLinkProps.html#onTransitionEnd) ?: TransitionEventHandler;     [onTransitionEndCapture](react_router.NavLinkProps.html#onTransitionEndCapture) ?: TransitionEventHandler;     [onVolumeChange](react_router.NavLinkProps.html#onVolumeChange) ?: ReactEventHandler;     [onVolumeChangeCapture](react_router.NavLinkProps.html#onVolumeChangeCapture) ?: ReactEventHandler;     [onWaiting](react_router.NavLinkProps.html#onWaiting) ?: ReactEventHandler;     [onWaitingCapture](react_router.NavLinkProps.html#onWaitingCapture) ?: ReactEventHandler;     [onWheel](react_router.NavLinkProps.html#onWheel) ?: WheelEventHandler;     [onWheelCapture](react_router.NavLinkProps.html#onWheelCapture) ?: WheelEventHandler;     [ping](react_router.NavLinkProps.html#ping) ?: string;     [placeholder](react_router.NavLinkProps.html#placeholder) ?: string;     [prefetch](react_router.NavLinkProps.html#prefetch) ?: PrefetchBehavior;     [prefix](react_router.NavLinkProps.html#prefix) ?: string;     [preventScrollReset](react_router.NavLinkProps.html#preventScrollReset) ?: boolean;     [property](react_router.NavLinkProps.html#property) ?: string;     [radioGroup](react_router.NavLinkProps.html#radioGroup) ?: string;     [referrerPolicy](react_router.NavLinkProps.html#referrerPolicy) ?: HTMLAttributeReferrerPolicy;     [rel](react_router.NavLinkProps.html#rel) ?: string;     [relative](react_router.NavLinkProps.html#relative) ?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) ;     [reloadDocument](react_router.NavLinkProps.html#reloadDocument) ?: boolean;     [replace](react_router.NavLinkProps.html#replace) ?: boolean;     [resource](react_router.NavLinkProps.html#resource) ?: string;     [results](react_router.NavLinkProps.html#results) ?: number;     [rev](react_router.NavLinkProps.html#rev) ?: string;     [role](react_router.NavLinkProps.html#role) ?: AriaRole;     [security](react_router.NavLinkProps.html#security) ?: string;     [slot](react_router.NavLinkProps.html#slot) ?: string;     [spellCheck](react_router.NavLinkProps.html#spellCheck) ?: Booleanish;     [state](react_router.NavLinkProps.html#state) ?: any;     [style](react_router.NavLinkProps.html#style) ?: CSSProperties | ((props: [NavLinkRenderProps](../types/react_router.NavLinkRenderProps.html) ) => undefined | CSSProperties);     [suppressContentEditableWarning](react_router.NavLinkProps.html#suppressContentEditableWarning) ?: boolean;     [suppressHydrationWarning](react_router.NavLinkProps.html#suppressHydrationWarning) ?: boolean;     [tabIndex](react_router.NavLinkProps.html#tabIndex) ?: number;     [target](react_router.NavLinkProps.html#target) ?: HTMLAttributeAnchorTarget;     [title](react_router.NavLinkProps.html#title) ?: string;     [to](react_router.NavLinkProps.html#to) : [To](../types/react_router.To.html) ;     [translate](react_router.NavLinkProps.html#translate) ?: "yes" | "no";     [type](react_router.NavLinkProps.html#type) ?: string;     [typeof](react_router.NavLinkProps.html#typeof) ?: string;     [unselectable](react_router.NavLinkProps.html#unselectable) ?: "on" | "off";     [viewTransition](react_router.NavLinkProps.html#viewTransition) ?: boolean;     [vocab](react_router.NavLinkProps.html#vocab) ?: string; } #### Hierarchy * Omit<[LinkProps](react_router.LinkProps.html) , "className" | "style" | "children"\> * NavLinkProps ##### Index ### Properties [about?](react_router.NavLinkProps.html#about) [accessKey?](react_router.NavLinkProps.html#accessKey) [aria-activedescendant?](react_router.NavLinkProps.html#aria_activedescendant) [aria-atomic?](react_router.NavLinkProps.html#aria_atomic) [aria-autocomplete?](react_router.NavLinkProps.html#aria_autocomplete) [aria-braillelabel?](react_router.NavLinkProps.html#aria_braillelabel) [aria-brailleroledescription?](react_router.NavLinkProps.html#aria_brailleroledescription) [aria-busy?](react_router.NavLinkProps.html#aria_busy) [aria-checked?](react_router.NavLinkProps.html#aria_checked) [aria-colcount?](react_router.NavLinkProps.html#aria_colcount) [aria-colindex?](react_router.NavLinkProps.html#aria_colindex) [aria-colindextext?](react_router.NavLinkProps.html#aria_colindextext) [aria-colspan?](react_router.NavLinkProps.html#aria_colspan) [aria-controls?](react_router.NavLinkProps.html#aria_controls) [aria-current?](react_router.NavLinkProps.html#aria_current) [aria-describedby?](react_router.NavLinkProps.html#aria_describedby) [aria-description?](react_router.NavLinkProps.html#aria_description) [aria-details?](react_router.NavLinkProps.html#aria_details) [aria-disabled?](react_router.NavLinkProps.html#aria_disabled) [aria-dropeffect?](react_router.NavLinkProps.html#aria_dropeffect) [aria-errormessage?](react_router.NavLinkProps.html#aria_errormessage) [aria-expanded?](react_router.NavLinkProps.html#aria_expanded) [aria-flowto?](react_router.NavLinkProps.html#aria_flowto) [aria-grabbed?](react_router.NavLinkProps.html#aria_grabbed) [aria-haspopup?](react_router.NavLinkProps.html#aria_haspopup) [aria-hidden?](react_router.NavLinkProps.html#aria_hidden) [aria-invalid?](react_router.NavLinkProps.html#aria_invalid) [aria-keyshortcuts?](react_router.NavLinkProps.html#aria_keyshortcuts) [aria-label?](react_router.NavLinkProps.html#aria_label) [aria-labelledby?](react_router.NavLinkProps.html#aria_labelledby) [aria-level?](react_router.NavLinkProps.html#aria_level) [aria-live?](react_router.NavLinkProps.html#aria_live) [aria-modal?](react_router.NavLinkProps.html#aria_modal) [aria-multiline?](react_router.NavLinkProps.html#aria_multiline) [aria-multiselectable?](react_router.NavLinkProps.html#aria_multiselectable) [aria-orientation?](react_router.NavLinkProps.html#aria_orientation) [aria-owns?](react_router.NavLinkProps.html#aria_owns) [aria-placeholder?](react_router.NavLinkProps.html#aria_placeholder) [aria-posinset?](react_router.NavLinkProps.html#aria_posinset) [aria-pressed?](react_router.NavLinkProps.html#aria_pressed) [aria-readonly?](react_router.NavLinkProps.html#aria_readonly) [aria-relevant?](react_router.NavLinkProps.html#aria_relevant) [aria-required?](react_router.NavLinkProps.html#aria_required) [aria-roledescription?](react_router.NavLinkProps.html#aria_roledescription) [aria-rowcount?](react_router.NavLinkProps.html#aria_rowcount) [aria-rowindex?](react_router.NavLinkProps.html#aria_rowindex) [aria-rowindextext?](react_router.NavLinkProps.html#aria_rowindextext) [aria-rowspan?](react_router.NavLinkProps.html#aria_rowspan) [aria-selected?](react_router.NavLinkProps.html#aria_selected) [aria-setsize?](react_router.NavLinkProps.html#aria_setsize) [aria-sort?](react_router.NavLinkProps.html#aria_sort) [aria-valuemax?](react_router.NavLinkProps.html#aria_valuemax) [aria-valuemin?](react_router.NavLinkProps.html#aria_valuemin) [aria-valuenow?](react_router.NavLinkProps.html#aria_valuenow) [aria-valuetext?](react_router.NavLinkProps.html#aria_valuetext) [autoCapitalize?](react_router.NavLinkProps.html#autoCapitalize) [autoCorrect?](react_router.NavLinkProps.html#autoCorrect) [autoFocus?](react_router.NavLinkProps.html#autoFocus) [autoSave?](react_router.NavLinkProps.html#autoSave) [caseSensitive?](react_router.NavLinkProps.html#caseSensitive) [children?](react_router.NavLinkProps.html#children) [className?](react_router.NavLinkProps.html#className) [color?](react_router.NavLinkProps.html#color) [content?](react_router.NavLinkProps.html#content) [contentEditable?](react_router.NavLinkProps.html#contentEditable) [contextMenu?](react_router.NavLinkProps.html#contextMenu) [dangerouslySetInnerHTML?](react_router.NavLinkProps.html#dangerouslySetInnerHTML) [datatype?](react_router.NavLinkProps.html#datatype) [defaultChecked?](react_router.NavLinkProps.html#defaultChecked) [defaultValue?](react_router.NavLinkProps.html#defaultValue) [dir?](react_router.NavLinkProps.html#dir) [discover?](react_router.NavLinkProps.html#discover) [download?](react_router.NavLinkProps.html#download) [draggable?](react_router.NavLinkProps.html#draggable) [end?](react_router.NavLinkProps.html#end) [hidden?](react_router.NavLinkProps.html#hidden) [hrefLang?](react_router.NavLinkProps.html#hrefLang) [id?](react_router.NavLinkProps.html#id) [inlist?](react_router.NavLinkProps.html#inlist) [inputMode?](react_router.NavLinkProps.html#inputMode) [is?](react_router.NavLinkProps.html#is) [itemID?](react_router.NavLinkProps.html#itemID) [itemProp?](react_router.NavLinkProps.html#itemProp) [itemRef?](react_router.NavLinkProps.html#itemRef) [itemScope?](react_router.NavLinkProps.html#itemScope) [itemType?](react_router.NavLinkProps.html#itemType) [lang?](react_router.NavLinkProps.html#lang) [media?](react_router.NavLinkProps.html#media) [nonce?](react_router.NavLinkProps.html#nonce) [onAbort?](react_router.NavLinkProps.html#onAbort) [onAbortCapture?](react_router.NavLinkProps.html#onAbortCapture) [onAnimationEnd?](react_router.NavLinkProps.html#onAnimationEnd) [onAnimationEndCapture?](react_router.NavLinkProps.html#onAnimationEndCapture) [onAnimationIteration?](react_router.NavLinkProps.html#onAnimationIteration) [onAnimationIterationCapture?](react_router.NavLinkProps.html#onAnimationIterationCapture) [onAnimationStart?](react_router.NavLinkProps.html#onAnimationStart) [onAnimationStartCapture?](react_router.NavLinkProps.html#onAnimationStartCapture) [onAuxClick?](react_router.NavLinkProps.html#onAuxClick) [onAuxClickCapture?](react_router.NavLinkProps.html#onAuxClickCapture) [onBeforeInput?](react_router.NavLinkProps.html#onBeforeInput) [onBeforeInputCapture?](react_router.NavLinkProps.html#onBeforeInputCapture) [onBlur?](react_router.NavLinkProps.html#onBlur) [onBlurCapture?](react_router.NavLinkProps.html#onBlurCapture) [onCanPlay?](react_router.NavLinkProps.html#onCanPlay) [onCanPlayCapture?](react_router.NavLinkProps.html#onCanPlayCapture) [onCanPlayThrough?](react_router.NavLinkProps.html#onCanPlayThrough) [onCanPlayThroughCapture?](react_router.NavLinkProps.html#onCanPlayThroughCapture) [onChange?](react_router.NavLinkProps.html#onChange) [onChangeCapture?](react_router.NavLinkProps.html#onChangeCapture) [onClick?](react_router.NavLinkProps.html#onClick) [onClickCapture?](react_router.NavLinkProps.html#onClickCapture) [onCompositionEnd?](react_router.NavLinkProps.html#onCompositionEnd) [onCompositionEndCapture?](react_router.NavLinkProps.html#onCompositionEndCapture) [onCompositionStart?](react_router.NavLinkProps.html#onCompositionStart) [onCompositionStartCapture?](react_router.NavLinkProps.html#onCompositionStartCapture) [onCompositionUpdate?](react_router.NavLinkProps.html#onCompositionUpdate) [onCompositionUpdateCapture?](react_router.NavLinkProps.html#onCompositionUpdateCapture) [onContextMenu?](react_router.NavLinkProps.html#onContextMenu) [onContextMenuCapture?](react_router.NavLinkProps.html#onContextMenuCapture) [onCopy?](react_router.NavLinkProps.html#onCopy) [onCopyCapture?](react_router.NavLinkProps.html#onCopyCapture) [onCut?](react_router.NavLinkProps.html#onCut) [onCutCapture?](react_router.NavLinkProps.html#onCutCapture) [onDoubleClick?](react_router.NavLinkProps.html#onDoubleClick) [onDoubleClickCapture?](react_router.NavLinkProps.html#onDoubleClickCapture) [onDrag?](react_router.NavLinkProps.html#onDrag) [onDragCapture?](react_router.NavLinkProps.html#onDragCapture) [onDragEnd?](react_router.NavLinkProps.html#onDragEnd) [onDragEndCapture?](react_router.NavLinkProps.html#onDragEndCapture) [onDragEnter?](react_router.NavLinkProps.html#onDragEnter) [onDragEnterCapture?](react_router.NavLinkProps.html#onDragEnterCapture) [onDragExit?](react_router.NavLinkProps.html#onDragExit) [onDragExitCapture?](react_router.NavLinkProps.html#onDragExitCapture) [onDragLeave?](react_router.NavLinkProps.html#onDragLeave) [onDragLeaveCapture?](react_router.NavLinkProps.html#onDragLeaveCapture) [onDragOver?](react_router.NavLinkProps.html#onDragOver) [onDragOverCapture?](react_router.NavLinkProps.html#onDragOverCapture) [onDragStart?](react_router.NavLinkProps.html#onDragStart) [onDragStartCapture?](react_router.NavLinkProps.html#onDragStartCapture) [onDrop?](react_router.NavLinkProps.html#onDrop) [onDropCapture?](react_router.NavLinkProps.html#onDropCapture) [onDurationChange?](react_router.NavLinkProps.html#onDurationChange) [onDurationChangeCapture?](react_router.NavLinkProps.html#onDurationChangeCapture) [onEmptied?](react_router.NavLinkProps.html#onEmptied) [onEmptiedCapture?](react_router.NavLinkProps.html#onEmptiedCapture) [onEncrypted?](react_router.NavLinkProps.html#onEncrypted) [onEncryptedCapture?](react_router.NavLinkProps.html#onEncryptedCapture) [onEnded?](react_router.NavLinkProps.html#onEnded) [onEndedCapture?](react_router.NavLinkProps.html#onEndedCapture) [onError?](react_router.NavLinkProps.html#onError) [onErrorCapture?](react_router.NavLinkProps.html#onErrorCapture) [onFocus?](react_router.NavLinkProps.html#onFocus) [onFocusCapture?](react_router.NavLinkProps.html#onFocusCapture) [onGotPointerCapture?](react_router.NavLinkProps.html#onGotPointerCapture) [onGotPointerCaptureCapture?](react_router.NavLinkProps.html#onGotPointerCaptureCapture) [onInput?](react_router.NavLinkProps.html#onInput) [onInputCapture?](react_router.NavLinkProps.html#onInputCapture) [onInvalid?](react_router.NavLinkProps.html#onInvalid) [onInvalidCapture?](react_router.NavLinkProps.html#onInvalidCapture) [onKeyDown?](react_router.NavLinkProps.html#onKeyDown) [onKeyDownCapture?](react_router.NavLinkProps.html#onKeyDownCapture) [onKeyPress?](react_router.NavLinkProps.html#onKeyPress) [onKeyPressCapture?](react_router.NavLinkProps.html#onKeyPressCapture) [onKeyUp?](react_router.NavLinkProps.html#onKeyUp) [onKeyUpCapture?](react_router.NavLinkProps.html#onKeyUpCapture) [onLoad?](react_router.NavLinkProps.html#onLoad) [onLoadCapture?](react_router.NavLinkProps.html#onLoadCapture) [onLoadedData?](react_router.NavLinkProps.html#onLoadedData) [onLoadedDataCapture?](react_router.NavLinkProps.html#onLoadedDataCapture) [onLoadedMetadata?](react_router.NavLinkProps.html#onLoadedMetadata) [onLoadedMetadataCapture?](react_router.NavLinkProps.html#onLoadedMetadataCapture) [onLoadStart?](react_router.NavLinkProps.html#onLoadStart) [onLoadStartCapture?](react_router.NavLinkProps.html#onLoadStartCapture) [onLostPointerCapture?](react_router.NavLinkProps.html#onLostPointerCapture) [onLostPointerCaptureCapture?](react_router.NavLinkProps.html#onLostPointerCaptureCapture) [onMouseDown?](react_router.NavLinkProps.html#onMouseDown) [onMouseDownCapture?](react_router.NavLinkProps.html#onMouseDownCapture) [onMouseEnter?](react_router.NavLinkProps.html#onMouseEnter) [onMouseLeave?](react_router.NavLinkProps.html#onMouseLeave) [onMouseMove?](react_router.NavLinkProps.html#onMouseMove) [onMouseMoveCapture?](react_router.NavLinkProps.html#onMouseMoveCapture) [onMouseOut?](react_router.NavLinkProps.html#onMouseOut) [onMouseOutCapture?](react_router.NavLinkProps.html#onMouseOutCapture) [onMouseOver?](react_router.NavLinkProps.html#onMouseOver) [onMouseOverCapture?](react_router.NavLinkProps.html#onMouseOverCapture) [onMouseUp?](react_router.NavLinkProps.html#onMouseUp) [onMouseUpCapture?](react_router.NavLinkProps.html#onMouseUpCapture) [onPaste?](react_router.NavLinkProps.html#onPaste) [onPasteCapture?](react_router.NavLinkProps.html#onPasteCapture) [onPause?](react_router.NavLinkProps.html#onPause) [onPauseCapture?](react_router.NavLinkProps.html#onPauseCapture) [onPlay?](react_router.NavLinkProps.html#onPlay) [onPlayCapture?](react_router.NavLinkProps.html#onPlayCapture) [onPlaying?](react_router.NavLinkProps.html#onPlaying) [onPlayingCapture?](react_router.NavLinkProps.html#onPlayingCapture) [onPointerCancel?](react_router.NavLinkProps.html#onPointerCancel) [onPointerCancelCapture?](react_router.NavLinkProps.html#onPointerCancelCapture) [onPointerDown?](react_router.NavLinkProps.html#onPointerDown) [onPointerDownCapture?](react_router.NavLinkProps.html#onPointerDownCapture) [onPointerEnter?](react_router.NavLinkProps.html#onPointerEnter) [onPointerEnterCapture?](react_router.NavLinkProps.html#onPointerEnterCapture) [onPointerLeave?](react_router.NavLinkProps.html#onPointerLeave) [onPointerLeaveCapture?](react_router.NavLinkProps.html#onPointerLeaveCapture) [onPointerMove?](react_router.NavLinkProps.html#onPointerMove) [onPointerMoveCapture?](react_router.NavLinkProps.html#onPointerMoveCapture) [onPointerOut?](react_router.NavLinkProps.html#onPointerOut) [onPointerOutCapture?](react_router.NavLinkProps.html#onPointerOutCapture) [onPointerOver?](react_router.NavLinkProps.html#onPointerOver) [onPointerOverCapture?](react_router.NavLinkProps.html#onPointerOverCapture) [onPointerUp?](react_router.NavLinkProps.html#onPointerUp) [onPointerUpCapture?](react_router.NavLinkProps.html#onPointerUpCapture) [onProgress?](react_router.NavLinkProps.html#onProgress) [onProgressCapture?](react_router.NavLinkProps.html#onProgressCapture) [onRateChange?](react_router.NavLinkProps.html#onRateChange) [onRateChangeCapture?](react_router.NavLinkProps.html#onRateChangeCapture) [onReset?](react_router.NavLinkProps.html#onReset) [onResetCapture?](react_router.NavLinkProps.html#onResetCapture) [onResize?](react_router.NavLinkProps.html#onResize) [onResizeCapture?](react_router.NavLinkProps.html#onResizeCapture) [onScroll?](react_router.NavLinkProps.html#onScroll) [onScrollCapture?](react_router.NavLinkProps.html#onScrollCapture) [onSeeked?](react_router.NavLinkProps.html#onSeeked) [onSeekedCapture?](react_router.NavLinkProps.html#onSeekedCapture) [onSeeking?](react_router.NavLinkProps.html#onSeeking) [onSeekingCapture?](react_router.NavLinkProps.html#onSeekingCapture) [onSelect?](react_router.NavLinkProps.html#onSelect) [onSelectCapture?](react_router.NavLinkProps.html#onSelectCapture) [onStalled?](react_router.NavLinkProps.html#onStalled) [onStalledCapture?](react_router.NavLinkProps.html#onStalledCapture) [onSubmit?](react_router.NavLinkProps.html#onSubmit) [onSubmitCapture?](react_router.NavLinkProps.html#onSubmitCapture) [onSuspend?](react_router.NavLinkProps.html#onSuspend) [onSuspendCapture?](react_router.NavLinkProps.html#onSuspendCapture) [onTimeUpdate?](react_router.NavLinkProps.html#onTimeUpdate) [onTimeUpdateCapture?](react_router.NavLinkProps.html#onTimeUpdateCapture) [onTouchCancel?](react_router.NavLinkProps.html#onTouchCancel) [onTouchCancelCapture?](react_router.NavLinkProps.html#onTouchCancelCapture) [onTouchEnd?](react_router.NavLinkProps.html#onTouchEnd) [onTouchEndCapture?](react_router.NavLinkProps.html#onTouchEndCapture) [onTouchMove?](react_router.NavLinkProps.html#onTouchMove) [onTouchMoveCapture?](react_router.NavLinkProps.html#onTouchMoveCapture) [onTouchStart?](react_router.NavLinkProps.html#onTouchStart) [onTouchStartCapture?](react_router.NavLinkProps.html#onTouchStartCapture) [onTransitionEnd?](react_router.NavLinkProps.html#onTransitionEnd) [onTransitionEndCapture?](react_router.NavLinkProps.html#onTransitionEndCapture) [onVolumeChange?](react_router.NavLinkProps.html#onVolumeChange) [onVolumeChangeCapture?](react_router.NavLinkProps.html#onVolumeChangeCapture) [onWaiting?](react_router.NavLinkProps.html#onWaiting) [onWaitingCapture?](react_router.NavLinkProps.html#onWaitingCapture) [onWheel?](react_router.NavLinkProps.html#onWheel) [onWheelCapture?](react_router.NavLinkProps.html#onWheelCapture) [ping?](react_router.NavLinkProps.html#ping) [placeholder?](react_router.NavLinkProps.html#placeholder) [prefetch?](react_router.NavLinkProps.html#prefetch) [prefix?](react_router.NavLinkProps.html#prefix) [preventScrollReset?](react_router.NavLinkProps.html#preventScrollReset) [property?](react_router.NavLinkProps.html#property) [radioGroup?](react_router.NavLinkProps.html#radioGroup) [referrerPolicy?](react_router.NavLinkProps.html#referrerPolicy) [rel?](react_router.NavLinkProps.html#rel) [relative?](react_router.NavLinkProps.html#relative) [reloadDocument?](react_router.NavLinkProps.html#reloadDocument) [replace?](react_router.NavLinkProps.html#replace) [resource?](react_router.NavLinkProps.html#resource) [results?](react_router.NavLinkProps.html#results) [rev?](react_router.NavLinkProps.html#rev) [role?](react_router.NavLinkProps.html#role) [security?](react_router.NavLinkProps.html#security) [slot?](react_router.NavLinkProps.html#slot) [spellCheck?](react_router.NavLinkProps.html#spellCheck) [state?](react_router.NavLinkProps.html#state) [style?](react_router.NavLinkProps.html#style) [suppressContentEditableWarning?](react_router.NavLinkProps.html#suppressContentEditableWarning) [suppressHydrationWarning?](react_router.NavLinkProps.html#suppressHydrationWarning) [tabIndex?](react_router.NavLinkProps.html#tabIndex) [target?](react_router.NavLinkProps.html#target) [title?](react_router.NavLinkProps.html#title) [to](react_router.NavLinkProps.html#to) [translate?](react_router.NavLinkProps.html#translate) [type?](react_router.NavLinkProps.html#type) [typeof?](react_router.NavLinkProps.html#typeof) [unselectable?](react_router.NavLinkProps.html#unselectable) [viewTransition?](react_router.NavLinkProps.html#viewTransition) [vocab?](react_router.NavLinkProps.html#vocab) Properties ---------- ### `Optional`about[](#about) about?: string ### `Optional`accessKey[](#accessKey) accessKey?: string ### `Optional`aria-activedescendant[](#aria_activedescendant) aria-activedescendant?: string Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. ### `Optional`aria-atomic[](#aria_atomic) aria-atomic?: Booleanish Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. ### `Optional`aria-autocomplete[](#aria_autocomplete) aria-autocomplete?:     | "none"     | "list"     | "inline"     | "both" Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made. ### `Optional`aria-braillelabel[](#aria_braillelabel) aria-braillelabel?: string Defines a string value that labels the current element, which is intended to be converted into Braille. #### See[](#See) aria-label. ### `Optional`aria-brailleroledescription[](#aria_brailleroledescription) aria-brailleroledescription?: string Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. #### See[](#See-1) aria-roledescription. ### `Optional`aria-busy[](#aria_busy) aria-busy?: Booleanish ### `Optional`aria-checked[](#aria_checked) aria-checked?:     | boolean     | "true"     | "false"     | "mixed" Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. #### See[](#See-2) * aria-pressed * aria-selected. ### `Optional`aria-colcount[](#aria_colcount) aria-colcount?: number Defines the total number of columns in a table, grid, or treegrid. #### See[](#See-3) aria-colindex. ### `Optional`aria-colindex[](#aria_colindex) aria-colindex?: number Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. #### See[](#See-4) * aria-colcount * aria-colspan. ### `Optional`aria-colindextext[](#aria_colindextext) aria-colindextext?: string Defines a human readable text alternative of aria-colindex. #### See[](#See-5) aria-rowindextext. ### `Optional`aria-colspan[](#aria_colspan) aria-colspan?: number Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. #### See[](#See-6) * aria-colindex * aria-rowspan. ### `Optional`aria-controls[](#aria_controls) aria-controls?: string Identifies the element (or elements) whose contents or presence are controlled by the current element. #### See[](#See-7) aria-owns. ### `Optional`aria-current[](#aria_current) aria-current?:     | boolean     | "time"     | "true"     | "location"     | "page"     | "step"     | "false"     | "date" Indicates the element that represents the current item within a container or set of related elements. ### `Optional`aria-describedby[](#aria_describedby) aria-describedby?: string Identifies the element (or elements) that describes the object. #### See[](#See-8) aria-labelledby ### `Optional`aria-description[](#aria_description) aria-description?: string Defines a string value that describes or annotates the current element. #### See[](#See-9) related aria-describedby. ### `Optional`aria-details[](#aria_details) aria-details?: string Identifies the element that provides a detailed, extended description for the object. #### See[](#See-10) aria-describedby. ### `Optional`aria-disabled[](#aria_disabled) aria-disabled?: Booleanish Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. #### See[](#See-11) * aria-hidden * aria-readonly. ### `Optional`aria-dropeffect[](#aria_dropeffect) aria-dropeffect?:     | "link"     | "copy"     | "none"     | "execute"     | "move"     | "popup" Indicates what functions can be performed when a dragged object is released on the drop target. #### Deprecated[](#Deprecated) in ARIA 1.1 ### `Optional`aria-errormessage[](#aria_errormessage) aria-errormessage?: string Identifies the element that provides an error message for the object. #### See[](#See-12) * aria-invalid * aria-describedby. ### `Optional`aria-expanded[](#aria_expanded) aria-expanded?: Booleanish Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. ### `Optional`aria-flowto[](#aria_flowto) aria-flowto?: string Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. ### `Optional`aria-grabbed[](#aria_grabbed) aria-grabbed?: Booleanish Indicates an element's "grabbed" state in a drag-and-drop operation. #### Deprecated[](#Deprecated-1) in ARIA 1.1 ### `Optional`aria-haspopup[](#aria_haspopup) aria-haspopup?:     | boolean     | "dialog"     | "menu"     | "true"     | "false"     | "grid"     | "listbox"     | "tree" Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. ### `Optional`aria-hidden[](#aria_hidden) aria-hidden?: Booleanish Indicates whether the element is exposed to an accessibility API. #### See[](#See-13) aria-disabled. ### `Optional`aria-invalid[](#aria_invalid) aria-invalid?:     | boolean     | "true"     | "false"     | "grammar"     | "spelling" Indicates the entered value does not conform to the format expected by the application. #### See[](#See-14) aria-errormessage. ### `Optional`aria-keyshortcuts[](#aria_keyshortcuts) aria-keyshortcuts?: string Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. ### `Optional`aria-label[](#aria_label) aria-label?: string Defines a string value that labels the current element. #### See[](#See-15) aria-labelledby. ### `Optional`aria-labelledby[](#aria_labelledby) aria-labelledby?: string Identifies the element (or elements) that labels the current element. #### See[](#See-16) aria-describedby. ### `Optional`aria-level[](#aria_level) aria-level?: number Defines the hierarchical level of an element within a structure. ### `Optional`aria-live[](#aria_live) aria-live?: "off" | "assertive" | "polite" Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. ### `Optional`aria-modal[](#aria_modal) aria-modal?: Booleanish Indicates whether an element is modal when displayed. ### `Optional`aria-multiline[](#aria_multiline) aria-multiline?: Booleanish Indicates whether a text box accepts multiple lines of input or only a single line. ### `Optional`aria-multiselectable[](#aria_multiselectable) aria-multiselectable?: Booleanish Indicates that the user may select more than one item from the current selectable descendants. ### `Optional`aria-orientation[](#aria_orientation) aria-orientation?: "horizontal" | "vertical" Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. ### `Optional`aria-owns[](#aria_owns) aria-owns?: string Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. #### See[](#See-17) aria-controls. ### `Optional`aria-placeholder[](#aria_placeholder) aria-placeholder?: string Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. ### `Optional`aria-posinset[](#aria_posinset) aria-posinset?: number Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. #### See[](#See-18) aria-setsize. ### `Optional`aria-pressed[](#aria_pressed) aria-pressed?:     | boolean     | "true"     | "false"     | "mixed" Indicates the current "pressed" state of toggle buttons. #### See[](#See-19) * aria-checked * aria-selected. ### `Optional`aria-readonly[](#aria_readonly) aria-readonly?: Booleanish Indicates that the element is not editable, but is otherwise operable. #### See[](#See-20) aria-disabled. ### `Optional`aria-relevant[](#aria_relevant) aria-relevant?:     | "text"     | "additions"     | "additions removals"     | "additions text"     | "all"     | "removals"     | "removals additions"     | "removals text"     | "text additions"     | "text removals" Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. #### See[](#See-21) aria-atomic. ### `Optional`aria-required[](#aria_required) aria-required?: Booleanish Indicates that user input is required on the element before a form may be submitted. ### `Optional`aria-roledescription[](#aria_roledescription) aria-roledescription?: string Defines a human-readable, author-localized description for the role of an element. ### `Optional`aria-rowcount[](#aria_rowcount) aria-rowcount?: number Defines the total number of rows in a table, grid, or treegrid. #### See[](#See-22) aria-rowindex. ### `Optional`aria-rowindex[](#aria_rowindex) aria-rowindex?: number Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. #### See[](#See-23) * aria-rowcount * aria-rowspan. ### `Optional`aria-rowindextext[](#aria_rowindextext) aria-rowindextext?: string Defines a human readable text alternative of aria-rowindex. #### See[](#See-24) aria-colindextext. ### `Optional`aria-rowspan[](#aria_rowspan) aria-rowspan?: number Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. #### See[](#See-25) * aria-rowindex * aria-colspan. ### `Optional`aria-selected[](#aria_selected) aria-selected?: Booleanish Indicates the current "selected" state of various widgets. #### See[](#See-26) * aria-checked * aria-pressed. ### `Optional`aria-setsize[](#aria_setsize) aria-setsize?: number Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. #### See[](#See-27) aria-posinset. ### `Optional`aria-sort[](#aria_sort) aria-sort?:     | "none"     | "ascending"     | "descending"     | "other" Indicates if items in a table or grid are sorted in ascending or descending order. ### `Optional`aria-valuemax[](#aria_valuemax) aria-valuemax?: number Defines the maximum allowed value for a range widget. ### `Optional`aria-valuemin[](#aria_valuemin) aria-valuemin?: number Defines the minimum allowed value for a range widget. ### `Optional`aria-valuenow[](#aria_valuenow) aria-valuenow?: number Defines the current value for a range widget. #### See[](#See-28) aria-valuetext. ### `Optional`aria-valuetext[](#aria_valuetext) aria-valuetext?: string Defines the human readable text alternative of aria-valuenow for a range widget. ### `Optional`autoCapitalize[](#autoCapitalize) autoCapitalize?: string ### `Optional`autoCorrect[](#autoCorrect) autoCorrect?: string ### `Optional`autoFocus[](#autoFocus) autoFocus?: boolean ### `Optional`autoSave[](#autoSave) autoSave?: string ### `Optional`caseSensitive[](#caseSensitive) caseSensitive?: boolean Changes the matching logic to make it case-sensitive: | Link | URL | isActive | | --- | --- | --- | | `` | `/sponge-bob` | true | | `` | `/sponge-bob` | false | ### `Optional`children[](#children) children?: ReactNode | ((props: [NavLinkRenderProps](../types/react_router.NavLinkRenderProps.html) ) => ReactNode) Can be regular React children or a function that receives an object with the active and pending states of the link. {({ isActive }) => ( Tasks )} ### `Optional`className[](#className) className?: string | ((props: [NavLinkRenderProps](../types/react_router.NavLinkRenderProps.html) ) => undefined | string) Classes are automatically applied to NavLink that correspond to [NavLinkRenderProps](../types/react_router.NavLinkRenderProps.html) . a.active { color: red; }a.pending { color: blue; }a.transitioning { view-transition-name: my-transition;} ### `Optional`color[](#color) color?: string ### `Optional`content[](#content) content?: string ### `Optional`contentEditable[](#contentEditable) contentEditable?: Booleanish | "inherit" ### `Optional`contextMenu[](#contextMenu) contextMenu?: string ### `Optional`dangerouslySetInnerHTML[](#dangerouslySetInnerHTML) dangerouslySetInnerHTML?: {     \_\_html: string | TrustedHTML; } ### `Optional`datatype[](#datatype) datatype?: string ### `Optional`defaultChecked[](#defaultChecked) defaultChecked?: boolean ### `Optional`defaultValue[](#defaultValue) defaultValue?: string | number | readonly string\[\] ### `Optional`dir[](#dir) dir?: string ### `Optional`discover[](#discover) discover?: DiscoverBehavior Defines the link discovery behavior // default ("render") * **render** - default, discover the route when the link renders * **none** - don't eagerly discover, only discover if the link is clicked ### `Optional`download[](#download) download?: any ### `Optional`draggable[](#draggable) draggable?: Booleanish ### `Optional`end[](#end) end?: boolean Changes the matching logic for the `active` and `pending` states to only match to the "end" of the [NavLinkProps.to](react_router.NavLinkProps.html#to) . If the URL is longer, it will no longer be considered active. | Link | URL | isActive | | --- | --- | --- | | `` | `/tasks` | true | | `` | `/tasks/123` | true | | `` | `/tasks` | true | | `` | `/tasks/123` | false | `` is an exceptional case because _every_ URL matches `/`. To avoid this matching every single route by default, it effectively ignores the `end` prop and only matches when you're at the root route. ### `Optional`hidden[](#hidden) hidden?: boolean ### `Optional`hrefLang[](#hrefLang) hrefLang?: string ### `Optional`id[](#id) id?: string ### `Optional`inlist[](#inlist) inlist?: any ### `Optional`inputMode[](#inputMode) inputMode?:     | "search"     | "text"     | "url"     | "none"     | "tel"     | "email"     | "numeric"     | "decimal" Hints at the type of data that might be entered by the user while editing the element or its contents #### See[](#See-29) [https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute) ### `Optional`is[](#is) is?: string Specify that a standard HTML element should behave like a defined custom built-in element #### See[](#See-30) [https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is](https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is) ### `Optional`itemID[](#itemID) itemID?: string ### `Optional`itemProp[](#itemProp) itemProp?: string ### `Optional`itemRef[](#itemRef) itemRef?: string ### `Optional`itemScope[](#itemScope) itemScope?: boolean ### `Optional`itemType[](#itemType) itemType?: string ### `Optional`lang[](#lang) lang?: string ### `Optional`media[](#media) media?: string ### `Optional`nonce[](#nonce) nonce?: string ### `Optional`onAbort[](#onAbort) onAbort?: ReactEventHandler ### `Optional`onAbortCapture[](#onAbortCapture) onAbortCapture?: ReactEventHandler ### `Optional`onAnimationEnd[](#onAnimationEnd) onAnimationEnd?: AnimationEventHandler ### `Optional`onAnimationEndCapture[](#onAnimationEndCapture) onAnimationEndCapture?: AnimationEventHandler ### `Optional`onAnimationIteration[](#onAnimationIteration) onAnimationIteration?: AnimationEventHandler ### `Optional`onAnimationIterationCapture[](#onAnimationIterationCapture) onAnimationIterationCapture?: AnimationEventHandler ### `Optional`onAnimationStart[](#onAnimationStart) onAnimationStart?: AnimationEventHandler ### `Optional`onAnimationStartCapture[](#onAnimationStartCapture) onAnimationStartCapture?: AnimationEventHandler ### `Optional`onAuxClick[](#onAuxClick) onAuxClick?: MouseEventHandler ### `Optional`onAuxClickCapture[](#onAuxClickCapture) onAuxClickCapture?: MouseEventHandler ### `Optional`onBeforeInput[](#onBeforeInput) onBeforeInput?: FormEventHandler ### `Optional`onBeforeInputCapture[](#onBeforeInputCapture) onBeforeInputCapture?: FormEventHandler ### `Optional`onBlur[](#onBlur) onBlur?: FocusEventHandler ### `Optional`onBlurCapture[](#onBlurCapture) onBlurCapture?: FocusEventHandler ### `Optional`onCanPlay[](#onCanPlay) onCanPlay?: ReactEventHandler ### `Optional`onCanPlayCapture[](#onCanPlayCapture) onCanPlayCapture?: ReactEventHandler ### `Optional`onCanPlayThrough[](#onCanPlayThrough) onCanPlayThrough?: ReactEventHandler ### `Optional`onCanPlayThroughCapture[](#onCanPlayThroughCapture) onCanPlayThroughCapture?: ReactEventHandler ### `Optional`onChange[](#onChange) onChange?: FormEventHandler ### `Optional`onChangeCapture[](#onChangeCapture) onChangeCapture?: FormEventHandler ### `Optional`onClick[](#onClick) onClick?: MouseEventHandler ### `Optional`onClickCapture[](#onClickCapture) onClickCapture?: MouseEventHandler ### `Optional`onCompositionEnd[](#onCompositionEnd) onCompositionEnd?: CompositionEventHandler ### `Optional`onCompositionEndCapture[](#onCompositionEndCapture) onCompositionEndCapture?: CompositionEventHandler ### `Optional`onCompositionStart[](#onCompositionStart) onCompositionStart?: CompositionEventHandler ### `Optional`onCompositionStartCapture[](#onCompositionStartCapture) onCompositionStartCapture?: CompositionEventHandler ### `Optional`onCompositionUpdate[](#onCompositionUpdate) onCompositionUpdate?: CompositionEventHandler ### `Optional`onCompositionUpdateCapture[](#onCompositionUpdateCapture) onCompositionUpdateCapture?: CompositionEventHandler ### `Optional`onContextMenu[](#onContextMenu) onContextMenu?: MouseEventHandler ### `Optional`onContextMenuCapture[](#onContextMenuCapture) onContextMenuCapture?: MouseEventHandler ### `Optional`onCopy[](#onCopy) onCopy?: ClipboardEventHandler ### `Optional`onCopyCapture[](#onCopyCapture) onCopyCapture?: ClipboardEventHandler ### `Optional`onCut[](#onCut) onCut?: ClipboardEventHandler ### `Optional`onCutCapture[](#onCutCapture) onCutCapture?: ClipboardEventHandler ### `Optional`onDoubleClick[](#onDoubleClick) onDoubleClick?: MouseEventHandler ### `Optional`onDoubleClickCapture[](#onDoubleClickCapture) onDoubleClickCapture?: MouseEventHandler ### `Optional`onDrag[](#onDrag) onDrag?: DragEventHandler ### `Optional`onDragCapture[](#onDragCapture) onDragCapture?: DragEventHandler ### `Optional`onDragEnd[](#onDragEnd) onDragEnd?: DragEventHandler ### `Optional`onDragEndCapture[](#onDragEndCapture) onDragEndCapture?: DragEventHandler ### `Optional`onDragEnter[](#onDragEnter) onDragEnter?: DragEventHandler ### `Optional`onDragEnterCapture[](#onDragEnterCapture) onDragEnterCapture?: DragEventHandler ### `Optional`onDragExit[](#onDragExit) onDragExit?: DragEventHandler ### `Optional`onDragExitCapture[](#onDragExitCapture) onDragExitCapture?: DragEventHandler ### `Optional`onDragLeave[](#onDragLeave) onDragLeave?: DragEventHandler ### `Optional`onDragLeaveCapture[](#onDragLeaveCapture) onDragLeaveCapture?: DragEventHandler ### `Optional`onDragOver[](#onDragOver) onDragOver?: DragEventHandler ### `Optional`onDragOverCapture[](#onDragOverCapture) onDragOverCapture?: DragEventHandler ### `Optional`onDragStart[](#onDragStart) onDragStart?: DragEventHandler ### `Optional`onDragStartCapture[](#onDragStartCapture) onDragStartCapture?: DragEventHandler ### `Optional`onDrop[](#onDrop) onDrop?: DragEventHandler ### `Optional`onDropCapture[](#onDropCapture) onDropCapture?: DragEventHandler ### `Optional`onDurationChange[](#onDurationChange) onDurationChange?: ReactEventHandler ### `Optional`onDurationChangeCapture[](#onDurationChangeCapture) onDurationChangeCapture?: ReactEventHandler ### `Optional`onEmptied[](#onEmptied) onEmptied?: ReactEventHandler ### `Optional`onEmptiedCapture[](#onEmptiedCapture) onEmptiedCapture?: ReactEventHandler ### `Optional`onEncrypted[](#onEncrypted) onEncrypted?: ReactEventHandler ### `Optional`onEncryptedCapture[](#onEncryptedCapture) onEncryptedCapture?: ReactEventHandler ### `Optional`onEnded[](#onEnded) onEnded?: ReactEventHandler ### `Optional`onEndedCapture[](#onEndedCapture) onEndedCapture?: ReactEventHandler ### `Optional`onError[](#onError) onError?: ReactEventHandler ### `Optional`onErrorCapture[](#onErrorCapture) onErrorCapture?: ReactEventHandler ### `Optional`onFocus[](#onFocus) onFocus?: FocusEventHandler ### `Optional`onFocusCapture[](#onFocusCapture) onFocusCapture?: FocusEventHandler ### `Optional`onGotPointerCapture[](#onGotPointerCapture) onGotPointerCapture?: PointerEventHandler ### `Optional`onGotPointerCaptureCapture[](#onGotPointerCaptureCapture) onGotPointerCaptureCapture?: PointerEventHandler ### `Optional`onInput[](#onInput) onInput?: FormEventHandler ### `Optional`onInputCapture[](#onInputCapture) onInputCapture?: FormEventHandler ### `Optional`onInvalid[](#onInvalid) onInvalid?: FormEventHandler ### `Optional`onInvalidCapture[](#onInvalidCapture) onInvalidCapture?: FormEventHandler ### `Optional`onKeyDown[](#onKeyDown) onKeyDown?: KeyboardEventHandler ### `Optional`onKeyDownCapture[](#onKeyDownCapture) onKeyDownCapture?: KeyboardEventHandler ### `Optional`onKeyPress[](#onKeyPress) onKeyPress?: KeyboardEventHandler #### Deprecated[](#Deprecated-2) ### `Optional`onKeyPressCapture[](#onKeyPressCapture) onKeyPressCapture?: KeyboardEventHandler #### Deprecated[](#Deprecated-3) ### `Optional`onKeyUp[](#onKeyUp) onKeyUp?: KeyboardEventHandler ### `Optional`onKeyUpCapture[](#onKeyUpCapture) onKeyUpCapture?: KeyboardEventHandler ### `Optional`onLoad[](#onLoad) onLoad?: ReactEventHandler ### `Optional`onLoadCapture[](#onLoadCapture) onLoadCapture?: ReactEventHandler ### `Optional`onLoadedData[](#onLoadedData) onLoadedData?: ReactEventHandler ### `Optional`onLoadedDataCapture[](#onLoadedDataCapture) onLoadedDataCapture?: ReactEventHandler ### `Optional`onLoadedMetadata[](#onLoadedMetadata) onLoadedMetadata?: ReactEventHandler ### `Optional`onLoadedMetadataCapture[](#onLoadedMetadataCapture) onLoadedMetadataCapture?: ReactEventHandler ### `Optional`onLoadStart[](#onLoadStart) onLoadStart?: ReactEventHandler ### `Optional`onLoadStartCapture[](#onLoadStartCapture) onLoadStartCapture?: ReactEventHandler ### `Optional`onLostPointerCapture[](#onLostPointerCapture) onLostPointerCapture?: PointerEventHandler ### `Optional`onLostPointerCaptureCapture[](#onLostPointerCaptureCapture) onLostPointerCaptureCapture?: PointerEventHandler ### `Optional`onMouseDown[](#onMouseDown) onMouseDown?: MouseEventHandler ### `Optional`onMouseDownCapture[](#onMouseDownCapture) onMouseDownCapture?: MouseEventHandler ### `Optional`onMouseEnter[](#onMouseEnter) onMouseEnter?: MouseEventHandler ### `Optional`onMouseLeave[](#onMouseLeave) onMouseLeave?: MouseEventHandler ### `Optional`onMouseMove[](#onMouseMove) onMouseMove?: MouseEventHandler ### `Optional`onMouseMoveCapture[](#onMouseMoveCapture) onMouseMoveCapture?: MouseEventHandler ### `Optional`onMouseOut[](#onMouseOut) onMouseOut?: MouseEventHandler ### `Optional`onMouseOutCapture[](#onMouseOutCapture) onMouseOutCapture?: MouseEventHandler ### `Optional`onMouseOver[](#onMouseOver) onMouseOver?: MouseEventHandler ### `Optional`onMouseOverCapture[](#onMouseOverCapture) onMouseOverCapture?: MouseEventHandler ### `Optional`onMouseUp[](#onMouseUp) onMouseUp?: MouseEventHandler ### `Optional`onMouseUpCapture[](#onMouseUpCapture) onMouseUpCapture?: MouseEventHandler ### `Optional`onPaste[](#onPaste) onPaste?: ClipboardEventHandler ### `Optional`onPasteCapture[](#onPasteCapture) onPasteCapture?: ClipboardEventHandler ### `Optional`onPause[](#onPause) onPause?: ReactEventHandler ### `Optional`onPauseCapture[](#onPauseCapture) onPauseCapture?: ReactEventHandler ### `Optional`onPlay[](#onPlay) onPlay?: ReactEventHandler ### `Optional`onPlayCapture[](#onPlayCapture) onPlayCapture?: ReactEventHandler ### `Optional`onPlaying[](#onPlaying) onPlaying?: ReactEventHandler ### `Optional`onPlayingCapture[](#onPlayingCapture) onPlayingCapture?: ReactEventHandler ### `Optional`onPointerCancel[](#onPointerCancel) onPointerCancel?: PointerEventHandler ### `Optional`onPointerCancelCapture[](#onPointerCancelCapture) onPointerCancelCapture?: PointerEventHandler ### `Optional`onPointerDown[](#onPointerDown) onPointerDown?: PointerEventHandler ### `Optional`onPointerDownCapture[](#onPointerDownCapture) onPointerDownCapture?: PointerEventHandler ### `Optional`onPointerEnter[](#onPointerEnter) onPointerEnter?: PointerEventHandler ### `Optional`onPointerEnterCapture[](#onPointerEnterCapture) onPointerEnterCapture?: PointerEventHandler ### `Optional`onPointerLeave[](#onPointerLeave) onPointerLeave?: PointerEventHandler ### `Optional`onPointerLeaveCapture[](#onPointerLeaveCapture) onPointerLeaveCapture?: PointerEventHandler ### `Optional`onPointerMove[](#onPointerMove) onPointerMove?: PointerEventHandler ### `Optional`onPointerMoveCapture[](#onPointerMoveCapture) onPointerMoveCapture?: PointerEventHandler ### `Optional`onPointerOut[](#onPointerOut) onPointerOut?: PointerEventHandler ### `Optional`onPointerOutCapture[](#onPointerOutCapture) onPointerOutCapture?: PointerEventHandler ### `Optional`onPointerOver[](#onPointerOver) onPointerOver?: PointerEventHandler ### `Optional`onPointerOverCapture[](#onPointerOverCapture) onPointerOverCapture?: PointerEventHandler ### `Optional`onPointerUp[](#onPointerUp) onPointerUp?: PointerEventHandler ### `Optional`onPointerUpCapture[](#onPointerUpCapture) onPointerUpCapture?: PointerEventHandler ### `Optional`onProgress[](#onProgress) onProgress?: ReactEventHandler ### `Optional`onProgressCapture[](#onProgressCapture) onProgressCapture?: ReactEventHandler ### `Optional`onRateChange[](#onRateChange) onRateChange?: ReactEventHandler ### `Optional`onRateChangeCapture[](#onRateChangeCapture) onRateChangeCapture?: ReactEventHandler ### `Optional`onReset[](#onReset) onReset?: FormEventHandler ### `Optional`onResetCapture[](#onResetCapture) onResetCapture?: FormEventHandler ### `Optional`onResize[](#onResize) onResize?: ReactEventHandler ### `Optional`onResizeCapture[](#onResizeCapture) onResizeCapture?: ReactEventHandler ### `Optional`onScroll[](#onScroll) onScroll?: UIEventHandler ### `Optional`onScrollCapture[](#onScrollCapture) onScrollCapture?: UIEventHandler ### `Optional`onSeeked[](#onSeeked) onSeeked?: ReactEventHandler ### `Optional`onSeekedCapture[](#onSeekedCapture) onSeekedCapture?: ReactEventHandler ### `Optional`onSeeking[](#onSeeking) onSeeking?: ReactEventHandler ### `Optional`onSeekingCapture[](#onSeekingCapture) onSeekingCapture?: ReactEventHandler ### `Optional`onSelect[](#onSelect) onSelect?: ReactEventHandler ### `Optional`onSelectCapture[](#onSelectCapture) onSelectCapture?: ReactEventHandler ### `Optional`onStalled[](#onStalled) onStalled?: ReactEventHandler ### `Optional`onStalledCapture[](#onStalledCapture) onStalledCapture?: ReactEventHandler ### `Optional`onSubmit[](#onSubmit) onSubmit?: FormEventHandler ### `Optional`onSubmitCapture[](#onSubmitCapture) onSubmitCapture?: FormEventHandler ### `Optional`onSuspend[](#onSuspend) onSuspend?: ReactEventHandler ### `Optional`onSuspendCapture[](#onSuspendCapture) onSuspendCapture?: ReactEventHandler ### `Optional`onTimeUpdate[](#onTimeUpdate) onTimeUpdate?: ReactEventHandler ### `Optional`onTimeUpdateCapture[](#onTimeUpdateCapture) onTimeUpdateCapture?: ReactEventHandler ### `Optional`onTouchCancel[](#onTouchCancel) onTouchCancel?: TouchEventHandler ### `Optional`onTouchCancelCapture[](#onTouchCancelCapture) onTouchCancelCapture?: TouchEventHandler ### `Optional`onTouchEnd[](#onTouchEnd) onTouchEnd?: TouchEventHandler ### `Optional`onTouchEndCapture[](#onTouchEndCapture) onTouchEndCapture?: TouchEventHandler ### `Optional`onTouchMove[](#onTouchMove) onTouchMove?: TouchEventHandler ### `Optional`onTouchMoveCapture[](#onTouchMoveCapture) onTouchMoveCapture?: TouchEventHandler ### `Optional`onTouchStart[](#onTouchStart) onTouchStart?: TouchEventHandler ### `Optional`onTouchStartCapture[](#onTouchStartCapture) onTouchStartCapture?: TouchEventHandler ### `Optional`onTransitionEnd[](#onTransitionEnd) onTransitionEnd?: TransitionEventHandler ### `Optional`onTransitionEndCapture[](#onTransitionEndCapture) onTransitionEndCapture?: TransitionEventHandler ### `Optional`onVolumeChange[](#onVolumeChange) onVolumeChange?: ReactEventHandler ### `Optional`onVolumeChangeCapture[](#onVolumeChangeCapture) onVolumeChangeCapture?: ReactEventHandler ### `Optional`onWaiting[](#onWaiting) onWaiting?: ReactEventHandler ### `Optional`onWaitingCapture[](#onWaitingCapture) onWaitingCapture?: ReactEventHandler ### `Optional`onWheel[](#onWheel) onWheel?: WheelEventHandler ### `Optional`onWheelCapture[](#onWheelCapture) onWheelCapture?: WheelEventHandler ### `Optional`ping[](#ping) ping?: string ### `Optional`placeholder[](#placeholder) placeholder?: string ### `Optional`prefetch[](#prefetch) prefetch?: PrefetchBehavior Defines the data and module prefetching behavior for the link. // default * **none** - default, no prefetching * **intent** - prefetches when the user hovers or focuses the link * **render** - prefetches when the link renders * **viewport** - prefetches when the link is in the viewport, very useful for mobile Prefetching is done with HTML `` tags. They are inserted after the link. // might conditionally render Because of this, if you are using `nav :last-child` you will need to use `nav :last-of-type` so the styles don't conditionally fall off your last link (and any other similar selectors). ### `Optional`prefix[](#prefix) prefix?: string ### `Optional`preventScrollReset[](#preventScrollReset) preventScrollReset?: boolean Prevents the scroll position from being reset to the top of the window when the link is clicked and the app is using [ScrollRestoration](../functions/react_router.ScrollRestoration.html) . This only prevents new locations reseting scroll to the top, scroll position will be restored for back/forward button navigation. ### `Optional`property[](#property) property?: string ### `Optional`radioGroup[](#radioGroup) radioGroup?: string ### `Optional`referrerPolicy[](#referrerPolicy) referrerPolicy?: HTMLAttributeReferrerPolicy ### `Optional`rel[](#rel) rel?: string ### `Optional`relative[](#relative) relative?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) Defines the relative path behavior for the link. // default: "route" Consider a route hierarchy where a parent route pattern is "blog" and a child route pattern is "blog/:slug/edit". * **route** - default, resolves the link relative to the route pattern. In the example above a relative link of `".."` will remove both `:slug/edit` segments back to "/blog". * **path** - relative to the path so `..` will only remove one URL segment up to "/blog/:slug" ### `Optional`reloadDocument[](#reloadDocument) reloadDocument?: boolean Will use document navigation instead of client side routing when the link is clicked: the browser will handle the transition normally (as if it were an ``). ### `Optional`replace[](#replace) replace?: boolean Replaces the current entry in the history stack instead of pushing a new one onto it. # with a history stack like thisA -> B# normal link click pushes a new entryA -> B -> C# but with `replace`, B is replaced by CA -> C ### `Optional`resource[](#resource) resource?: string ### `Optional`results[](#results) results?: number ### `Optional`rev[](#rev) rev?: string ### `Optional`role[](#role) role?: AriaRole ### `Optional`security[](#security) security?: string ### `Optional`slot[](#slot) slot?: string ### `Optional`spellCheck[](#spellCheck) spellCheck?: Booleanish ### `Optional`state[](#state) state?: any Adds persistent client side routing state to the next location. The location state is accessed from the `location`. function SomeComp() { const location = useLocation() location.state; // { some: "value" }} This state is inaccessible on the server as it is implemented on top of [`history.state`](https://developer.mozilla.org/en-US/docs/Web/API/History/state) ### `Optional`style[](#style) style?: CSSProperties | ((props: [NavLinkRenderProps](../types/react_router.NavLinkRenderProps.html) ) => undefined | CSSProperties) ### `Optional`suppressContentEditableWarning[](#suppressContentEditableWarning) suppressContentEditableWarning?: boolean ### `Optional`suppressHydrationWarning[](#suppressHydrationWarning) suppressHydrationWarning?: boolean ### `Optional`tabIndex[](#tabIndex) tabIndex?: number ### `Optional`target[](#target) target?: HTMLAttributeAnchorTarget ### `Optional`title[](#title) title?: string ### to[](#to) to: [To](../types/react_router.To.html) Can be a string or a partial [Path](react_router.Path.html) : ### `Optional`translate[](#translate) translate?: "yes" | "no" ### `Optional`type[](#type) type?: string ### `Optional`typeof[](#typeof) typeof?: string ### `Optional`unselectable[](#unselectable) unselectable?: "on" | "off" ### `Optional`viewTransition[](#viewTransition) viewTransition?: boolean Enables a [View Transition](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API) for this navigation. Click me To apply specific styles for the transition, see [useViewTransitionState](../functions/react_router.useViewTransitionState.html) ### `Optional`vocab[](#vocab) vocab?: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [about](#about) [accessKey](#accessKey) [aria-activedescendant](#aria_activedescendant) [aria-atomic](#aria_atomic) [aria-autocomplete](#aria_autocomplete) [aria-braillelabel](#aria_braillelabel) [aria-brailleroledescription](#aria_brailleroledescription) [aria-busy](#aria_busy) [aria-checked](#aria_checked) [aria-colcount](#aria_colcount) [aria-colindex](#aria_colindex) [aria-colindextext](#aria_colindextext) [aria-colspan](#aria_colspan) [aria-controls](#aria_controls) [aria-current](#aria_current) [aria-describedby](#aria_describedby) [aria-description](#aria_description) [aria-details](#aria_details) [aria-disabled](#aria_disabled) [aria-dropeffect](#aria_dropeffect) [aria-errormessage](#aria_errormessage) [aria-expanded](#aria_expanded) [aria-flowto](#aria_flowto) [aria-grabbed](#aria_grabbed) [aria-haspopup](#aria_haspopup) [aria-hidden](#aria_hidden) [aria-invalid](#aria_invalid) [aria-keyshortcuts](#aria_keyshortcuts) [aria-label](#aria_label) [aria-labelledby](#aria_labelledby) [aria-level](#aria_level) [aria-live](#aria_live) [aria-modal](#aria_modal) [aria-multiline](#aria_multiline) [aria-multiselectable](#aria_multiselectable) [aria-orientation](#aria_orientation) [aria-owns](#aria_owns) [aria-placeholder](#aria_placeholder) [aria-posinset](#aria_posinset) [aria-pressed](#aria_pressed) [aria-readonly](#aria_readonly) [aria-relevant](#aria_relevant) [aria-required](#aria_required) [aria-roledescription](#aria_roledescription) [aria-rowcount](#aria_rowcount) [aria-rowindex](#aria_rowindex) [aria-rowindextext](#aria_rowindextext) [aria-rowspan](#aria_rowspan) [aria-selected](#aria_selected) [aria-setsize](#aria_setsize) [aria-sort](#aria_sort) [aria-valuemax](#aria_valuemax) [aria-valuemin](#aria_valuemin) [aria-valuenow](#aria_valuenow) [aria-valuetext](#aria_valuetext) [autoCapitalize](#autoCapitalize) [autoCorrect](#autoCorrect) [autoFocus](#autoFocus) [autoSave](#autoSave) [caseSensitive](#caseSensitive) [children](#children) [className](#className) [color](#color) [content](#content) [contentEditable](#contentEditable) [contextMenu](#contextMenu) [dangerouslySetInnerHTML](#dangerouslySetInnerHTML) [datatype](#datatype) [defaultChecked](#defaultChecked) [defaultValue](#defaultValue) [dir](#dir) [discover](#discover) [download](#download) [draggable](#draggable) [end](#end) [hidden](#hidden) [hrefLang](#hrefLang) [id](#id) [inlist](#inlist) [inputMode](#inputMode) [is](#is) [itemID](#itemID) [itemProp](#itemProp) [itemRef](#itemRef) [itemScope](#itemScope) [itemType](#itemType) [lang](#lang) [media](#media) [nonce](#nonce) [onAbort](#onAbort) [onAbortCapture](#onAbortCapture) [onAnimationEnd](#onAnimationEnd) [onAnimationEndCapture](#onAnimationEndCapture) [onAnimationIteration](#onAnimationIteration) [onAnimationIterationCapture](#onAnimationIterationCapture) [onAnimationStart](#onAnimationStart) [onAnimationStartCapture](#onAnimationStartCapture) [onAuxClick](#onAuxClick) [onAuxClickCapture](#onAuxClickCapture) [onBeforeInput](#onBeforeInput) [onBeforeInputCapture](#onBeforeInputCapture) [onBlur](#onBlur) [onBlurCapture](#onBlurCapture) [onCanPlay](#onCanPlay) [onCanPlayCapture](#onCanPlayCapture) [onCanPlayThrough](#onCanPlayThrough) [onCanPlayThroughCapture](#onCanPlayThroughCapture) [onChange](#onChange) [onChangeCapture](#onChangeCapture) [onClick](#onClick) [onClickCapture](#onClickCapture) [onCompositionEnd](#onCompositionEnd) [onCompositionEndCapture](#onCompositionEndCapture) [onCompositionStart](#onCompositionStart) [onCompositionStartCapture](#onCompositionStartCapture) [onCompositionUpdate](#onCompositionUpdate) [onCompositionUpdateCapture](#onCompositionUpdateCapture) [onContextMenu](#onContextMenu) [onContextMenuCapture](#onContextMenuCapture) [onCopy](#onCopy) [onCopyCapture](#onCopyCapture) [onCut](#onCut) [onCutCapture](#onCutCapture) [onDoubleClick](#onDoubleClick) [onDoubleClickCapture](#onDoubleClickCapture) [onDrag](#onDrag) [onDragCapture](#onDragCapture) [onDragEnd](#onDragEnd) [onDragEndCapture](#onDragEndCapture) [onDragEnter](#onDragEnter) [onDragEnterCapture](#onDragEnterCapture) [onDragExit](#onDragExit) [onDragExitCapture](#onDragExitCapture) [onDragLeave](#onDragLeave) [onDragLeaveCapture](#onDragLeaveCapture) [onDragOver](#onDragOver) [onDragOverCapture](#onDragOverCapture) [onDragStart](#onDragStart) [onDragStartCapture](#onDragStartCapture) [onDrop](#onDrop) [onDropCapture](#onDropCapture) [onDurationChange](#onDurationChange) [onDurationChangeCapture](#onDurationChangeCapture) [onEmptied](#onEmptied) [onEmptiedCapture](#onEmptiedCapture) [onEncrypted](#onEncrypted) [onEncryptedCapture](#onEncryptedCapture) [onEnded](#onEnded) [onEndedCapture](#onEndedCapture) [onError](#onError) [onErrorCapture](#onErrorCapture) [onFocus](#onFocus) [onFocusCapture](#onFocusCapture) [onGotPointerCapture](#onGotPointerCapture) [onGotPointerCaptureCapture](#onGotPointerCaptureCapture) [onInput](#onInput) [onInputCapture](#onInputCapture) [onInvalid](#onInvalid) [onInvalidCapture](#onInvalidCapture) [onKeyDown](#onKeyDown) [onKeyDownCapture](#onKeyDownCapture) [onKeyPress](#onKeyPress) [onKeyPressCapture](#onKeyPressCapture) [onKeyUp](#onKeyUp) [onKeyUpCapture](#onKeyUpCapture) [onLoad](#onLoad) [onLoadCapture](#onLoadCapture) [onLoadedData](#onLoadedData) [onLoadedDataCapture](#onLoadedDataCapture) [onLoadedMetadata](#onLoadedMetadata) [onLoadedMetadataCapture](#onLoadedMetadataCapture) [onLoadStart](#onLoadStart) [onLoadStartCapture](#onLoadStartCapture) [onLostPointerCapture](#onLostPointerCapture) [onLostPointerCaptureCapture](#onLostPointerCaptureCapture) [onMouseDown](#onMouseDown) [onMouseDownCapture](#onMouseDownCapture) [onMouseEnter](#onMouseEnter) [onMouseLeave](#onMouseLeave) [onMouseMove](#onMouseMove) [onMouseMoveCapture](#onMouseMoveCapture) [onMouseOut](#onMouseOut) [onMouseOutCapture](#onMouseOutCapture) [onMouseOver](#onMouseOver) [onMouseOverCapture](#onMouseOverCapture) [onMouseUp](#onMouseUp) [onMouseUpCapture](#onMouseUpCapture) [onPaste](#onPaste) [onPasteCapture](#onPasteCapture) [onPause](#onPause) [onPauseCapture](#onPauseCapture) [onPlay](#onPlay) [onPlayCapture](#onPlayCapture) [onPlaying](#onPlaying) [onPlayingCapture](#onPlayingCapture) [onPointerCancel](#onPointerCancel) [onPointerCancelCapture](#onPointerCancelCapture) [onPointerDown](#onPointerDown) [onPointerDownCapture](#onPointerDownCapture) [onPointerEnter](#onPointerEnter) [onPointerEnterCapture](#onPointerEnterCapture) [onPointerLeave](#onPointerLeave) [onPointerLeaveCapture](#onPointerLeaveCapture) [onPointerMove](#onPointerMove) [onPointerMoveCapture](#onPointerMoveCapture) [onPointerOut](#onPointerOut) [onPointerOutCapture](#onPointerOutCapture) [onPointerOver](#onPointerOver) [onPointerOverCapture](#onPointerOverCapture) [onPointerUp](#onPointerUp) [onPointerUpCapture](#onPointerUpCapture) [onProgress](#onProgress) [onProgressCapture](#onProgressCapture) [onRateChange](#onRateChange) [onRateChangeCapture](#onRateChangeCapture) [onReset](#onReset) [onResetCapture](#onResetCapture) [onResize](#onResize) [onResizeCapture](#onResizeCapture) [onScroll](#onScroll) [onScrollCapture](#onScrollCapture) [onSeeked](#onSeeked) [onSeekedCapture](#onSeekedCapture) [onSeeking](#onSeeking) [onSeekingCapture](#onSeekingCapture) [onSelect](#onSelect) [onSelectCapture](#onSelectCapture) [onStalled](#onStalled) [onStalledCapture](#onStalledCapture) [onSubmit](#onSubmit) [onSubmitCapture](#onSubmitCapture) [onSuspend](#onSuspend) [onSuspendCapture](#onSuspendCapture) [onTimeUpdate](#onTimeUpdate) [onTimeUpdateCapture](#onTimeUpdateCapture) [onTouchCancel](#onTouchCancel) [onTouchCancelCapture](#onTouchCancelCapture) [onTouchEnd](#onTouchEnd) [onTouchEndCapture](#onTouchEndCapture) [onTouchMove](#onTouchMove) [onTouchMoveCapture](#onTouchMoveCapture) [onTouchStart](#onTouchStart) [onTouchStartCapture](#onTouchStartCapture) [onTransitionEnd](#onTransitionEnd) [onTransitionEndCapture](#onTransitionEndCapture) [onVolumeChange](#onVolumeChange) [onVolumeChangeCapture](#onVolumeChangeCapture) [onWaiting](#onWaiting) [onWaitingCapture](#onWaitingCapture) [onWheel](#onWheel) [onWheelCapture](#onWheelCapture) [ping](#ping) [placeholder](#placeholder) [prefetch](#prefetch) [prefix](#prefix) [preventScrollReset](#preventScrollReset) [property](#property) [radioGroup](#radioGroup) [referrerPolicy](#referrerPolicy) [rel](#rel) [relative](#relative) [reloadDocument](#reloadDocument) [replace](#replace) [resource](#resource) [results](#results) [rev](#rev) [role](#role) [security](#security) [slot](#slot) [spellCheck](#spellCheck) [state](#state) [style](#style) [suppressContentEditableWarning](#suppressContentEditableWarning) [suppressHydrationWarning](#suppressHydrationWarning) [tabIndex](#tabIndex) [target](#target) [title](#title) [to](#to) [translate](#translate) [type](#type) [typeof](#typeof) [unselectable](#unselectable) [viewTransition](#viewTransition) [vocab](#vocab) --- # NonIndexRouteObject | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [NonIndexRouteObject](react_router.NonIndexRouteObject.html) Interface NonIndexRouteObject ============================= interface NonIndexRouteObject {     [action](react_router.NonIndexRouteObject.html#action) ?: boolean | [ActionFunction](react_router.ActionFunction.html) ;     [caseSensitive](react_router.NonIndexRouteObject.html#caseSensitive) ?: boolean;     [children](react_router.NonIndexRouteObject.html#children) ?: [RouteObject](../types/react_router.RouteObject.html) \[\];     [Component](react_router.NonIndexRouteObject.html#Component) ?: null | ComponentType<{}\>;     [element](react_router.NonIndexRouteObject.html#element) ?: ReactNode;     [ErrorBoundary](react_router.NonIndexRouteObject.html#ErrorBoundary) ?: null | ComponentType<{}\>;     [errorElement](react_router.NonIndexRouteObject.html#errorElement) ?: ReactNode;     [handle](react_router.NonIndexRouteObject.html#handle) ?: any;     [hasErrorBoundary](react_router.NonIndexRouteObject.html#hasErrorBoundary) ?: boolean;     [HydrateFallback](react_router.NonIndexRouteObject.html#HydrateFallback) ?: null | ComponentType<{}\>;     [hydrateFallbackElement](react_router.NonIndexRouteObject.html#hydrateFallbackElement) ?: ReactNode;     [id](react_router.NonIndexRouteObject.html#id) ?: string;     [index](react_router.NonIndexRouteObject.html#index) ?: false;     [lazy](react_router.NonIndexRouteObject.html#lazy) ?: [LazyRouteFunction](react_router.LazyRouteFunction.html) <[RouteObject](../types/react_router.RouteObject.html) \>;     [loader](react_router.NonIndexRouteObject.html#loader) ?: boolean | [LoaderFunction](../types/react_router.LoaderFunction.html) ;     [path](react_router.NonIndexRouteObject.html#path) ?: string;     [shouldRevalidate](react_router.NonIndexRouteObject.html#shouldRevalidate) ?: [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) ; } ##### Index ### Properties [action?](react_router.NonIndexRouteObject.html#action) [caseSensitive?](react_router.NonIndexRouteObject.html#caseSensitive) [children?](react_router.NonIndexRouteObject.html#children) [Component?](react_router.NonIndexRouteObject.html#Component) [element?](react_router.NonIndexRouteObject.html#element) [ErrorBoundary?](react_router.NonIndexRouteObject.html#ErrorBoundary) [errorElement?](react_router.NonIndexRouteObject.html#errorElement) [handle?](react_router.NonIndexRouteObject.html#handle) [hasErrorBoundary?](react_router.NonIndexRouteObject.html#hasErrorBoundary) [HydrateFallback?](react_router.NonIndexRouteObject.html#HydrateFallback) [hydrateFallbackElement?](react_router.NonIndexRouteObject.html#hydrateFallbackElement) [id?](react_router.NonIndexRouteObject.html#id) [index?](react_router.NonIndexRouteObject.html#index) [lazy?](react_router.NonIndexRouteObject.html#lazy) [loader?](react_router.NonIndexRouteObject.html#loader) [path?](react_router.NonIndexRouteObject.html#path) [shouldRevalidate?](react_router.NonIndexRouteObject.html#shouldRevalidate) Properties ---------- ### `Optional`action[](#action) action?: boolean | [ActionFunction](react_router.ActionFunction.html) ### `Optional`caseSensitive[](#caseSensitive) caseSensitive?: boolean ### `Optional`children[](#children) children?: [RouteObject](../types/react_router.RouteObject.html) \[\] ### `Optional`Component[](#Component) Component?: null | ComponentType<{}\> ### `Optional`element[](#element) element?: ReactNode ### `Optional`ErrorBoundary[](#ErrorBoundary) ErrorBoundary?: null | ComponentType<{}\> ### `Optional`errorElement[](#errorElement) errorElement?: ReactNode ### `Optional`handle[](#handle) handle?: any ### `Optional`hasErrorBoundary[](#hasErrorBoundary) hasErrorBoundary?: boolean ### `Optional`HydrateFallback[](#HydrateFallback) HydrateFallback?: null | ComponentType<{}\> ### `Optional`hydrateFallbackElement[](#hydrateFallbackElement) hydrateFallbackElement?: ReactNode ### `Optional`id[](#id) id?: string ### `Optional`index[](#index) index ### `Optional`lazy[](#lazy) lazy?: [LazyRouteFunction](react_router.LazyRouteFunction.html) <[RouteObject](../types/react_router.RouteObject.html) \> ### `Optional`loader[](#loader) loader?: boolean | [LoaderFunction](../types/react_router.LoaderFunction.html) ### `Optional`path[](#path) path?: string ### `Optional`shouldRevalidate[](#shouldRevalidate) shouldRevalidate?: [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [action](#action) [caseSensitive](#caseSensitive) [children](#children) [Component](#Component) [element](#element) [ErrorBoundary](#ErrorBoundary) [errorElement](#errorElement) [handle](#handle) [hasErrorBoundary](#hasErrorBoundary) [HydrateFallback](#HydrateFallback) [hydrateFallbackElement](#hydrateFallbackElement) [id](#id) [index](#index) [lazy](#lazy) [loader](#loader) [path](#path) [shouldRevalidate](#shouldRevalidate) --- # PathPattern | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [PathPattern](react_router.PathPattern.html) Interface PathPattern =========================== A PathPattern is used to match on some portion of a URL pathname. interface PathPattern<[Path](react_router.PathPattern.html#Path) \> {     [caseSensitive](react_router.PathPattern.html#caseSensitive) ?: boolean;     [end](react_router.PathPattern.html#end) ?: boolean;     [path](react_router.PathPattern.html#path-1) : [Path](react_router.PathPattern.html#Path) ; } #### Type Parameters * Path extends string = string ##### Index ### Properties [caseSensitive?](react_router.PathPattern.html#caseSensitive) [end?](react_router.PathPattern.html#end) [path](react_router.PathPattern.html#path-1) Properties ---------- ### `Optional`caseSensitive[](#caseSensitive) caseSensitive?: boolean Should be `true` if the static portions of the `path` should be matched in the same case. ### `Optional`end[](#end) end?: boolean Should be `true` if this pattern should match the entire URL pathname. ### path[](#path-1) path: [Path](react_router.PathPattern.html#Path) A string to match against a URL pathname. May contain `:id`\-style segments to indicate placeholders for dynamic parameters. May also end with `/*` to indicate matching the rest of the URL pathname. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [caseSensitive](#caseSensitive) [end](#end) [path](#path-1) --- # RouteMatch | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RouteMatch](react_router.RouteMatch.html) Interface RouteMatch =============================================== interface RouteMatch<[ParamKey](react_router.RouteMatch.html#ParamKey) , [RouteObjectType](react_router.RouteMatch.html#RouteObjectType) \> {     [params](react_router.RouteMatch.html#params) : [Params](../types/react_router.Params.html) <[ParamKey](react_router.RouteMatch.html#ParamKey) \>;     [pathname](react_router.RouteMatch.html#pathname) : string;     [pathnameBase](react_router.RouteMatch.html#pathnameBase) : string;     [route](react_router.RouteMatch.html#route) : [RouteObjectType](react_router.RouteMatch.html#RouteObjectType) ; } #### Type Parameters * ParamKey extends string = string * RouteObjectType extends [RouteObject](../types/react_router.RouteObject.html) = [RouteObject](../types/react_router.RouteObject.html) #### Hierarchy ([view full](../hierarchy.html#react-router.RouteMatch) ) * AgnosticRouteMatch<[ParamKey](react_router.RouteMatch.html#ParamKey) , [RouteObjectType](react_router.RouteMatch.html#RouteObjectType) \> * RouteMatch * [DataRouteMatch](react_router.DataRouteMatch.html) ##### Index ### Properties [params](react_router.RouteMatch.html#params) [pathname](react_router.RouteMatch.html#pathname) [pathnameBase](react_router.RouteMatch.html#pathnameBase) [route](react_router.RouteMatch.html#route) Properties ---------- ### params[](#params) params: [Params](../types/react_router.Params.html) <[ParamKey](react_router.RouteMatch.html#ParamKey) \> The names and values of dynamic parameters in the URL. ### pathname[](#pathname) pathname: string The portion of the URL pathname that was matched. ### pathnameBase[](#pathnameBase) pathnameBase: string The portion of the URL pathname that was matched before child routes. ### route[](#route) route: [RouteObjectType](react_router.RouteMatch.html#RouteObjectType) The route object that was used to match. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [params](#params) [pathname](#pathname) [pathnameBase](#pathnameBase) [route](#route) --- # PathRouteProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [PathRouteProps](react_router.PathRouteProps.html) Interface PathRouteProps ======================== interface PathRouteProps {     [action](react_router.PathRouteProps.html#action) ?: boolean | [ActionFunction](react_router.ActionFunction.html) ;     [caseSensitive](react_router.PathRouteProps.html#caseSensitive) ?: boolean;     [children](react_router.PathRouteProps.html#children) ?: ReactNode;     [Component](react_router.PathRouteProps.html#Component) ?: null | ComponentType<{}\>;     [element](react_router.PathRouteProps.html#element) ?: ReactNode;     [ErrorBoundary](react_router.PathRouteProps.html#ErrorBoundary) ?: null | ComponentType<{}\>;     [errorElement](react_router.PathRouteProps.html#errorElement) ?: ReactNode;     [handle](react_router.PathRouteProps.html#handle) ?: any;     [hasErrorBoundary](react_router.PathRouteProps.html#hasErrorBoundary) ?: boolean;     [HydrateFallback](react_router.PathRouteProps.html#HydrateFallback) ?: null | ComponentType<{}\>;     [hydrateFallbackElement](react_router.PathRouteProps.html#hydrateFallbackElement) ?: ReactNode;     [id](react_router.PathRouteProps.html#id) ?: string;     [index](react_router.PathRouteProps.html#index) ?: false;     [lazy](react_router.PathRouteProps.html#lazy) ?: [LazyRouteFunction](react_router.LazyRouteFunction.html) <[NonIndexRouteObject](react_router.NonIndexRouteObject.html) \>;     [loader](react_router.PathRouteProps.html#loader) ?: boolean | [LoaderFunction](../types/react_router.LoaderFunction.html) ;     [path](react_router.PathRouteProps.html#path) ?: string;     [shouldRevalidate](react_router.PathRouteProps.html#shouldRevalidate) ?: [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) ; } #### Hierarchy ([view full](../hierarchy.html#react-router.PathRouteProps) ) * PathRouteProps * [LayoutRouteProps](react_router.LayoutRouteProps.html) ##### Index ### Properties [action?](react_router.PathRouteProps.html#action) [caseSensitive?](react_router.PathRouteProps.html#caseSensitive) [children?](react_router.PathRouteProps.html#children) [Component?](react_router.PathRouteProps.html#Component) [element?](react_router.PathRouteProps.html#element) [ErrorBoundary?](react_router.PathRouteProps.html#ErrorBoundary) [errorElement?](react_router.PathRouteProps.html#errorElement) [handle?](react_router.PathRouteProps.html#handle) [hasErrorBoundary?](react_router.PathRouteProps.html#hasErrorBoundary) [HydrateFallback?](react_router.PathRouteProps.html#HydrateFallback) [hydrateFallbackElement?](react_router.PathRouteProps.html#hydrateFallbackElement) [id?](react_router.PathRouteProps.html#id) [index?](react_router.PathRouteProps.html#index) [lazy?](react_router.PathRouteProps.html#lazy) [loader?](react_router.PathRouteProps.html#loader) [path?](react_router.PathRouteProps.html#path) [shouldRevalidate?](react_router.PathRouteProps.html#shouldRevalidate) Properties ---------- ### `Optional`action[](#action) action?: boolean | [ActionFunction](react_router.ActionFunction.html) ### `Optional`caseSensitive[](#caseSensitive) caseSensitive?: boolean ### `Optional`children[](#children) children?: ReactNode ### `Optional`Component[](#Component) Component?: null | ComponentType<{}\> ### `Optional`element[](#element) element?: ReactNode ### `Optional`ErrorBoundary[](#ErrorBoundary) ErrorBoundary?: null | ComponentType<{}\> ### `Optional`errorElement[](#errorElement) errorElement?: ReactNode ### `Optional`handle[](#handle) handle?: any ### `Optional`hasErrorBoundary[](#hasErrorBoundary) hasErrorBoundary?: boolean ### `Optional`HydrateFallback[](#HydrateFallback) HydrateFallback?: null | ComponentType<{}\> ### `Optional`hydrateFallbackElement[](#hydrateFallbackElement) hydrateFallbackElement?: ReactNode ### `Optional`id[](#id) id?: string ### `Optional`index[](#index) index ### `Optional`lazy[](#lazy) lazy?: [LazyRouteFunction](react_router.LazyRouteFunction.html) <[NonIndexRouteObject](react_router.NonIndexRouteObject.html) \> ### `Optional`loader[](#loader) loader?: boolean | [LoaderFunction](../types/react_router.LoaderFunction.html) ### `Optional`path[](#path) path?: string ### `Optional`shouldRevalidate[](#shouldRevalidate) shouldRevalidate?: [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [action](#action) [caseSensitive](#caseSensitive) [children](#children) [Component](#Component) [element](#element) [ErrorBoundary](#ErrorBoundary) [errorElement](#errorElement) [handle](#handle) [hasErrorBoundary](#hasErrorBoundary) [HydrateFallback](#HydrateFallback) [hydrateFallbackElement](#hydrateFallbackElement) [id](#id) [index](#index) [lazy](#lazy) [loader](#loader) [path](#path) [shouldRevalidate](#shouldRevalidate) --- # RouterInit | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RouterInit](react_router.RouterInit.html) Interface RouterInit ==================== Initialization options for createRouter interface RouterInit {     [basename](react_router.RouterInit.html#basename) ?: string;     [dataStrategy](react_router.RouterInit.html#dataStrategy) ?: [DataStrategyFunction](react_router.DataStrategyFunction.html) ;     [future](react_router.RouterInit.html#future) ?: Partial;     [history](react_router.RouterInit.html#history) : History;     [hydrationData](react_router.RouterInit.html#hydrationData) ?: Partial\>;     [mapRouteProperties](react_router.RouterInit.html#mapRouteProperties) ?: MapRoutePropertiesFunction;     [patchRoutesOnNavigation](react_router.RouterInit.html#patchRoutesOnNavigation) ?: AgnosticPatchRoutesOnNavigationFunction;     [routes](react_router.RouterInit.html#routes) : AgnosticRouteObject\[\];     [window](react_router.RouterInit.html#window) ?: Window; } ##### Index ### Properties [basename?](react_router.RouterInit.html#basename) [dataStrategy?](react_router.RouterInit.html#dataStrategy) [future?](react_router.RouterInit.html#future) [history](react_router.RouterInit.html#history) [hydrationData?](react_router.RouterInit.html#hydrationData) [mapRouteProperties?](react_router.RouterInit.html#mapRouteProperties) [patchRoutesOnNavigation?](react_router.RouterInit.html#patchRoutesOnNavigation) [routes](react_router.RouterInit.html#routes) [window?](react_router.RouterInit.html#window) Properties ---------- ### `Optional`basename[](#basename) basename?: string ### `Optional`dataStrategy[](#dataStrategy) dataStrategy?: [DataStrategyFunction](react_router.DataStrategyFunction.html) ### `Optional`future[](#future) future?: Partial ### history[](#history) history: History ### `Optional`hydrationData[](#hydrationData) hydrationData?: Partial\> ### `Optional`mapRouteProperties[](#mapRouteProperties) mapRouteProperties?: MapRoutePropertiesFunction ### `Optional`patchRoutesOnNavigation[](#patchRoutesOnNavigation) patchRoutesOnNavigation?: AgnosticPatchRoutesOnNavigationFunction ### routes[](#routes) routes: AgnosticRouteObject\[\] ### `Optional`window[](#window) window?: Window ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [basename](#basename) [dataStrategy](#dataStrategy) [future](#future) [history](#history) [hydrationData](#hydrationData) [mapRouteProperties](#mapRouteProperties) [patchRoutesOnNavigation](#patchRoutesOnNavigation) [routes](#routes) [window](#window) --- # RouterProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RouterProps](react_router.RouterProps.html) Interface RouterProps ===================== interface RouterProps {     [basename](react_router.RouterProps.html#basename) ?: string;     [children](react_router.RouterProps.html#children) ?: ReactNode;     [location](react_router.RouterProps.html#location) : string | Partial<[Location](react_router.Location.html) \>;     [navigationType](react_router.RouterProps.html#navigationType) ?: [NavigationType](../enums/react_router.NavigationType.html) ;     [navigator](react_router.RouterProps.html#navigator) : [Navigator](react_router.Navigator.html) ;     [static](react_router.RouterProps.html#static) ?: boolean; } ##### Index ### Properties [basename?](react_router.RouterProps.html#basename) [children?](react_router.RouterProps.html#children) [location](react_router.RouterProps.html#location) [navigationType?](react_router.RouterProps.html#navigationType) [navigator](react_router.RouterProps.html#navigator) [static?](react_router.RouterProps.html#static) Properties ---------- ### `Optional`basename[](#basename) basename?: string ### `Optional`children[](#children) children?: ReactNode ### location[](#location) location: string | Partial<[Location](react_router.Location.html) \> ### `Optional`navigationType[](#navigationType) navigationType?: [NavigationType](../enums/react_router.NavigationType.html) ### navigator[](#navigator) navigator: [Navigator](react_router.Navigator.html) ### `Optional`static[](#static) static?: boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [basename](#basename) [children](#children) [location](#location) [navigationType](#navigationType) [navigator](#navigator) [static](#static) --- # RouterProviderProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RouterProviderProps](react_router.RouterProviderProps.html) Interface RouterProviderProps ============================= interface RouterProviderProps {     [flushSync](react_router.RouterProviderProps.html#flushSync) ?: ((fn: (() => unknown)) => undefined);     [router](react_router.RouterProviderProps.html#router) : [DataRouter](react_router.DataRouter.html) ; } ##### Index ### Properties [flushSync?](react_router.RouterProviderProps.html#flushSync) [router](react_router.RouterProviderProps.html#router) Properties ---------- ### `Optional`flushSync[](#flushSync) flushSync?: ((fn: (() => unknown)) => undefined) ### router[](#router) router: [DataRouter](react_router.DataRouter.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [flushSync](#flushSync) [router](#router) --- # RouterState | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RouterState](react_router.RouterState.html) Interface RouterState ===================== State maintained internally by the router. During a navigation, all states reflect the the "old" location unless otherwise noted. interface RouterState {     [actionData](react_router.RouterState.html#actionData) : null | RouteData;     [blockers](react_router.RouterState.html#blockers) : Map;     [errors](react_router.RouterState.html#errors) : null | RouteData;     [fetchers](react_router.RouterState.html#fetchers) : Map\>;     [historyAction](react_router.RouterState.html#historyAction) : [NavigationType](../enums/react_router.NavigationType.html) ;     [initialized](react_router.RouterState.html#initialized) : boolean;     [loaderData](react_router.RouterState.html#loaderData) : RouteData;     [location](react_router.RouterState.html#location) : [Location](react_router.Location.html) ;     [matches](react_router.RouterState.html#matches) : AgnosticDataRouteMatch\[\];     [navigation](react_router.RouterState.html#navigation) : [Navigation](../types/react_router.Navigation.html) ;     [preventScrollReset](react_router.RouterState.html#preventScrollReset) : boolean;     [restoreScrollPosition](react_router.RouterState.html#restoreScrollPosition) : null | number | false;     [revalidation](react_router.RouterState.html#revalidation) : [RevalidationState](../types/react_router.RevalidationState.html) ; } ##### Index ### Properties [actionData](react_router.RouterState.html#actionData) [blockers](react_router.RouterState.html#blockers) [errors](react_router.RouterState.html#errors) [fetchers](react_router.RouterState.html#fetchers) [historyAction](react_router.RouterState.html#historyAction) [initialized](react_router.RouterState.html#initialized) [loaderData](react_router.RouterState.html#loaderData) [location](react_router.RouterState.html#location) [matches](react_router.RouterState.html#matches) [navigation](react_router.RouterState.html#navigation) [preventScrollReset](react_router.RouterState.html#preventScrollReset) [restoreScrollPosition](react_router.RouterState.html#restoreScrollPosition) [revalidation](react_router.RouterState.html#revalidation) Properties ---------- ### actionData[](#actionData) actionData: null | RouteData Data from the action for the current matches ### blockers[](#blockers) blockers: Map Map of current blockers ### errors[](#errors) errors: null | RouteData Errors caught from loaders for the current matches ### fetchers[](#fetchers) fetchers: Map\> Map of current fetchers ### historyAction[](#historyAction) historyAction: [NavigationType](../enums/react_router.NavigationType.html) The action of the most recent navigation ### initialized[](#initialized) initialized: boolean Tracks whether we've completed our initial data load ### loaderData[](#loaderData) loaderData: RouteData Data from the loaders for the current matches ### location[](#location) location: [Location](react_router.Location.html) The current location reflected by the router ### matches[](#matches) matches: AgnosticDataRouteMatch\[\] The current set of route matches ### navigation[](#navigation) navigation: [Navigation](../types/react_router.Navigation.html) Tracks the state of the current navigation ### preventScrollReset[](#preventScrollReset) preventScrollReset: boolean Indicate whether this navigation should skip resetting the scroll position if we are unable to restore the scroll position ### restoreScrollPosition[](#restoreScrollPosition) restoreScrollPosition: null | number | false Current scroll position we should start at for a new view * number -> scroll position to restore to * false -> do not restore scroll at all (used during submissions) * null -> don't have a saved position, scroll to hash or top of page ### revalidation[](#revalidation) revalidation: [RevalidationState](../types/react_router.RevalidationState.html) Tracks any in-progress revalidations ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [actionData](#actionData) [blockers](#blockers) [errors](#errors) [fetchers](#fetchers) [historyAction](#historyAction) [initialized](#initialized) [loaderData](#loaderData) [location](#location) [matches](#matches) [navigation](#navigation) [preventScrollReset](#preventScrollReset) [restoreScrollPosition](#restoreScrollPosition) [revalidation](#revalidation) --- # RouterSubscriber | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RouterSubscriber](react_router.RouterSubscriber.html) Interface RouterSubscriber ========================== Subscriber function signature for changes to router state * RouterSubscriber(state, opts): void[](#RouterSubscriber) * #### Parameters * state: [RouterState](react_router.RouterState.html) * opts: {     deletedFetchers: string\[\];     flushSync: boolean;     viewTransitionOpts?: ViewTransitionOpts; } * ##### deletedFetchers: string\[\] * ##### flushSync: boolean * ##### `Optional`viewTransitionOpts?: ViewTransitionOpts #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RoutesProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RoutesProps](react_router.RoutesProps.html) Interface RoutesProps ===================== interface RoutesProps {     [children](react_router.RoutesProps.html#children) ?: ReactNode;     [location](react_router.RoutesProps.html#location) ?: string | Partial<[Location](react_router.Location.html) \>; } ##### Index ### Properties [children?](react_router.RoutesProps.html#children) [location?](react_router.RoutesProps.html#location) Properties ---------- ### `Optional`children[](#children) children?: ReactNode Nested [Route](../functions/react_router.Route.html) elements ### `Optional`location[](#location) location?: string | Partial<[Location](react_router.Location.html) \> The location to match against. Defaults to the current location. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [children](#children) [location](#location) --- # RoutesTestStubProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RoutesTestStubProps](react_router.RoutesTestStubProps.html) Interface RoutesTestStubProps ============================= interface RoutesTestStubProps {     [future](react_router.RoutesTestStubProps.html#future) ?: Partial;     [hydrationData](react_router.RoutesTestStubProps.html#hydrationData) ?: Partial\>;     [initialEntries](react_router.RoutesTestStubProps.html#initialEntries) ?: [InitialEntry](../types/react_router.InitialEntry.html) \[\];     [initialIndex](react_router.RoutesTestStubProps.html#initialIndex) ?: number; } ##### Index ### Properties [future?](react_router.RoutesTestStubProps.html#future) [hydrationData?](react_router.RoutesTestStubProps.html#hydrationData) [initialEntries?](react_router.RoutesTestStubProps.html#initialEntries) [initialIndex?](react_router.RoutesTestStubProps.html#initialIndex) Properties ---------- ### `Optional`future[](#future) future?: Partial Future flags mimicking the settings in react-router.config.ts ### `Optional`hydrationData[](#hydrationData) hydrationData?: Partial\> Used to set the route's initial loader and action data. e.g. hydrationData={{ loaderData: { "/contact": { locale: "en-US" } }, actionData: { "/login": { errors: { email: "invalid email" } }} }} ### `Optional`initialEntries[](#initialEntries) initialEntries?: [InitialEntry](../types/react_router.InitialEntry.html) \[\] The initial entries in the history stack. This allows you to start a test with multiple locations already in the history stack (for testing a back navigation, etc.) The test will default to the last entry in initialEntries if no initialIndex is provided. e.g. initialEntries={\["/home", "/about", "/contact"\]} ### `Optional`initialIndex[](#initialIndex) initialIndex?: number The initial index in the history stack to render. This allows you to start a test at a specific entry. It defaults to the last entry in initialEntries. e.g. initialEntries: \["/", "/events/123"\] initialIndex: 1 // start at "/events/123" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [future](#future) [hydrationData](#hydrationData) [initialEntries](#initialEntries) [initialIndex](#initialIndex) --- # ServerEntryModule | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ServerEntryModule](react_router.ServerEntryModule.html) Interface ServerEntryModule =========================== A module that serves as the entry point for a Remix app during server rendering. interface ServerEntryModule {     [default](react_router.ServerEntryModule.html#default) : [HandleDocumentRequestFunction](react_router.HandleDocumentRequestFunction.html) ;     [handleDataRequest](react_router.ServerEntryModule.html#handleDataRequest) ?: [HandleDataRequestFunction](react_router.HandleDataRequestFunction.html) ;     [handleError](react_router.ServerEntryModule.html#handleError) ?: [HandleErrorFunction](react_router.HandleErrorFunction.html) ;     [streamTimeout](react_router.ServerEntryModule.html#streamTimeout) ?: number; } ##### Index ### Properties [default](react_router.ServerEntryModule.html#default) [handleDataRequest?](react_router.ServerEntryModule.html#handleDataRequest) [handleError?](react_router.ServerEntryModule.html#handleError) [streamTimeout?](react_router.ServerEntryModule.html#streamTimeout) Properties ---------- ### default[](#default) default: [HandleDocumentRequestFunction](react_router.HandleDocumentRequestFunction.html) ### `Optional`handleDataRequest[](#handleDataRequest) handleDataRequest?: [HandleDataRequestFunction](react_router.HandleDataRequestFunction.html) ### `Optional`handleError[](#handleError) handleError?: [HandleErrorFunction](react_router.HandleErrorFunction.html) ### `Optional`streamTimeout[](#streamTimeout) streamTimeout?: number ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [default](#default) [handleDataRequest](#handleDataRequest) [handleError](#handleError) [streamTimeout](#streamTimeout) --- # ServerBuild | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ServerBuild](react_router.ServerBuild.html) Interface ServerBuild ===================== The output of the compiler for the server build. interface ServerBuild {     [assets](react_router.ServerBuild.html#assets) : [UNSAFE\_AssetsManifest](react_router.UNSAFE_AssetsManifest.html) ;     [assetsBuildDirectory](react_router.ServerBuild.html#assetsBuildDirectory) : string;     [basename](react_router.ServerBuild.html#basename) ?: string;     [entry](react_router.ServerBuild.html#entry) : {         module: [ServerEntryModule](react_router.ServerEntryModule.html) ;     };     [future](react_router.ServerBuild.html#future) : FutureConfig;     [isSpaMode](react_router.ServerBuild.html#isSpaMode) : boolean;     [publicPath](react_router.ServerBuild.html#publicPath) : string;     [routes](react_router.ServerBuild.html#routes) : ServerRouteManifest; } ##### Index ### Properties [assets](react_router.ServerBuild.html#assets) [assetsBuildDirectory](react_router.ServerBuild.html#assetsBuildDirectory) [basename?](react_router.ServerBuild.html#basename) [entry](react_router.ServerBuild.html#entry) [future](react_router.ServerBuild.html#future) [isSpaMode](react_router.ServerBuild.html#isSpaMode) [publicPath](react_router.ServerBuild.html#publicPath) [routes](react_router.ServerBuild.html#routes) Properties ---------- ### assets[](#assets) assets: [UNSAFE\_AssetsManifest](react_router.UNSAFE_AssetsManifest.html) ### assetsBuildDirectory[](#assetsBuildDirectory) assetsBuildDirectory: string ### `Optional`basename[](#basename) basename?: string ### entry[](#entry) entry: {     module: [ServerEntryModule](react_router.ServerEntryModule.html) ; } ### future[](#future) future: FutureConfig ### isSpaMode[](#isSpaMode) isSpaMode: boolean ### publicPath[](#publicPath) publicPath: string ### routes[](#routes) routes: ServerRouteManifest ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [assets](#assets) [assetsBuildDirectory](#assetsBuildDirectory) [basename](#basename) [entry](#entry) [future](#future) [isSpaMode](#isSpaMode) [publicPath](#publicPath) [routes](#routes) --- # ServerRouterProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ServerRouterProps](react_router.ServerRouterProps.html) Interface ServerRouterProps =========================== interface ServerRouterProps {     [abortDelay](react_router.ServerRouterProps.html#abortDelay) ?: number;     [context](react_router.ServerRouterProps.html#context) : [EntryContext](react_router.EntryContext.html) ;     [nonce](react_router.ServerRouterProps.html#nonce) ?: string;     [url](react_router.ServerRouterProps.html#url) : string | URL; } ##### Index ### Properties [abortDelay?](react_router.ServerRouterProps.html#abortDelay) [context](react_router.ServerRouterProps.html#context) [nonce?](react_router.ServerRouterProps.html#nonce) [url](react_router.ServerRouterProps.html#url) Properties ---------- ### `Optional`abortDelay[](#abortDelay) abortDelay?: number ### context[](#context) context: [EntryContext](react_router.EntryContext.html) ### `Optional`nonce[](#nonce) nonce?: string ### url[](#url) url: string | URL ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [abortDelay](#abortDelay) [context](#context) [nonce](#nonce) [url](#url) --- # SessionIdStorageStrategy | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [SessionIdStorageStrategy](react_router.SessionIdStorageStrategy.html) Interface SessionIdStorageStrategy =================================================== SessionIdStorageStrategy is designed to allow anyone to easily build their own SessionStorage using `createSessionStorage(strategy)`. This strategy describes a common scenario where the session id is stored in a cookie but the actual session data is stored elsewhere, usually in a database or on disk. A set of create, read, update, and delete operations are provided for managing the session data. interface SessionIdStorageStrategy<[Data](react_router.SessionIdStorageStrategy.html#Data) , [FlashData](react_router.SessionIdStorageStrategy.html#FlashData) \> {     [cookie](react_router.SessionIdStorageStrategy.html#cookie) ?: [Cookie](react_router.Cookie.html) | [CookieParseOptions](react_router.CookieParseOptions.html) & [CookieSerializeOptions](react_router.CookieSerializeOptions.html) & [CookieSignatureOptions](react_router.CookieSignatureOptions.html) & {         name?: string;     };     [createData](react_router.SessionIdStorageStrategy.html#createData) : ((data: Partial<[Data](react_router.SessionIdStorageStrategy.html#Data) & {         \[Key in string | number | symbol as \`\_\_flash\_${[Key](react_router.Session.html#get.get-1.Key-1)\ & string}\_\_\`\]: [FlashData](react_router.SessionIdStorageStrategy.html#FlashData) \[[Key](react_router.Session.html#get.get-1.Key-1)\ \]     }\>, expires?: Date) => Promise);     [deleteData](react_router.SessionIdStorageStrategy.html#deleteData) : ((id: string) => Promise);     [readData](react_router.SessionIdStorageStrategy.html#readData) : ((id: string) => Promise\>);     [updateData](react_router.SessionIdStorageStrategy.html#updateData) : ((id: string, data: Partial<[Data](react_router.SessionIdStorageStrategy.html#Data) & {         \[Key in string | number | symbol as \`\_\_flash\_${[Key](react_router.Session.html#get.get-1.Key-1)\ & string}\_\_\`\]: [FlashData](react_router.SessionIdStorageStrategy.html#FlashData) \[[Key](react_router.Session.html#get.get-1.Key-1)\ \]     }\>, expires?: Date) => Promise); } #### Type Parameters * Data = [SessionData](react_router.SessionData.html) * FlashData = [Data](react_router.SessionIdStorageStrategy.html#Data) ##### Index ### Properties [cookie?](react_router.SessionIdStorageStrategy.html#cookie) [createData](react_router.SessionIdStorageStrategy.html#createData) [deleteData](react_router.SessionIdStorageStrategy.html#deleteData) [readData](react_router.SessionIdStorageStrategy.html#readData) [updateData](react_router.SessionIdStorageStrategy.html#updateData) Properties ---------- ### `Optional`cookie[](#cookie) cookie?: [Cookie](react_router.Cookie.html) | [CookieParseOptions](react_router.CookieParseOptions.html) & [CookieSerializeOptions](react_router.CookieSerializeOptions.html) & [CookieSignatureOptions](react_router.CookieSignatureOptions.html) & {     name?: string; } The Cookie used to store the session id, or options used to automatically create one. ### createData[](#createData) createData: ((data: Partial<[Data](react_router.SessionIdStorageStrategy.html#Data) & {     \[Key in string | number | symbol as \`\_\_flash\_${[Key](react_router.Session.html#get.get-1.Key-1)\ & string}\_\_\`\]: [FlashData](react_router.SessionIdStorageStrategy.html#FlashData) \[[Key](react_router.Session.html#get.get-1.Key-1)\ \] }\>, expires?: Date) => Promise) Creates a new record with the given data and returns the session id. ### deleteData[](#deleteData) deleteData: ((id: string) => Promise) Deletes data for a given session id from the data store. ### readData[](#readData) readData: ((id: string) => Promise\>) Returns data for a given session id, or `null` if there isn't any. ### updateData[](#updateData) updateData: ((id: string, data: Partial<[Data](react_router.SessionIdStorageStrategy.html#Data) & {     \[Key in string | number | symbol as \`\_\_flash\_${[Key](react_router.Session.html#get.get-1.Key-1)\ & string}\_\_\`\]: [FlashData](react_router.SessionIdStorageStrategy.html#FlashData) \[[Key](react_router.Session.html#get.get-1.Key-1)\ \] }\>, expires?: Date) => Promise) Updates data for the given session id. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [cookie](#cookie) [createData](#createData) [deleteData](#deleteData) [readData](#readData) [updateData](#updateData) --- # ShouldRevalidateFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ShouldRevalidateFunction](react_router.ShouldRevalidateFunction.html) Interface ShouldRevalidateFunction ================================== Route shouldRevalidate function signature. This runs after any submission (navigation or fetcher), so we flatten the navigation/fetcher submission onto the arguments. It shouldn't matter whether it came from a navigation or a fetcher, what really matters is the URLs and the formData since loaders have to re-run based on the data models that were potentially mutated. * ShouldRevalidateFunction(args): boolean[](#ShouldRevalidateFunction) * #### Parameters * args: [ShouldRevalidateFunctionArgs](react_router.ShouldRevalidateFunctionArgs.html) #### Returns boolean ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # StaticHandlerContext | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [StaticHandlerContext](react_router.StaticHandlerContext.html) Interface StaticHandlerContext ============================== State returned from a server-side query() call interface StaticHandlerContext {     [\_deepestRenderedBoundaryId](react_router.StaticHandlerContext.html#_deepestRenderedBoundaryId) ?: null | string;     [actionData](react_router.StaticHandlerContext.html#actionData) : null | RouteData;     [actionHeaders](react_router.StaticHandlerContext.html#actionHeaders) : Record;     [basename](react_router.StaticHandlerContext.html#basename) : undefined | string;     [errors](react_router.StaticHandlerContext.html#errors) : null | RouteData;     [loaderData](react_router.StaticHandlerContext.html#loaderData) : RouteData;     [loaderHeaders](react_router.StaticHandlerContext.html#loaderHeaders) : Record;     [location](react_router.StaticHandlerContext.html#location) : [Location](react_router.Location.html) ;     [matches](react_router.StaticHandlerContext.html#matches) : AgnosticDataRouteMatch\[\];     [statusCode](react_router.StaticHandlerContext.html#statusCode) : number; } ##### Index ### Properties [\_deepestRenderedBoundaryId?](react_router.StaticHandlerContext.html#_deepestRenderedBoundaryId) [actionData](react_router.StaticHandlerContext.html#actionData) [actionHeaders](react_router.StaticHandlerContext.html#actionHeaders) [basename](react_router.StaticHandlerContext.html#basename) [errors](react_router.StaticHandlerContext.html#errors) [loaderData](react_router.StaticHandlerContext.html#loaderData) [loaderHeaders](react_router.StaticHandlerContext.html#loaderHeaders) [location](react_router.StaticHandlerContext.html#location) [matches](react_router.StaticHandlerContext.html#matches) [statusCode](react_router.StaticHandlerContext.html#statusCode) Properties ---------- ### `Optional`\_deepestRenderedBoundaryId[](#_deepestRenderedBoundaryId) \_deepestRenderedBoundaryId?: null | string ### actionData[](#actionData) actionData: null | RouteData ### actionHeaders[](#actionHeaders) actionHeaders: Record ### basename[](#basename) basename: undefined | string ### errors[](#errors) errors: null | RouteData ### loaderData[](#loaderData) loaderData: RouteData ### loaderHeaders[](#loaderHeaders) loaderHeaders: Record ### location[](#location) location: [Location](react_router.Location.html) ### matches[](#matches) matches: AgnosticDataRouteMatch\[\] ### statusCode[](#statusCode) statusCode: number ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [\_deepestRenderedBoundaryId](#_deepestRenderedBoundaryId) [actionData](#actionData) [actionHeaders](#actionHeaders) [basename](#basename) [errors](#errors) [loaderData](#loaderData) [loaderHeaders](#loaderHeaders) [location](#location) [matches](#matches) [statusCode](#statusCode) --- # ShouldRevalidateFunctionArgs | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ShouldRevalidateFunctionArgs](react_router.ShouldRevalidateFunctionArgs.html) Interface ShouldRevalidateFunctionArgs ====================================== Arguments passed to shouldRevalidate function interface ShouldRevalidateFunctionArgs {     [actionResult](react_router.ShouldRevalidateFunctionArgs.html#actionResult) ?: any;     [actionStatus](react_router.ShouldRevalidateFunctionArgs.html#actionStatus) ?: number;     [currentParams](react_router.ShouldRevalidateFunctionArgs.html#currentParams) : [Params](../types/react_router.Params.html) ;     [currentUrl](react_router.ShouldRevalidateFunctionArgs.html#currentUrl) : URL;     [defaultShouldRevalidate](react_router.ShouldRevalidateFunctionArgs.html#defaultShouldRevalidate) : boolean;     [formAction](react_router.ShouldRevalidateFunctionArgs.html#formAction) ?: string;     [formData](react_router.ShouldRevalidateFunctionArgs.html#formData) ?: FormData;     [formEncType](react_router.ShouldRevalidateFunctionArgs.html#formEncType) ?: [FormEncType](../types/react_router.FormEncType.html) ;     [formMethod](react_router.ShouldRevalidateFunctionArgs.html#formMethod) ?:         | "GET"         | "POST"         | "PUT"         | "PATCH"         | "DELETE";     [json](react_router.ShouldRevalidateFunctionArgs.html#json) ?: JsonValue;     [nextParams](react_router.ShouldRevalidateFunctionArgs.html#nextParams) : [Params](../types/react_router.Params.html) ;     [nextUrl](react_router.ShouldRevalidateFunctionArgs.html#nextUrl) : URL;     [text](react_router.ShouldRevalidateFunctionArgs.html#text) ?: string; } ##### Index ### Properties [actionResult?](react_router.ShouldRevalidateFunctionArgs.html#actionResult) [actionStatus?](react_router.ShouldRevalidateFunctionArgs.html#actionStatus) [currentParams](react_router.ShouldRevalidateFunctionArgs.html#currentParams) [currentUrl](react_router.ShouldRevalidateFunctionArgs.html#currentUrl) [defaultShouldRevalidate](react_router.ShouldRevalidateFunctionArgs.html#defaultShouldRevalidate) [formAction?](react_router.ShouldRevalidateFunctionArgs.html#formAction) [formData?](react_router.ShouldRevalidateFunctionArgs.html#formData) [formEncType?](react_router.ShouldRevalidateFunctionArgs.html#formEncType) [formMethod?](react_router.ShouldRevalidateFunctionArgs.html#formMethod) [json?](react_router.ShouldRevalidateFunctionArgs.html#json) [nextParams](react_router.ShouldRevalidateFunctionArgs.html#nextParams) [nextUrl](react_router.ShouldRevalidateFunctionArgs.html#nextUrl) [text?](react_router.ShouldRevalidateFunctionArgs.html#text) Properties ---------- ### `Optional`actionResult[](#actionResult) actionResult?: any ### `Optional`actionStatus[](#actionStatus) actionStatus?: number ### currentParams[](#currentParams) currentParams: [Params](../types/react_router.Params.html) ### currentUrl[](#currentUrl) currentUrl: URL ### defaultShouldRevalidate[](#defaultShouldRevalidate) defaultShouldRevalidate: boolean ### `Optional`formAction[](#formAction) formAction?: string ### `Optional`formData[](#formData) formData?: FormData ### `Optional`formEncType[](#formEncType) formEncType?: [FormEncType](../types/react_router.FormEncType.html) ### `Optional`formMethod[](#formMethod) formMethod?:     | "GET"     | "POST"     | "PUT"     | "PATCH"     | "DELETE" ### `Optional`json[](#json) json?: JsonValue ### nextParams[](#nextParams) nextParams: [Params](../types/react_router.Params.html) ### nextUrl[](#nextUrl) nextUrl: URL ### `Optional`text[](#text) text?: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [actionResult](#actionResult) [actionStatus](#actionStatus) [currentParams](#currentParams) [currentUrl](#currentUrl) [defaultShouldRevalidate](#defaultShouldRevalidate) [formAction](#formAction) [formData](#formData) [formEncType](#formEncType) [formMethod](#formMethod) [json](#json) [nextParams](#nextParams) [nextUrl](#nextUrl) [text](#text) --- # Session | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [Session](react_router.Session.html) Interface Session ================================== Session persists data across HTTP requests. #### See[](#See) [https://remix.run/utils/sessions#session-api](https://remix.run/utils/sessions#session-api) interface Session<[Data](react_router.Session.html#Data) , [FlashData](react_router.Session.html#FlashData) \> {     [data](react_router.Session.html#data-1) : Partial<[Data](react_router.Session.html#Data) & {         \[Key in string | number | symbol as \`\_\_flash\_${[Key](react_router.Session.html#get.get-1.Key-1)\ & string}\_\_\`\]: [FlashData](react_router.Session.html#FlashData) \[[Key](react_router.Session.html#get.get-1.Key-1)\ \]     }\>;     [id](react_router.Session.html#id) : string;     [flash](react_router.Session.html#flash.flash-1) <[Key](react_router.Session.html#flash.flash-1.Key) \>(name: [Key](react_router.Session.html#flash.flash-1.Key) , value: [FlashData](react_router.Session.html#FlashData) \[[Key](react_router.Session.html#flash.flash-1.Key)\ \]): void;     [get](react_router.Session.html#get.get-1) <[Key](react_router.Session.html#get.get-1.Key-1) \>(name: [Key](react_router.Session.html#get.get-1.Key-1) ): undefined | ([Key](react_router.Session.html#get.get-1.Key-1) extends keyof [Data](react_router.Session.html#Data)         ? [Data](react_router.Session.html#Data) \[[Key](react_router.Session.html#get.get-1.Key-1)\ <[Key](react_router.Session.html#get.get-1.Key-1)\ \>\]         : undefined) | ([Key](react_router.Session.html#get.get-1.Key-1) extends keyof [FlashData](react_router.Session.html#FlashData)         ? [FlashData](react_router.Session.html#FlashData) \[[Key](react_router.Session.html#get.get-1.Key-1)\ <[Key](react_router.Session.html#get.get-1.Key-1)\ \>\]         : undefined);     [has](react_router.Session.html#has.has-1) (name: (keyof [FlashData](react_router.Session.html#FlashData) | keyof [Data](react_router.Session.html#Data) ) & string): boolean;     [set](react_router.Session.html#set.set-1) <[Key](react_router.Session.html#set.set-1.Key-2) \>(name: [Key](react_router.Session.html#set.set-1.Key-2) , value: [Data](react_router.Session.html#Data) \[[Key](react_router.Session.html#set.set-1.Key-2)\ \]): void;     [unset](react_router.Session.html#unset.unset-1) (name: keyof [Data](react_router.Session.html#Data) & string): void; } #### Type Parameters * Data = [SessionData](react_router.SessionData.html) * FlashData = [Data](react_router.Session.html#Data) ##### Index ### Properties [data](react_router.Session.html#data-1) [id](react_router.Session.html#id) ### Methods [flash](react_router.Session.html#flash) [get](react_router.Session.html#get) [has](react_router.Session.html#has) [set](react_router.Session.html#set) [unset](react_router.Session.html#unset) Properties ---------- ### `Readonly`data[](#data-1) data: Partial<[Data](react_router.Session.html#Data) & {     \[Key in string | number | symbol as \`\_\_flash\_${[Key](react_router.Session.html#get.get-1.Key-1)\ & string}\_\_\`\]: [FlashData](react_router.Session.html#FlashData) \[[Key](react_router.Session.html#get.get-1.Key-1)\ \] }\> The raw data contained in this session. This is useful mostly for SessionStorage internally to access the raw session data to persist. ### `Readonly`id[](#id) id: string A unique identifier for this session. Note: This will be the empty string for newly created sessions and sessions that are not backed by a database (i.e. cookie-based sessions). Methods ------- ### flash[](#flash) * flash<[Key](react_router.Session.html#flash.flash-1.Key) \>(name, value): void[](#flash.flash-1) * Sets a value in the session that is only valid until the next `get()`. This can be useful for temporary values, like error messages. #### Type Parameters * Key extends string #### Parameters * name: [Key](react_router.Session.html#flash.flash-1.Key) * value: [FlashData](react_router.Session.html#FlashData) \[[Key](react_router.Session.html#flash.flash-1.Key)\ \] #### Returns void ### get[](#get) * get<[Key](react_router.Session.html#get.get-1.Key-1) \>(name): undefined | ([Key](react_router.Session.html#get.get-1.Key-1) extends keyof [Data](react_router.Session.html#Data)     ? [Data](react_router.Session.html#Data) \[[Key](react_router.Session.html#get.get-1.Key-1)\ <[Key](react_router.Session.html#get.get-1.Key-1)\ \>\]     : undefined) | ([Key](react_router.Session.html#get.get-1.Key-1) extends keyof [FlashData](react_router.Session.html#FlashData)     ? [FlashData](react_router.Session.html#FlashData) \[[Key](react_router.Session.html#get.get-1.Key-1)\ <[Key](react_router.Session.html#get.get-1.Key-1)\ \>\]     : undefined)[](#get.get-1) * Returns the value for the given `name` in this session. #### Type Parameters * Key extends string #### Parameters * name: [Key](react_router.Session.html#get.get-1.Key-1) #### Returns undefined | ([Key](react_router.Session.html#get.get-1.Key-1) extends keyof [Data](react_router.Session.html#Data)     ? [Data](react_router.Session.html#Data) \[[Key](react_router.Session.html#get.get-1.Key-1)\ <[Key](react_router.Session.html#get.get-1.Key-1)\ \>\]     : undefined) | ([Key](react_router.Session.html#get.get-1.Key-1) extends keyof [FlashData](react_router.Session.html#FlashData)     ? [FlashData](react_router.Session.html#FlashData) \[[Key](react_router.Session.html#get.get-1.Key-1)\ <[Key](react_router.Session.html#get.get-1.Key-1)\ \>\]     : undefined) ### has[](#has) * has(name): boolean[](#has.has-1) * Returns `true` if the session has a value for the given `name`, `false` otherwise. #### Parameters * name: (keyof [FlashData](react_router.Session.html#FlashData) | keyof [Data](react_router.Session.html#Data) ) & string #### Returns boolean ### set[](#set) * set<[Key](react_router.Session.html#set.set-1.Key-2) \>(name, value): void[](#set.set-1) * Sets a value in the session for the given `name`. #### Type Parameters * Key extends string #### Parameters * name: [Key](react_router.Session.html#set.set-1.Key-2) * value: [Data](react_router.Session.html#Data) \[[Key](react_router.Session.html#set.set-1.Key-2)\ \] #### Returns void ### unset[](#unset) * unset(name): void[](#unset.unset-1) * Removes a value from the session. #### Parameters * name: keyof [Data](react_router.Session.html#Data) & string #### Returns void ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [data](#data-1) [id](#id) Methods [flash](#flash) [get](#get) [has](#has) [set](#set) [unset](#unset) --- # StaticRouterProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [StaticRouterProps](react_router.StaticRouterProps.html) Interface StaticRouterProps =========================== interface StaticRouterProps {     [basename](react_router.StaticRouterProps.html#basename) ?: string;     [children](react_router.StaticRouterProps.html#children) ?: ReactNode;     [location](react_router.StaticRouterProps.html#location) : string | Partial<[Location](react_router.Location.html) \>; } ##### Index ### Properties [basename?](react_router.StaticRouterProps.html#basename) [children?](react_router.StaticRouterProps.html#children) [location](react_router.StaticRouterProps.html#location) Properties ---------- ### `Optional`basename[](#basename) basename?: string ### `Optional`children[](#children) children?: ReactNode ### location[](#location) location: string | Partial<[Location](react_router.Location.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [basename](#basename) [children](#children) [location](#location) --- # SessionData | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [SessionData](react_router.SessionData.html) Interface SessionData ===================== An object of name/value pairs to be used in the session. #### Indexable * \[name: string\]: any ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # SessionStorage | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [SessionStorage](react_router.SessionStorage.html) Interface SessionStorage ========================================= SessionStorage stores session data between HTTP requests and knows how to parse and create cookies. A SessionStorage creates Session objects using a `Cookie` header as input. Then, later it generates the `Set-Cookie` header to be used in the response. interface SessionStorage<[Data](react_router.SessionStorage.html#Data) , [FlashData](react_router.SessionStorage.html#FlashData) \> {     [commitSession](react_router.SessionStorage.html#commitSession) : ((session: [Session](react_router.Session.html) <[Data](react_router.SessionStorage.html#Data) , [FlashData](react_router.SessionStorage.html#FlashData) \>, options?: [CookieSerializeOptions](react_router.CookieSerializeOptions.html) ) => Promise);     [destroySession](react_router.SessionStorage.html#destroySession) : ((session: [Session](react_router.Session.html) <[Data](react_router.SessionStorage.html#Data) , [FlashData](react_router.SessionStorage.html#FlashData) \>, options?: [CookieSerializeOptions](react_router.CookieSerializeOptions.html) ) => Promise);     [getSession](react_router.SessionStorage.html#getSession) : ((cookieHeader?: null | string, options?: [CookieParseOptions](react_router.CookieParseOptions.html) ) => Promise<[Session](react_router.Session.html) <[Data](react_router.SessionStorage.html#Data) , [FlashData](react_router.SessionStorage.html#FlashData) \>\>); } #### Type Parameters * Data = [SessionData](react_router.SessionData.html) * FlashData = [Data](react_router.SessionStorage.html#Data) ##### Index ### Properties [commitSession](react_router.SessionStorage.html#commitSession) [destroySession](react_router.SessionStorage.html#destroySession) [getSession](react_router.SessionStorage.html#getSession) Properties ---------- ### commitSession[](#commitSession) commitSession: ((session: [Session](react_router.Session.html) <[Data](react_router.SessionStorage.html#Data) , [FlashData](react_router.SessionStorage.html#FlashData) \>, options?: [CookieSerializeOptions](react_router.CookieSerializeOptions.html) ) => Promise) Stores all data in the Session and returns the Set-Cookie header to be used in the HTTP response. ### destroySession[](#destroySession) destroySession: ((session: [Session](react_router.Session.html) <[Data](react_router.SessionStorage.html#Data) , [FlashData](react_router.SessionStorage.html#FlashData) \>, options?: [CookieSerializeOptions](react_router.CookieSerializeOptions.html) ) => Promise) Deletes all data associated with the Session and returns the Set-Cookie header to be used in the HTTP response. ### getSession[](#getSession) getSession: ((cookieHeader?: null | string, options?: [CookieParseOptions](react_router.CookieParseOptions.html) ) => Promise<[Session](react_router.Session.html) <[Data](react_router.SessionStorage.html#Data) , [FlashData](react_router.SessionStorage.html#FlashData) \>\>) Parses a Cookie header from a HTTP request and returns the associated Session. If there is no session associated with the cookie, this will return a new Session with no data. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [commitSession](#commitSession) [destroySession](#destroySession) [getSession](#getSession) --- # StaticHandler | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [StaticHandler](react_router.StaticHandler.html) Interface StaticHandler ======================= A StaticHandler instance manages a singular SSR navigation/fetch event interface StaticHandler {     [dataRoutes](react_router.StaticHandler.html#dataRoutes) : AgnosticDataRouteObject\[\];     [query](react_router.StaticHandler.html#query.query-1) (request: Request, opts?: {         dataStrategy?: [DataStrategyFunction](react_router.DataStrategyFunction.html) ;         requestContext?: unknown;         skipLoaderErrorBubbling?: boolean;     }): Promise;     [queryRoute](react_router.StaticHandler.html#queryRoute.queryRoute-1) (request: Request, opts?: {         dataStrategy?: [DataStrategyFunction](react_router.DataStrategyFunction.html) ;         requestContext?: unknown;         routeId?: string;     }): Promise; } ##### Index ### Properties [dataRoutes](react_router.StaticHandler.html#dataRoutes) ### Methods [query](react_router.StaticHandler.html#query) [queryRoute](react_router.StaticHandler.html#queryRoute) Properties ---------- ### dataRoutes[](#dataRoutes) dataRoutes: AgnosticDataRouteObject\[\] Methods ------- ### query[](#query) * query(request, opts?): Promise[](#query.query-1) * #### Parameters * request: Request * `Optional`opts: {     dataStrategy?: [DataStrategyFunction](react_router.DataStrategyFunction.html) ;     requestContext?: unknown;     skipLoaderErrorBubbling?: boolean; } * ##### `Optional`dataStrategy?: [DataStrategyFunction](react_router.DataStrategyFunction.html) * ##### `Optional`requestContext?: unknown * ##### `Optional`skipLoaderErrorBubbling?: boolean #### Returns Promise ### queryRoute[](#queryRoute) * queryRoute(request, opts?): Promise[](#queryRoute.queryRoute-1) * #### Parameters * request: Request * `Optional`opts: {     dataStrategy?: [DataStrategyFunction](react_router.DataStrategyFunction.html) ;     requestContext?: unknown;     routeId?: string; } * ##### `Optional`dataStrategy?: [DataStrategyFunction](react_router.DataStrategyFunction.html) * ##### `Optional`requestContext?: unknown * ##### `Optional`routeId?: string #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [dataRoutes](#dataRoutes) Methods [query](#query) [queryRoute](#queryRoute) --- # StaticRouterProviderProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [StaticRouterProviderProps](react_router.StaticRouterProviderProps.html) Interface StaticRouterProviderProps =================================== interface StaticRouterProviderProps {     [context](react_router.StaticRouterProviderProps.html#context) : [StaticHandlerContext](react_router.StaticHandlerContext.html) ;     [hydrate](react_router.StaticRouterProviderProps.html#hydrate) ?: boolean;     [nonce](react_router.StaticRouterProviderProps.html#nonce) ?: string;     [router](react_router.StaticRouterProviderProps.html#router) : [DataRouter](react_router.DataRouter.html) ; } ##### Index ### Properties [context](react_router.StaticRouterProviderProps.html#context) [hydrate?](react_router.StaticRouterProviderProps.html#hydrate) [nonce?](react_router.StaticRouterProviderProps.html#nonce) [router](react_router.StaticRouterProviderProps.html#router) Properties ---------- ### context[](#context) context: [StaticHandlerContext](react_router.StaticHandlerContext.html) ### `Optional`hydrate[](#hydrate) hydrate?: boolean ### `Optional`nonce[](#nonce) nonce?: string ### router[](#router) router: [DataRouter](react_router.DataRouter.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [context](#context) [hydrate](#hydrate) [nonce](#nonce) [router](#router) --- # SubmitFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [SubmitFunction](react_router.SubmitFunction.html) Interface SubmitFunction ======================== Submits a HTML `` to the server without reloading the page. * SubmitFunction(target, options?): Promise[](#SubmitFunction) * #### Parameters * target: [SubmitTarget](../types/react_router.SubmitTarget.html) Can be multiple types of elements and objects **`HTMLFormElement`** { submit(event.currentTarget); }}/> **`FormData`** const formData = new FormData();formData.append("myKey", "myValue");submit(formData, { method: "post" }); **Plain object that will be serialized as `FormData`** submit({ myKey: "myValue" }, { method: "post" }); **Plain object that will be serialized as JSON** submit( { myKey: "myValue" }, { method: "post", encType: "application/json" }); * `Optional`options: [SubmitOptions](react_router.SubmitOptions.html) Options that override the ``'s own attributes. Required when submitting arbitrary data without a backing ``. #### Returns Promise ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # SubmitOptions | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [SubmitOptions](react_router.SubmitOptions.html) Interface SubmitOptions ======================= Submit options available to navigations interface SubmitOptions {     [action](react_router.SubmitOptions.html#action) ?: string;     [encType](react_router.SubmitOptions.html#encType) ?: [FormEncType](../types/react_router.FormEncType.html) ;     [fetcherKey](react_router.SubmitOptions.html#fetcherKey) ?: string;     [flushSync](react_router.SubmitOptions.html#flushSync) ?: boolean;     [method](react_router.SubmitOptions.html#method) ?: [HTMLFormMethod](../types/react_router.HTMLFormMethod.html) ;     [navigate](react_router.SubmitOptions.html#navigate) ?: boolean;     [preventScrollReset](react_router.SubmitOptions.html#preventScrollReset) ?: boolean;     [relative](react_router.SubmitOptions.html#relative) ?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) ;     [replace](react_router.SubmitOptions.html#replace) ?: boolean;     [state](react_router.SubmitOptions.html#state) ?: any;     [viewTransition](react_router.SubmitOptions.html#viewTransition) ?: boolean; } #### Hierarchy ([view full](../hierarchy.html#react-router.SubmitOptions) ) * [FetcherSubmitOptions](react_router.FetcherSubmitOptions.html) * SubmitOptions ##### Index ### Properties [action?](react_router.SubmitOptions.html#action) [encType?](react_router.SubmitOptions.html#encType) [fetcherKey?](react_router.SubmitOptions.html#fetcherKey) [flushSync?](react_router.SubmitOptions.html#flushSync) [method?](react_router.SubmitOptions.html#method) [navigate?](react_router.SubmitOptions.html#navigate) [preventScrollReset?](react_router.SubmitOptions.html#preventScrollReset) [relative?](react_router.SubmitOptions.html#relative) [replace?](react_router.SubmitOptions.html#replace) [state?](react_router.SubmitOptions.html#state) [viewTransition?](react_router.SubmitOptions.html#viewTransition) Properties ---------- ### `Optional`action[](#action) action?: string The action URL path used to submit the form. Overrides ``. Defaults to the path of the current route. ### `Optional`encType[](#encType) encType?: [FormEncType](../types/react_router.FormEncType.html) The encoding used to submit the form. Overrides ``. Defaults to "application/x-www-form-urlencoded". ### `Optional`fetcherKey[](#fetcherKey) fetcherKey?: string Indicate a specific fetcherKey to use when using navigate=false ### `Optional`flushSync[](#flushSync) flushSync?: boolean Enable flushSync for this submission's state updates ### `Optional`method[](#method) method?: [HTMLFormMethod](../types/react_router.HTMLFormMethod.html) The HTTP method used to submit the form. Overrides ``. Defaults to "GET". ### `Optional`navigate[](#navigate) navigate?: boolean navigate=false will use a fetcher instead of a navigation ### `Optional`preventScrollReset[](#preventScrollReset) preventScrollReset?: boolean In browser-based environments, prevent resetting scroll after this navigation when using the component ### `Optional`relative[](#relative) relative?: [RelativeRoutingType](../types/react_router.RelativeRoutingType.html) Determines whether the form action is relative to the route hierarchy or the pathname. Use this if you want to opt out of navigating the route hierarchy and want to instead route based on /-delimited URL segments ### `Optional`replace[](#replace) replace?: boolean Set `true` to replace the current entry in the browser's history stack instead of creating a new one (i.e. stay on "the same page"). Defaults to `false`. ### `Optional`state[](#state) state?: any State object to add to the history stack entry for this navigation ### `Optional`viewTransition[](#viewTransition) viewTransition?: boolean Enable view transitions on this submission navigation ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [action](#action) [encType](#encType) [fetcherKey](#fetcherKey) [flushSync](#flushSync) [method](#method) [navigate](#navigate) [preventScrollReset](#preventScrollReset) [relative](#relative) [replace](#replace) [state](#state) [viewTransition](#viewTransition) --- # UIMatch | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [UIMatch](react_router.UIMatch.html) Interface UIMatch =============================== interface UIMatch<[Data](react_router.UIMatch.html#Data) , [Handle](react_router.UIMatch.html#Handle) \> {     [data](react_router.UIMatch.html#data-1) : [Data](react_router.UIMatch.html#Data) ;     [handle](react_router.UIMatch.html#handle-1) : [Handle](react_router.UIMatch.html#Handle) ;     [id](react_router.UIMatch.html#id) : string;     [params](react_router.UIMatch.html#params) : [Params](../types/react_router.Params.html) ;     [pathname](react_router.UIMatch.html#pathname) : string; } #### Type Parameters * Data = unknown * Handle = unknown ##### Index ### Properties [data](react_router.UIMatch.html#data-1) [handle](react_router.UIMatch.html#handle-1) [id](react_router.UIMatch.html#id) [params](react_router.UIMatch.html#params) [pathname](react_router.UIMatch.html#pathname) Properties ---------- ### data[](#data-1) data: [Data](react_router.UIMatch.html#Data) ### handle[](#handle-1) handle: [Handle](react_router.UIMatch.html#Handle) ### id[](#id) id: string ### params[](#params) params: [Params](../types/react_router.Params.html) ### pathname[](#pathname) pathname: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [data](#data-1) [handle](#handle-1) [id](#id) [params](#params) [pathname](#pathname) --- # UNSAFE_AssetsManifest | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [UNSAFE\_AssetsManifest](react_router.UNSAFE_AssetsManifest.html) Interface UNSAFE\_AssetsManifest ================================ interface UNSAFE\_AssetsManifest {     [entry](react_router.UNSAFE_AssetsManifest.html#entry) : {         imports: string\[\];         module: string;     };     [hmr](react_router.UNSAFE_AssetsManifest.html#hmr) ?: {         runtime: string;         timestamp?: number;     };     [routes](react_router.UNSAFE_AssetsManifest.html#routes) : RouteManifest;     [url](react_router.UNSAFE_AssetsManifest.html#url) : string;     [version](react_router.UNSAFE_AssetsManifest.html#version) : string; } ##### Index ### Properties [entry](react_router.UNSAFE_AssetsManifest.html#entry) [hmr?](react_router.UNSAFE_AssetsManifest.html#hmr) [routes](react_router.UNSAFE_AssetsManifest.html#routes) [url](react_router.UNSAFE_AssetsManifest.html#url) [version](react_router.UNSAFE_AssetsManifest.html#version) Properties ---------- ### entry[](#entry) entry: {     imports: string\[\];     module: string; } ### `Optional`hmr[](#hmr) hmr?: {     runtime: string;     timestamp?: number; } ### routes[](#routes) routes: RouteManifest ### url[](#url) url: string ### version[](#version) version: string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark ### On This Page Properties [entry](#entry) [hmr](#hmr) [routes](#routes) [url](#url) [version](#version) --- # UNSAFE_RouteModules | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [UNSAFE\_RouteModules](react_router.UNSAFE_RouteModules.html) Interface UNSAFE\_RouteModules ============================== #### Indexable * \[routeId: string\]: RouteModule | undefined ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Blocker | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [Blocker](react_router.Blocker.html) Type Alias Blocker ================== Blocker: BlockerUnblocked | BlockerBlocked | BlockerProceeding ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # BlockerFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [BlockerFunction](react_router.BlockerFunction.html) Type Alias BlockerFunction ========================== BlockerFunction: ((args: {     currentLocation: [Location](../interfaces/react_router.Location.html) ;     historyAction: [NavigationType](../enums/react_router.NavigationType.html) ;     nextLocation: [Location](../interfaces/react_router.Location.html) ; }) => boolean) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ClientActionFunctionArgs | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ClientActionFunctionArgs](react_router.ClientActionFunctionArgs.html) Type Alias ClientActionFunctionArgs =================================== ClientActionFunctionArgs: [ActionFunctionArgs](../interfaces/react_router.ActionFunctionArgs.html) & {     serverAction: (() => Promise\>); } Arguments passed to a route `clientAction` function ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ClientLoaderFunctionArgs | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ClientLoaderFunctionArgs](react_router.ClientLoaderFunctionArgs.html) Type Alias ClientLoaderFunctionArgs =================================== ClientLoaderFunctionArgs: [LoaderFunctionArgs](../interfaces/react_router.LoaderFunctionArgs.html) & {     serverLoader: (() => Promise\>); } Arguments passed to a route `clientLoader` function ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ClientActionFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ClientActionFunction](react_router.ClientActionFunction.html) Type Alias ClientActionFunction =============================== ClientActionFunction: ((args: [ClientActionFunctionArgs](react_router.ClientActionFunctionArgs.html) ) => ReturnType<[ActionFunction](../interfaces/react_router.ActionFunction.html) \>) A function that handles data mutations for a route on the client ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # DataRouteObject | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [DataRouteObject](react_router.DataRouteObject.html) Type Alias DataRouteObject ========================== DataRouteObject: [RouteObject](react_router.RouteObject.html) & {     children?: [DataRouteObject](react_router.DataRouteObject.html) \[\];     id: string; } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CookieOptions | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [CookieOptions](react_router.CookieOptions.html) Type Alias CookieOptions ======================== CookieOptions: [CookieParseOptions](../interfaces/react_router.CookieParseOptions.html) & [CookieSerializeOptions](../interfaces/react_router.CookieSerializeOptions.html) & [CookieSignatureOptions](../interfaces/react_router.CookieSignatureOptions.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ClientLoaderFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ClientLoaderFunction](react_router.ClientLoaderFunction.html) Type Alias ClientLoaderFunction =============================== ClientLoaderFunction: ((args: [ClientLoaderFunctionArgs](react_router.ClientLoaderFunctionArgs.html) ) => ReturnType<[LoaderFunction](react_router.LoaderFunction.html) \>) & {     hydrate?: boolean; } A function that loads data for a route on the client ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ErrorResponse | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ErrorResponse](react_router.ErrorResponse.html) Type Alias ErrorResponse ======================== ErrorResponse: {     data: any;     status: number;     statusText: string; } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # CreateRequestHandlerFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [CreateRequestHandlerFunction](react_router.CreateRequestHandlerFunction.html) Type Alias CreateRequestHandlerFunction ======================================= CreateRequestHandlerFunction: ((build: [ServerBuild](../interfaces/react_router.ServerBuild.html) | (() => [ServerBuild](../interfaces/react_router.ServerBuild.html) | Promise<[ServerBuild](../interfaces/react_router.ServerBuild.html) \>), mode?: string) => [RequestHandler](react_router.RequestHandler.html) ) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Fetcher | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [Fetcher](react_router.Fetcher.html) Type Alias Fetcher ========================= Fetcher<[TData](react_router.Fetcher.html#TData) \>: FetcherStates<[TData](react_router.Fetcher.html#TData) \>\[keyof FetcherStates<[TData](react_router.Fetcher.html#TData)\ \>\] #### Type Parameters * TData = any ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # FetcherWithComponents | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [FetcherWithComponents](react_router.FetcherWithComponents.html) Type Alias FetcherWithComponents ======================================= FetcherWithComponents<[TData](react_router.FetcherWithComponents.html#TData) \>: [Fetcher](react_router.Fetcher.html) <[TData](react_router.FetcherWithComponents.html#TData) \> & {     Form: React.ForwardRefExoticComponent<[FetcherFormProps](../interfaces/react_router.FetcherFormProps.html) & React.RefAttributes\>;     load: ((href: string, opts?: {         flushSync?: boolean;     }) => Promise);     submit: [FetcherSubmitFunction](../interfaces/react_router.FetcherSubmitFunction.html) ; } The return value of `useFetcher` that keeps track of the state of a fetcher. let fetcher = useFetcher(); #### Type Parameters * TData #### Type declaration * ##### Form: React.ForwardRefExoticComponent<[FetcherFormProps](../interfaces/react_router.FetcherFormProps.html) & React.RefAttributes\> Just like [Form](../functions/react_router.Form.html) except it doesn't cause a navigation. function SomeComponent() { const fetcher = useFetcher() return ( )} * ##### load: ((href: string, opts?: {     flushSync?: boolean; }) => Promise) Loads data from a route. Useful for loading data imperatively inside of user events outside of a normal button or form, like a combobox or search input. let fetcher = useFetcher() { fetcher.load(`/search?q=${e.target.value}`)}} /> * * (href, opts?): Promise * #### Parameters * href: string * `Optional`opts: {     flushSync?: boolean; } * ##### `Optional`flushSync?: boolean Wraps the initial state update for this `fetcher.load` in a `ReactDOM.flushSync` call instead of the default `React.startTransition`. This allows you to perform synchronous DOM actions immediately after the update is flushed to the DOM. #### Returns Promise * ##### submit: [FetcherSubmitFunction](../interfaces/react_router.FetcherSubmitFunction.html) Submits form data to a route. While multiple nested routes can match a URL, only the leaf route will be called. The `formData` can be multiple types: * \[`FormData`\]\[form\_data\] - A `FormData` instance. * \[`HTMLFormElement`\]\[html\_form\_element\] - A \[``\]\[form\_element\] DOM element. * `Object` - An object of key/value pairs that will be converted to a `FormData` instance by default. You can pass a more complex object and serialize it as JSON by specifying `encType: "application/json"`. See \[`useSubmit`\]\[use-submit\] for more details. If the method is `GET`, then the route \[`loader`\]\[loader\] is being called and with the `formData` serialized to the url as \[`URLSearchParams`\]\[url\_search\_params\]. If `DELETE`, `PATCH`, `POST`, or `PUT`, then the route \[`action`\]\[action\] is being called with `formData` as the body. // Submit a FormData instance (GET request)const formData = new FormData();fetcher.submit(formData);// Submit the HTML form elementfetcher.submit(event.currentTarget.form, { method: "POST",});// Submit key/value JSON as a FormData instancefetcher.submit( { serialized: "values" }, { method: "POST" });// Submit raw JSONfetcher.submit( { deeply: { nested: { json: "values", }, }, }, { method: "POST", encType: "application/json", }); ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # FlashSessionData | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [FlashSessionData](react_router.FlashSessionData.html) Type Alias FlashSessionData ============================================ FlashSessionData<[Data](react_router.FlashSessionData.html#Data) , [FlashData](react_router.FlashSessionData.html#FlashData) \>: Partial<[Data](react_router.FlashSessionData.html#Data) & {     \[Key in keyof [FlashData](react_router.FlashSessionData.html#FlashData)\ as FlashDataKey<[Key](../interfaces/react_router.Session.html#get.get-1.Key-1)\ & string\>\]: [FlashData](react_router.FlashSessionData.html#FlashData) \[[Key](../interfaces/react_router.Session.html#get.get-1.Key-1)\ \] }\> #### Type Parameters * Data * FlashData ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # FormEncType | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [FormEncType](react_router.FormEncType.html) Type Alias FormEncType ====================== FormEncType:     | "application/x-www-form-urlencoded"     | "multipart/form-data"     | "application/json"     | "text/plain" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # FormMethod | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [FormMethod](react_router.FormMethod.html) Type Alias FormMethod ===================== FormMethod: UpperCaseFormMethod Active navigation/fetcher form methods are exposed in uppercase on the RouterState. This is to align with the normalization done via fetch(). ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HeadersArgs | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [HeadersArgs](react_router.HeadersArgs.html) Type Alias HeadersArgs ====================== HeadersArgs: {     actionHeaders: Headers;     errorHeaders: Headers | undefined;     loaderHeaders: Headers;     parentHeaders: Headers; } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HTMLFormMethod | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [HTMLFormMethod](react_router.HTMLFormMethod.html) Type Alias HTMLFormMethod ========================= HTMLFormMethod: LowerCaseFormMethod | UpperCaseFormMethod Users can specify either lowercase or uppercase form methods on ``, useSubmit(), ``, etc. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HtmlLinkDescriptor | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [HtmlLinkDescriptor](react_router.HtmlLinkDescriptor.html) Type Alias HtmlLinkDescriptor ============================= HtmlLinkDescriptor: HtmlLinkProps & Pick, "href"\> | HtmlLinkPreloadImage & Pick, "imageSizes"\> | HtmlLinkPreloadImage & Pick, "href"\> & {     imageSizes?: never; } Represents a `` element. WHATWG Specification: [https://html.spec.whatwg.org/multipage/semantics.html#the-link-element](https://html.spec.whatwg.org/multipage/semantics.html#the-link-element) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # HydrationState | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [HydrationState](react_router.HydrationState.html) Type Alias HydrationState ========================= HydrationState: Partial\> Data that can be passed into hydrate a Router from SSR ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # InitialEntry | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [InitialEntry](react_router.InitialEntry.html) Type Alias InitialEntry ======================= InitialEntry: string | Partial<[Location](../interfaces/react_router.Location.html) \> A user-supplied object that describes a location. Used when providing entries to `createMemoryHistory` via its `initialEntries` option. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # IsCookieFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [IsCookieFunction](react_router.IsCookieFunction.html) Type Alias IsCookieFunction =========================== IsCookieFunction: ((object: any) => object is [Cookie](../interfaces/react_router.Cookie.html) ) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # IsSessionFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [IsSessionFunction](react_router.IsSessionFunction.html) Type Alias IsSessionFunction ============================ IsSessionFunction: ((object: any) => object is [Session](../interfaces/react_router.Session.html) ) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LoaderFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [LoaderFunction](react_router.LoaderFunction.html) Type Alias LoaderFunction ================================== LoaderFunction<[Context](react_router.LoaderFunction.html#Context) \>: ((args: [LoaderFunctionArgs](../interfaces/react_router.LoaderFunctionArgs.html) <[Context](react_router.LoaderFunction.html#Context) \>, handlerCtx?: unknown) => DataFunctionReturnValue) & {     hydrate?: boolean; } Route loader function signature #### Type Parameters * Context = any ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # LinkDescriptor | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [LinkDescriptor](react_router.LinkDescriptor.html) Type Alias LinkDescriptor ========================= LinkDescriptor: [HtmlLinkDescriptor](react_router.HtmlLinkDescriptor.html) | [PageLinkDescriptor](../interfaces/react_router.PageLinkDescriptor.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # MetaDescriptor | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [MetaDescriptor](react_router.MetaDescriptor.html) Type Alias MetaDescriptor ========================= MetaDescriptor:     | {         charSet: "utf-8";     }     | {         title: string;     }     | {         content: string;         name: string;     }     | {         content: string;         property: string;     }     | {         content: string;         httpEquiv: string;     }     | {         script:ld+json: LdJsonObject;     }     | {         tagName: "meta" | "link";         \[name: string\]: string;     }     | {         \[name: string\]: unknown;     } ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Navigation | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [Navigation](react_router.Navigation.html) Type Alias Navigation ===================== Navigation: [NavigationStates](react_router.NavigationStates.html) \[keyof [NavigationStates](react_router.NavigationStates.html)\ \] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NavigationStates | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [NavigationStates](react_router.NavigationStates.html) Type Alias NavigationStates =========================== NavigationStates: {     Idle: {         formAction: undefined;         formData: undefined;         formEncType: undefined;         formMethod: undefined;         json: undefined;         location: undefined;         state: "idle";         text: undefined;     };     Loading: {         formAction: Submission\["formAction"\] | undefined;         formData: Submission\["formData"\] | undefined;         formEncType: Submission\["formEncType"\] | undefined;         formMethod: Submission\["formMethod"\] | undefined;         json: Submission\["json"\] | undefined;         location: [Location](../interfaces/react_router.Location.html) ;         state: "loading";         text: Submission\["text"\] | undefined;     };     Submitting: {         formAction: Submission\["formAction"\];         formData: Submission\["formData"\];         formEncType: Submission\["formEncType"\];         formMethod: Submission\["formMethod"\];         json: Submission\["json"\];         location: [Location](../interfaces/react_router.Location.html) ;         state: "submitting";         text: Submission\["text"\];     }; } Potential states for state.navigation ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ParamParseKey | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ParamParseKey](react_router.ParamParseKey.html) Type Alias ParamParseKey ================================= ParamParseKey<[Segment](react_router.ParamParseKey.html#Segment) \>: \[[PathParam](react_router.PathParam.html)\ <[Segment](react_router.ParamParseKey.html#Segment)\ \>\] extends \[never\]     ? string     : [PathParam](react_router.PathParam.html) <[Segment](react_router.ParamParseKey.html#Segment) \> #### Type Parameters * Segment extends string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # NavLinkRenderProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [NavLinkRenderProps](react_router.NavLinkRenderProps.html) Type Alias NavLinkRenderProps ============================= NavLinkRenderProps: {     isActive: boolean;     isPending: boolean;     isTransitioning: boolean; } The object passed to [NavLink](../functions/react_router.NavLink.html) `children`, `className`, and `style` prop callbacks to render and style the link based on its state. // className isPending ? "pending" : isActive ? "active" : "" }> Messages// style { return { fontWeight: isActive ? "bold" : "", color: isPending ? "red" : "black", } )}/>// children {({ isActive, isPending }) => ( Tasks )} #### Type declaration * ##### isActive: boolean Indicates if the link's URL matches the current location. * ##### isPending: boolean Indicates if the pending location matches the link's URL. * ##### isTransitioning: boolean Indicates if a view transition to the link's URL is in progress. See [useViewTransitionState](../functions/react_router.useViewTransitionState.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ParamKeyValuePair | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ParamKeyValuePair](react_router.ParamKeyValuePair.html) Type Alias ParamKeyValuePair ============================ ParamKeyValuePair: \[string, string\] ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PatchRoutesOnNavigationFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [PatchRoutesOnNavigationFunction](react_router.PatchRoutesOnNavigationFunction.html) Type Alias PatchRoutesOnNavigationFunction ========================================== PatchRoutesOnNavigationFunction: AgnosticPatchRoutesOnNavigationFunction<[RouteObject](react_router.RouteObject.html) , [RouteMatch](../interfaces/react_router.RouteMatch.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # Params | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [Params](react_router.Params.html) Type Alias Params ====================== Params<[Key](react_router.Params.html#Key) \>: {     readonly \[key in [Key](react_router.Params.html#Key)\ \]: string | undefined } The parameters that were parsed from the URL path. #### Type Parameters * Key extends string = string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PatchRoutesOnNavigationFunctionArgs | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [PatchRoutesOnNavigationFunctionArgs](react_router.PatchRoutesOnNavigationFunctionArgs.html) Type Alias PatchRoutesOnNavigationFunctionArgs ============================================== PatchRoutesOnNavigationFunctionArgs: AgnosticPatchRoutesOnNavigationFunctionArgs<[RouteObject](react_router.RouteObject.html) , [RouteMatch](../interfaces/react_router.RouteMatch.html) \> ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RedirectFunction | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RedirectFunction](react_router.RedirectFunction.html) Type Alias RedirectFunction =========================== RedirectFunction: ((url: string, init?: number | ResponseInit) => Response) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RelativeRoutingType | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RelativeRoutingType](react_router.RelativeRoutingType.html) Type Alias RelativeRoutingType ============================== RelativeRoutingType: "route" | "path" * "route": relative to the route hierarchy so `..` means remove all segments of the current route even if it has many. For example, a `route("posts/:id")` would have both `:id` and `posts` removed from the url. * "path": relative to the pathname so `..` means remove one segment of the pathname. For example, a `route("posts/:id")` would have only `:id` removed from the url. ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # PathParam | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [PathParam](react_router.PathParam.html) Type Alias PathParam ========================== PathParam<[Path](react_router.PathParam.html#Path) \>: [Path](react_router.PathParam.html#Path) extends "\*" | "/\*"     ? "\*"     : [Path](react_router.PathParam.html#Path) extends \`${infer Rest}/\*\`         ? "\*" | \_PathParam         : \_PathParam<[Path](react_router.PathParam.html#Path) \> #### Type Parameters * Path extends string ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RouteObject | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RouteObject](react_router.RouteObject.html) Type Alias RouteObject ====================== RouteObject: [IndexRouteObject](../interfaces/react_router.IndexRouteObject.html) | [NonIndexRouteObject](../interfaces/react_router.NonIndexRouteObject.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RevalidationState | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RevalidationState](react_router.RevalidationState.html) Type Alias RevalidationState ============================ RevalidationState: "idle" | "loading" ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RequestHandler | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RequestHandler](react_router.RequestHandler.html) Type Alias RequestHandler ========================= RequestHandler: ((request: Request, loadContext?: [AppLoadContext](../interfaces/react_router.AppLoadContext.html) ) => Promise) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RouteProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RouteProps](react_router.RouteProps.html) Type Alias RouteProps ===================== RouteProps: [PathRouteProps](../interfaces/react_router.PathRouteProps.html) | [LayoutRouteProps](../interfaces/react_router.LayoutRouteProps.html) | [IndexRouteProps](../interfaces/react_router.IndexRouteProps.html) ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RouterFetchOptions | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RouterFetchOptions](react_router.RouterFetchOptions.html) Type Alias RouterFetchOptions ============================= RouterFetchOptions: LoadFetchOptions | SubmitFetchOptions Options to pass to fetch() ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # RouterNavigateOptions | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [RouterNavigateOptions](react_router.RouterNavigateOptions.html) Type Alias RouterNavigateOptions ================================ RouterNavigateOptions: LinkNavigateOptions | SubmissionNavigateOptions Options to pass to navigate() for a navigation ### Settings Member Visibility * Protected * Inherited * External ThemeOSLightDark --- # ScriptsProps | React Router API Reference * [React Router API Reference](../modules.html) * [react-router](../modules/react_router.html) * [ScriptsProps](react_router.ScriptsProps.html) Type Alias ScriptsProps ======================= ScriptsProps: Omit,     | "children"     | "async"     | "defer"     | "src"     | "type"     | "noModule"     | "dangerouslySetInnerHTML"     | "suppressHydrationWarning"\> A couple common attributes: * `` for hosting your static assets on a different server than your app. * `` to support a [content security policy for scripts](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src) with [nonce-sources](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources) for your `