external fun _renderMatches(matches: ReadonlyArray<RouteMatch<*>>?, parentMatches: ReadonlyArray<RouteMatch<*>> = definedExternally, dataRouterState: RouterState? = definedExternally, future: FutureConfig? = definedExternally): ReactElement<*>?

createMemoryRouter

external fun createMemoryRouter(routes: ReadonlyArray<RouteObject>, opts: CreateMemoryRouterOpts = definedExternally): Router

mapRouteProperties

external fun mapRouteProperties(route: RouteObject): MapRoutePropertiesResult

renderMatches

external fun renderMatches(matches: ReadonlyArray<RouteMatch<*>>?): ReactElement<*>?

Renders the result of matchRoutes() into a React element.

useActionData

external fun useActionData(): Any?

Returns the action data for the nearest ancestor Route action

useAsyncError

external fun useAsyncError(): JsError?

Returns the error from the nearest ancestor <Await /> value

useAsyncValue

external fun useAsyncValue(): Any?

Returns the happy-path data from the nearest ancestor <Await /> value

useBlocker

external fun useBlocker(shouldBlock: Boolean): Blocker

external fun useBlocker(shouldBlock: BlockerFunction): Blocker

Allow the application to block navigations within the SPA and present the user a confirmation dialog to confirm the navigation. Mostly used to avoid using half-filled form data. This does not handle hard-reloads or cross-origin navigations.

useHref

external fun useHref(to: To, options: UseHrefOptions = definedExternally): String

Returns the full href for the given "to" value. This is useful for building custom links that are also accessible and preserve right-click behavior.

useInRouterContext

external fun useInRouterContext(): Boolean

Returns true if this component is a descendant of a <Router>.

useLoaderData

external fun useLoaderData(): Any?

Returns the loader data for the nearest ancestor Route loader

useLocation

external fun useLocation(): Location<*>

Returns the current location object, which represents the current URL in web browsers.

useMatch

external fun useMatch(pattern: String): PathMatch?

external fun useMatch(pattern: PathPattern): PathMatch?

Returns a PathMatch object if the given pattern matches the current URL. This is useful for components that need to know "active" state, e.g. <NavLink>.

useMatches

external fun useMatches(): ReadonlyArray<UIMatch<*, *>>

Returns the active route matches, useful for accessing loaderData for parent/child routes or the route "handle" property

useNavigate

external fun useNavigate(): NavigateFunction

Returns an imperative method for changing the location. Used by <Link>s, but may also be used by other elements to change the location.

useNavigation

external fun useNavigation(): Navigation

Returns the current navigation, defaulting to an "idle" navigation when no navigation is in progress

useNavigationType

external fun useNavigationType(): Action

Returns the current navigation action which describes how the router came to the current location, either by a pop, push, or replace on the history stack.

useOutlet

external fun useOutlet(context: Any? = definedExternally): ReactElement<*>?

Returns the element for the child route at this level of the route hierarchy. Used internally by <Outlet> to render child routes.

useOutletContext

external fun <Context> useOutletContext(): Context

Returns the context (if provided) for the child route at this level of the route hierarchy.

useParams

external fun useParams(): Params

Returns an object of key/value pairs of the dynamic params from the current URL that were matched by the route path.

useResolvedPath

external fun useResolvedPath(to: To, options: UseResolvedPathOptions = definedExternally): Path

Resolves the pathname of the given to value against the current location.

useRevalidator

external fun useRevalidator(): UseRevalidatorResult

Returns a revalidate function for manually triggering revalidation, as well as the current state of any manual revalidations

useRouteError

external fun useRouteError(): Any?

Returns the nearest ancestor Route error, which could be a loader/action error or a render error. This is intended to be called from your ErrorBoundary/errorElement to display a proper error message.

useRouteId

external fun useRouteId(): String

Returns the ID for the nearest contextual route

useRouteLoaderData

external fun useRouteLoaderData(routeId: String): Any?

Returns the loaderData for the given routeId

useRoutes

external fun useRoutes(routes: ReadonlyArray<RouteObject>): ReactElement<*>?

external fun useRoutes(routes: ReadonlyArray<RouteObject>, locationArg: String = definedExternally): ReactElement<*>?

external fun useRoutes(routes: ReadonlyArray<RouteObject>, locationArg: Location<*> = definedExternally): ReactElement<*>?

Returns the element of the route that matched the current location, prepared with the correct context to render the remainder of the route tree. Route elements in the tree must render an <Outlet> to render their child route's element.

useRoutesImpl

external fun useRoutesImpl(routes: ReadonlyArray<RouteObject>): ReactElement<*>?

external fun useRoutesImpl(routes: ReadonlyArray<RouteObject>, locationArg: String = definedExternally, dataRouterState: RouterState = definedExternally, future: FutureConfig = definedExternally): ReactElement<*>?

external fun useRoutesImpl(routes: ReadonlyArray<RouteObject>, locationArg: Location<*> = definedExternally, dataRouterState: RouterState = definedExternally, future: FutureConfig = definedExternally): ReactElement<*>?