react-router 8.2.0 → 8.3.1

package/dist/development/lib/dom/dom.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -30,30 +30,30 @@ function shouldProcessLinkClick(event, target) {
 	return event.button === 0 && (!target || target === "_self") && !isModifiedEvent(event);
 }
 /**
-Creates a URLSearchParams object using the given initializer.
-
-This is identical to `new URLSearchParams(init)` except it also
-supports arrays as values in the object form of the initializer
-instead of just strings. This is convenient when you need multiple
-values for a given key, but don't want to use an array initializer.
-
-For example, instead of:
-
-```tsx
-let searchParams = new URLSearchParams([
-['sort', 'name'],
-['sort', 'price']
-]);
-```
-you can do:
-
-```
-let searchParams = createSearchParams({
-sort: ['name', 'price']
-});
-```
-
-@category Utils
+* Creates a URLSearchParams object using the given initializer.
+*
+* This is identical to `new URLSearchParams(init)` except it also supports
+* arrays as values in the object form of the initializer instead of just
+* strings. This is convenient when you need multiple values for a given key,
+* but don't want to use an array initializer.
+*
+* @example
+* // Instead of:
+* let searchParams = new URLSearchParams([
+*   ["sort", "name"],
+*   ["sort", "price"],
+* ]);
+*
+* // You can do:
+* let searchParams = createSearchParams({
+*   sort: ["name", "price"],
+* });
+*
+* @public
+* @category Utils
+* @param init The value used to initialize the URL search parameters.
+* @returns A URLSearchParams object containing the initialized search
+* parameters.
 */
 function createSearchParams(init = "") {
 	return new URLSearchParams(typeof init === "string" || Array.isArray(init) || init instanceof URLSearchParams ? init : Object.keys(init).reduce((memo, key) => {
@@ -75,7 +75,7 @@ function isFormDataSubmitterSupported() {
 	if (_formDataSupportsSubmitter === null) try {
 		new FormData(document.createElement("form"), 0);
 		_formDataSupportsSubmitter = false;
-	} catch (e) {
+	} catch {
 		_formDataSupportsSubmitter = true;
 	}
 	return _formDataSupportsSubmitter;

package/dist/development/lib/dom/lib.d.ts

@@ -1409,7 +1409,8 @@ declare namespace ScrollRestoration {
  * for this navigation. To apply specific styles during the transition, see
  * {@link useViewTransitionState}. Defaults to `false`.
  * @param options.defaultShouldRevalidate Specify the default revalidation
- * behavior for the navigation. Defaults to `true`.
+ * behavior for the navigation. When not specified, loaders revalidate
+ * according to the router's standard revalidation behavior.
  * @param options.mask Masked location to display in the browser instead
  * of the router location. Defaults to `undefined`.
  * @param options.useTransitions Wraps the navigation in

package/dist/development/lib/dom/lib.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -22,8 +22,8 @@ import * as React$1 from "react";
 //#region lib/dom/lib.tsx
 const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined" && typeof window.document.createElement !== "undefined";
 try {
-	if (isBrowser) window.__reactRouterVersion = "8.2.0";
-} catch (e) {}
+	if (isBrowser) window.__reactRouterVersion = "8";
+} catch {}
 /**
 * Create a new {@link DataRouter| data router} that manages the application
 * path via [`history.pushState`](https://developer.mozilla.org/en-US/docs/Web/API/History/pushState)
@@ -123,7 +123,7 @@ function deserializeErrors(errors) {
 				let error = new ErrorConstructor(val.message);
 				error.stack = "";
 				serialized[key] = error;
-			} catch (e) {}
+			} catch {}
 		}
 		if (serialized[key] == null) {
 			let error = new Error(val.message);
@@ -386,7 +386,7 @@ const NavLink = React$1.forwardRef(function NavLinkWithRef({ "aria-current": ari
 	if (nextLocationPathname && basename) nextLocationPathname = stripBasename(nextLocationPathname, basename) || nextLocationPathname;
 	const endSlashPosition = toPathname !== "/" && toPathname.endsWith("/") ? toPathname.length - 1 : toPathname.length;
 	let isActive = locationPathname === toPathname || !end && locationPathname.startsWith(toPathname) && locationPathname.charAt(endSlashPosition) === "/";
-	let isPending = nextLocationPathname != null && (nextLocationPathname === toPathname || !end && nextLocationPathname.startsWith(toPathname) && nextLocationPathname.charAt(toPathname.length) === "/");
+	let isPending = nextLocationPathname != null && (nextLocationPathname === toPathname || !end && nextLocationPathname.startsWith(toPathname) && nextLocationPathname.charAt(endSlashPosition) === "/");
 	let renderProps = {
 		isActive,
 		isPending,
@@ -609,7 +609,8 @@ function useDataRouterState(hookName) {
 * for this navigation. To apply specific styles during the transition, see
 * {@link useViewTransitionState}. Defaults to `false`.
 * @param options.defaultShouldRevalidate Specify the default revalidation
-* behavior for the navigation. Defaults to `true`.
+* behavior for the navigation. When not specified, loaders revalidate
+* according to the router's standard revalidation behavior.
 * @param options.mask Masked location to display in the browser instead
 * of the router location. Defaults to `undefined`.
 * @param options.useTransitions Wraps the navigation in
@@ -795,6 +796,7 @@ function useSubmit() {
 		if (options.navigate === false) await routerFetch(options.fetcherKey || getUniqueFetcherId(), currentRouteId, options.action || action, {
 			defaultShouldRevalidate: options.defaultShouldRevalidate,
 			preventScrollReset: options.preventScrollReset,
+			relative: options.relative,
 			formData,
 			body,
 			formMethod: options.method || method,
@@ -804,6 +806,7 @@ function useSubmit() {
 		else await routerNavigate(options.action || action, {
 			defaultShouldRevalidate: options.defaultShouldRevalidate,
 			preventScrollReset: options.preventScrollReset,
+			relative: options.relative,
 			formData,
 			body,
 			formMethod: options.method || method,
@@ -1086,6 +1089,9 @@ function useScrollRestoration({ getKey, storageKey } = {}) {
 			window.history.scrollRestoration = "auto";
 		};
 	}, []);
+	usePageShow(React$1.useCallback((event) => {
+		if (event.persisted) window.history.scrollRestoration = "manual";
+	}, []));
 	usePageHide(React$1.useCallback(() => {
 		if (navigation.state === "idle") {
 			let key = getScrollRestorationKey(location, matches, basename, getKey);
@@ -1110,7 +1116,7 @@ function useScrollRestoration({ getKey, storageKey } = {}) {
 			try {
 				let sessionPositions = sessionStorage.getItem(storageKey || SCROLL_RESTORATION_STORAGE_KEY);
 				if (sessionPositions) savedScrollPositions = JSON.parse(sessionPositions);
-			} catch (e) {}
+			} catch {}
 		}, [storageKey]);
 		React$1.useLayoutEffect(() => {
 			let disableScrollRestoration = router?.enableScrollRestoration(savedScrollPositions, () => window.scrollY, getKey ? (location, matches) => getScrollRestorationKey(location, matches, basename, getKey) : void 0);
@@ -1178,6 +1184,16 @@ function usePageHide(callback, options) {
 		};
 	}, [callback, capture]);
 }
+function usePageShow(callback, options) {
+	let { capture } = options || {};
+	React$1.useEffect(() => {
+		let opts = capture != null ? { capture } : void 0;
+		window.addEventListener("pageshow", callback, opts);
+		return () => {
+			window.removeEventListener("pageshow", callback, opts);
+		};
+	}, [callback, capture]);
+}
 /**
 * Wrapper around {@link useBlocker} to show a [`window.confirm`](https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm)
 * prompt to users instead of building a custom UI with {@link useBlocker}.

package/dist/development/lib/dom/server.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/components.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -425,7 +425,7 @@ function Meta() {
 				type: "application/ld+json",
 				dangerouslySetInnerHTML: { __html: escapeHtml(json) }
 			});
-		} catch (e) {
+		} catch {
 			return null;
 		}
 		return /* @__PURE__ */ React$1.createElement("meta", {

package/dist/development/lib/dom/ssr/data.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/errorBoundaries.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/fallback.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/fog-of-war.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -110,6 +110,29 @@ function getManifestPath(_manifestPath, basename) {
 	return basename == null ? manifestPath : joinPaths([basename, manifestPath]);
 }
 const MANIFEST_VERSION_STORAGE_KEY = "react-router-manifest-version";
+async function handleClientVersionMismatch(needsReload, version, errorReloadPath) {
+	if (!needsReload) {
+		try {
+			sessionStorage.removeItem(MANIFEST_VERSION_STORAGE_KEY);
+		} catch {}
+		return false;
+	}
+	if (!errorReloadPath) {
+		console.warn("Detected a manifest version mismatch during eager route discovery. The next navigation/fetch to an undiscovered route will result in a new document navigation to sync up with the latest manifest.");
+		return true;
+	}
+	try {
+		if (sessionStorage.getItem(MANIFEST_VERSION_STORAGE_KEY) === version) {
+			console.error("Unable to discover routes due to manifest version mismatch.");
+			return true;
+		}
+		sessionStorage.setItem(MANIFEST_VERSION_STORAGE_KEY, version);
+	} catch {}
+	window.location.href = errorReloadPath;
+	console.warn("Detected manifest version mismatch, reloading...");
+	await new Promise(() => {});
+	return true;
+}
 async function fetchAndApplyManifestPatches(paths, errorReloadPath, manifest, routeModules, ssr, isSpaMode, basename, manifestPath, patchRoutes, signal) {
 	paths = getPathsWithAncestors(paths);
 	const searchParams = new URLSearchParams();
@@ -125,30 +148,13 @@ async function fetchAndApplyManifestPatches(paths, errorReloadPath, manifest, ro
 	try {
 		let res = await fetch(url, { signal });
 		if (!res.ok) throw new Error(`${res.status} ${res.statusText}`);
-		else if (res.status === 204 && res.headers.has("X-Remix-Reload-Document")) {
-			if (!errorReloadPath) {
-				console.warn("Detected a manifest version mismatch during eager route discovery. The next navigation/fetch to an undiscovered route will result in a new document navigation to sync up with the latest manifest.");
-				return;
-			}
-			try {
-				if (sessionStorage.getItem(MANIFEST_VERSION_STORAGE_KEY) === manifest.version) {
-					console.error("Unable to discover routes due to manifest version mismatch.");
-					return;
-				}
-				sessionStorage.setItem(MANIFEST_VERSION_STORAGE_KEY, manifest.version);
-			} catch {}
-			window.location.href = errorReloadPath;
-			console.warn("Detected manifest version mismatch, reloading...");
-			await new Promise(() => {});
-		} else if (res.status >= 400) throw new Error(await res.text());
-		try {
-			sessionStorage.removeItem(MANIFEST_VERSION_STORAGE_KEY);
-		} catch {}
+		if (await handleClientVersionMismatch(res.status === 204 && res.headers.has("X-Remix-Reload-Document"), manifest.version, errorReloadPath)) return;
 		serverPatches = await res.json();
 	} catch (e) {
 		if (signal?.aborted) return;
 		throw e;
 	}
+	if (signal?.aborted) return;
 	let knownRoutes = new Set(Object.keys(manifest.routes));
 	let patches = Object.values(serverPatches).reduce((acc, route) => {
 		if (route && !knownRoutes.has(route.id)) acc[route.id] = route;
@@ -177,4 +183,4 @@ function debounce(callback, wait) {
 	};
 }
 //#endregion
-export { URL_LIMIT, getManifestPath, getPartialManifest, getPatchRoutesOnNavigationFunction, getPathsWithAncestors, isFogOfWarEnabled, useFogOFWarDiscovery };
+export { URL_LIMIT, getManifestPath, getPartialManifest, getPatchRoutesOnNavigationFunction, getPathsWithAncestors, handleClientVersionMismatch, isFogOfWarEnabled, useFogOFWarDiscovery };

package/dist/development/lib/dom/ssr/hydration.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/invariant.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/links.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/markup.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/routeModules.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/routes-test-stub.d.ts

@@ -50,7 +50,20 @@ interface RoutesTestStubProps {
   future?: Partial<FutureConfig>;
 }
 /**
+ * Creates a React component that renders the provided routes in a test-friendly
+ * React Router context.
+ *
+ * Use this to unit test components that rely on router context, such as
+ * `loaderData`, `actionData`, and route matches.
+ *
+ * @public
  * @category Utils
+ * @mode framework
+ * @mode data
+ * @param routes The route objects to render in the test router.
+ * @param _context An optional {@link RouterContextProvider} for supplying
+ * application context values to route middleware, loaders, and actions.
+ * @returns A React component that renders the test router.
  */
 declare function createRoutesStub(routes: StubRouteObject[], _context?: RouterContextProvider): ({
   initialEntries,

package/dist/development/lib/dom/ssr/routes-test-stub.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -14,7 +14,20 @@ import { FrameworkContext } from "./components.js";
 import * as React$1 from "react";
 //#region lib/dom/ssr/routes-test-stub.tsx
 /**
+* Creates a React component that renders the provided routes in a test-friendly
+* React Router context.
+*
+* Use this to unit test components that rely on router context, such as
+* `loaderData`, `actionData`, and route matches.
+*
+* @public
 * @category Utils
+* @mode framework
+* @mode data
+* @param routes The route objects to render in the test router.
+* @param _context An optional {@link RouterContextProvider} for supplying
+* application context values to route middleware, loaders, and actions.
+* @returns A React component that renders the test router.
 */
 function createRoutesStub(routes, _context) {
 	return function RoutesTestStub({ initialEntries, initialIndex, hydrationData, future }) {

package/dist/development/lib/dom/ssr/routes.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/server.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom/ssr/single-fetch.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -205,7 +205,7 @@ async function bubbleMiddlewareErrors(singleFetchPromise, matches, routesParams,
 		if (middlewareError !== void 0) Array.from(routesParams.values()).forEach((routeId) => {
 			if (results[routeId].result instanceof SingleFetchNoResultError) results[routeId].result = middlewareError;
 		});
-	} catch (e) {}
+	} catch {}
 }
 async function singleFetchLoaderFetcherStrategy(args, fetchAndDecode) {
 	let fetcherMatch = args.matches.find((m) => m.shouldCallHandler());
@@ -277,7 +277,7 @@ async function fetchAndDecodeViaTurboStream(args, targetRoutes) {
 			status: res.status,
 			data
 		};
-	} catch (e) {
+	} catch {
 		throw new Error("Unable to decode turbo-stream response");
 	}
 }
@@ -326,13 +326,13 @@ function createDeferred() {
 			res(val);
 			try {
 				await promise;
-			} catch (e) {}
+			} catch {}
 		};
 		reject = async (error) => {
 			rej(error);
 			try {
 				await promise;
-			} catch (e) {}
+			} catch {}
 		};
 	});
 	return {

package/dist/development/lib/dom-export/dom-router-provider.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/dom-export/hydrated-router.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/errors.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *

package/dist/development/lib/hooks.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -8,8 +8,9 @@
  *
  * @license MIT
  */
-import { invariant, parsePath, warning } from "./router/history.js";
+import { createPath, invariant, parsePath, warning } from "./router/history.js";
 import { convertRouteMatchToUiMatch, decodePath, getResolveToMatches, getRoutePattern, isBrowser, isRouteErrorResponse, joinPaths, matchPath, matchRoutes, parseToInfo, resolveTo, stripBasename } from "./router/utils.js";
+import { getNavigatorCurrentUrl, validateNavigationTarget } from "./router/navigation.js";
 import { IDLE_BLOCKER, hasInvalidProtocol } from "./router/router.js";
 import { AwaitContext, DataRouterContext, DataRouterStateContext, LocationContext, NavigationContext, RSCRouterContext, RouteContext, RouteErrorContext } from "./context.js";
 import { decodeRedirectErrorDigest, decodeRouteErrorResponseDigest } from "./errors.js";
@@ -291,6 +292,7 @@ function useNavigateUnstable() {
 		}
 		let path = resolveTo(to, JSON.parse(routePathnamesJson), locationPathname, options.relative === "path");
 		if (dataRouterContext == null && basename !== "/") path.pathname = path.pathname === "/" ? basename : joinPaths([basename, path.pathname]);
+		validateNavigationTarget(typeof to === "string" ? to : createPath(to), navigator.createHref(path), getNavigatorCurrentUrl(navigator), "reject");
 		(!!options.replace ? navigator.replace : navigator.push)(path, options.state, options);
 	}, [
 		basename,
@@ -687,7 +689,7 @@ var RenderErrorBoundary = class extends React$1.Component {
 };
 const errorRedirectHandledMap = /* @__PURE__ */ new WeakMap();
 function RSCErrorHandler({ children, error }) {
-	let { basename } = React$1.useContext(NavigationContext);
+	let { basename, navigator } = React$1.useContext(NavigationContext);
 	if (typeof error === "object" && error && "digest" in error && typeof error.digest === "string") {
 		let redirect = decodeRedirectErrorDigest(error.digest);
 		if (redirect) {
@@ -695,6 +697,7 @@ function RSCErrorHandler({ children, error }) {
 			if (existingRedirect) throw existingRedirect;
 			let parsed = parseToInfo(redirect.location, basename);
 			let target = parsed.absoluteURL || parsed.to;
+			validateNavigationTarget(redirect.location, target, getNavigatorCurrentUrl(navigator), "allow-explicit");
 			if (hasInvalidProtocol(target)) throw new Error("Invalid redirect location");
 			if (isBrowser && !errorRedirectHandledMap.get(error)) if (parsed.isExternal || redirect.reloadDocument) window.location.href = target;
 			else {

package/dist/development/lib/href.d.ts

@@ -6,14 +6,30 @@ import { Pages } from "./types/register.js";
 type Args = { [K in keyof Pages]: ToArgs<Pages[K]["params"]> };
 type ToArgs<Params extends Record<string, string | undefined>> = Equal<Params, {}> extends true ? [] : Partial<Params> extends Params ? [Params] | [] : [Params];
 /**
-  Returns a resolved URL path for the specified route.
-
-  ```tsx
-  const h = href("/:lang?/about", { lang: "en" })
-  // -> `/en/about`
-
-  <Link to={href("/products/:id", { id: "abc123" })} />
-  ```
+ * Returns a resolved URL path for the specified route.
+ *
+ * Param values are percent-encoded for use in a path segment: characters that
+ * would change the URL structure (`/`, `?`, `#`, `%`, whitespace, non-ASCII)
+ * are escaped, while characters that RFC 3986 allows literally in a path
+ * segment (`$ & + , ; = : @`) are kept as-is. Note this differs from query-string
+ * encoding (`encodeURIComponent`/`URLSearchParams`), where those characters are
+ * delimiters and must be escaped. Splat (`*`) values are encoded per segment,
+ * preserving `/` separators.
+ *
+ * See [RFC 3986 §3.3](https://datatracker.ietf.org/doc/html/rfc3986#section-3.3)
+ *
+ * @example
+ * const h = href("/:lang?/about", { lang: "en" })
+ * // -> `/en/about`
+ *
+ * <Link to={href("/products/:id", { id: "abc123" })} />
+ *
+ * @public
+ * @category Utils
+ * @mode framework
+ * @param path The route path to resolve
+ * @param args The route params to use when resolving the path
+ * @returns The resolved URL path
  */
 declare function href<Path extends keyof Args>(path: Path, ...args: Args[Path]): string;
 //#endregion

package/dist/development/lib/href.js

@@ -1,5 +1,5 @@
 /**
- * react-router v8.2.0
+ * react-router v8.3.1
  *
  * Copyright (c) Remix Software Inc.
  *
@@ -8,19 +8,36 @@
  *
  * @license MIT
  */
+import { encodePathParam } from "./router/utils.js";
 //#region lib/href.ts
 function stringify(p) {
 	return p == null ? "" : typeof p === "string" ? p : String(p);
 }
 /**
-Returns a resolved URL path for the specified route.
-
-```tsx
-const h = href("/:lang?/about", { lang: "en" })
-// -> `/en/about`
-
-<Link to={href("/products/:id", { id: "abc123" })} />
-```
+* Returns a resolved URL path for the specified route.
+*
+* Param values are percent-encoded for use in a path segment: characters that
+* would change the URL structure (`/`, `?`, `#`, `%`, whitespace, non-ASCII)
+* are escaped, while characters that RFC 3986 allows literally in a path
+* segment (`$ & + , ; = : @`) are kept as-is. Note this differs from query-string
+* encoding (`encodeURIComponent`/`URLSearchParams`), where those characters are
+* delimiters and must be escaped. Splat (`*`) values are encoded per segment,
+* preserving `/` separators.
+*
+* See [RFC 3986 §3.3](https://datatracker.ietf.org/doc/html/rfc3986#section-3.3)
+*
+* @example
+* const h = href("/:lang?/about", { lang: "en" })
+* // -> `/en/about`
+*
+* <Link to={href("/products/:id", { id: "abc123" })} />
+*
+* @public
+* @category Utils
+* @mode framework
+* @param path The route path to resolve
+* @param args The route params to use when resolving the path
+* @returns The resolved URL path
 */
 function href(path, ...args) {
 	let params = args[0];
@@ -28,11 +45,11 @@ function href(path, ...args) {
 		const isRequired = questionMark === void 0;
 		const value = params?.[param];
 		if (isRequired && value === void 0) throw new Error(`Path '${path}' requires param '${param}' but it was not provided`);
-		return value == null ? "" : "/" + encodeURIComponent(stringify(value));
+		return value == null ? "" : "/" + encodePathParam(stringify(value));
 	});
 	if (path.endsWith("*")) {
 		const value = params?.["*"];
-		if (value !== void 0) result += "/" + stringify(value).split("/").map(encodeURIComponent).join("/");
+		if (value !== void 0) result += "/" + stringify(value).split("/").map(encodePathParam).join("/");
 	}
 	return result || "/";
 }

package/dist/development/lib/router/history.d.ts

@@ -236,7 +236,10 @@ declare function invariant<T>(value: T | null | undefined, message?: string): as
 /**
  * Creates a string URL path from the given pathname, search, and hash components.
  *
+ * @public
  * @category Utils
+ * @param path The pathname, search, and hash components to combine.
+ * @returns The combined URL path.
  */
 declare function createPath({
   pathname,
@@ -246,7 +249,10 @@ declare function createPath({
 /**
  * Parses a string URL path into its separate pathname, search, and hash components.
  *
+ * @public
  * @category Utils
+ * @param path The URL path to parse.
+ * @returns The parsed pathname, search, and hash components.
  */
 declare function parsePath(path: string): Partial<Path>;
 interface UrlHistory extends History {}