123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984 |
- /**
- * React Router DOM v6.8.1
- *
- * Copyright (c) Remix Software Inc.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE.md file in the root directory of this source tree.
- *
- * @license MIT
- */
- import * as React from 'react';
- import { UNSAFE_enhanceManualRouteObjects, Router, useHref, useResolvedPath, useLocation, UNSAFE_DataRouterStateContext, UNSAFE_NavigationContext, useNavigate, createPath, UNSAFE_RouteContext, useMatches, useNavigation, unstable_useBlocker, UNSAFE_DataRouterContext } from 'react-router';
- export { AbortedDeferredError, Await, MemoryRouter, Navigate, NavigationType, Outlet, Route, Router, RouterProvider, Routes, UNSAFE_DataRouterContext, UNSAFE_DataRouterStateContext, UNSAFE_LocationContext, UNSAFE_NavigationContext, UNSAFE_RouteContext, UNSAFE_enhanceManualRouteObjects, createMemoryRouter, createPath, createRoutesFromChildren, createRoutesFromElements, defer, generatePath, isRouteErrorResponse, json, matchPath, matchRoutes, parsePath, redirect, renderMatches, resolvePath, unstable_useBlocker, useActionData, useAsyncError, useAsyncValue, useHref, useInRouterContext, useLoaderData, useLocation, useMatch, useMatches, useNavigate, useNavigation, useNavigationType, useOutlet, useOutletContext, useParams, useResolvedPath, useRevalidator, useRouteError, useRouteLoaderData, useRoutes } from 'react-router';
- import { createRouter, createBrowserHistory, createHashHistory, ErrorResponse, invariant, joinPaths } from '@remix-run/router';
- const defaultMethod = "get";
- const defaultEncType = "application/x-www-form-urlencoded";
- function isHtmlElement(object) {
- return object != null && typeof object.tagName === "string";
- }
- function isButtonElement(object) {
- return isHtmlElement(object) && object.tagName.toLowerCase() === "button";
- }
- function isFormElement(object) {
- return isHtmlElement(object) && object.tagName.toLowerCase() === "form";
- }
- function isInputElement(object) {
- return isHtmlElement(object) && object.tagName.toLowerCase() === "input";
- }
- function isModifiedEvent(event) {
- return !!(event.metaKey || event.altKey || event.ctrlKey || event.shiftKey);
- }
- function shouldProcessLinkClick(event, target) {
- return event.button === 0 && ( // Ignore everything but left clicks
- !target || target === "_self") && // Let browser handle "target=_blank" etc.
- !isModifiedEvent(event) // Ignore clicks with modifier keys
- ;
- }
- /**
- * 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:
- *
- * let searchParams = new URLSearchParams([
- * ['sort', 'name'],
- * ['sort', 'price']
- * ]);
- *
- * you can do:
- *
- * let searchParams = createSearchParams({
- * sort: ['name', 'price']
- * });
- */
- function createSearchParams(init = "") {
- return new URLSearchParams(typeof init === "string" || Array.isArray(init) || init instanceof URLSearchParams ? init : Object.keys(init).reduce((memo, key) => {
- let value = init[key];
- return memo.concat(Array.isArray(value) ? value.map(v => [key, v]) : [[key, value]]);
- }, []));
- }
- function getSearchParamsForLocation(locationSearch, defaultSearchParams) {
- let searchParams = createSearchParams(locationSearch);
- if (defaultSearchParams) {
- for (let key of defaultSearchParams.keys()) {
- if (!searchParams.has(key)) {
- defaultSearchParams.getAll(key).forEach(value => {
- searchParams.append(key, value);
- });
- }
- }
- }
- return searchParams;
- }
- function getFormSubmissionInfo(target, defaultAction, options) {
- let method;
- let action;
- let encType;
- let formData;
- if (isFormElement(target)) {
- let submissionTrigger = options.submissionTrigger;
- method = options.method || target.getAttribute("method") || defaultMethod;
- action = options.action || target.getAttribute("action") || defaultAction;
- encType = options.encType || target.getAttribute("enctype") || defaultEncType;
- formData = new FormData(target);
- if (submissionTrigger && submissionTrigger.name) {
- formData.append(submissionTrigger.name, submissionTrigger.value);
- }
- } else if (isButtonElement(target) || isInputElement(target) && (target.type === "submit" || target.type === "image")) {
- let form = target.form;
- if (form == null) {
- throw new Error(`Cannot submit a <button> or <input type="submit"> without a <form>`);
- } // <button>/<input type="submit"> may override attributes of <form>
- method = options.method || target.getAttribute("formmethod") || form.getAttribute("method") || defaultMethod;
- action = options.action || target.getAttribute("formaction") || form.getAttribute("action") || defaultAction;
- encType = options.encType || target.getAttribute("formenctype") || form.getAttribute("enctype") || defaultEncType;
- formData = new FormData(form); // Include name + value from a <button>, appending in case the button name
- // matches an existing input name
- if (target.name) {
- formData.append(target.name, target.value);
- }
- } else if (isHtmlElement(target)) {
- throw new Error(`Cannot submit element that is not <form>, <button>, or ` + `<input type="submit|image">`);
- } else {
- method = options.method || defaultMethod;
- action = options.action || defaultAction;
- encType = options.encType || defaultEncType;
- if (target instanceof FormData) {
- formData = target;
- } else {
- formData = new FormData();
- if (target instanceof URLSearchParams) {
- for (let [name, value] of target) {
- formData.append(name, value);
- }
- } else if (target != null) {
- for (let name of Object.keys(target)) {
- formData.append(name, target[name]);
- }
- }
- }
- }
- let {
- protocol,
- host
- } = window.location;
- let url = new URL(action, `${protocol}//${host}`);
- return {
- url,
- method: method.toLowerCase(),
- encType,
- formData
- };
- }
- /**
- * NOTE: If you refactor this to split up the modules into separate files,
- * you'll need to update the rollup config for react-router-dom-v5-compat.
- */
- ////////////////////////////////////////////////////////////////////////////////
- //#region Routers
- ////////////////////////////////////////////////////////////////////////////////
- function createBrowserRouter(routes, opts) {
- return createRouter({
- basename: opts?.basename,
- history: createBrowserHistory({
- window: opts?.window
- }),
- hydrationData: opts?.hydrationData || parseHydrationData(),
- routes: UNSAFE_enhanceManualRouteObjects(routes)
- }).initialize();
- }
- function createHashRouter(routes, opts) {
- return createRouter({
- basename: opts?.basename,
- history: createHashHistory({
- window: opts?.window
- }),
- hydrationData: opts?.hydrationData || parseHydrationData(),
- routes: UNSAFE_enhanceManualRouteObjects(routes)
- }).initialize();
- }
- function parseHydrationData() {
- let state = window?.__staticRouterHydrationData;
- if (state && state.errors) {
- state = { ...state,
- errors: deserializeErrors(state.errors)
- };
- }
- return state;
- }
- function deserializeErrors(errors) {
- if (!errors) return null;
- let entries = Object.entries(errors);
- let serialized = {};
- for (let [key, val] of entries) {
- // Hey you! If you change this, please change the corresponding logic in
- // serializeErrors in react-router-dom/server.tsx :)
- if (val && val.__type === "RouteErrorResponse") {
- serialized[key] = new ErrorResponse(val.status, val.statusText, val.data, val.internal === true);
- } else if (val && val.__type === "Error") {
- let error = new Error(val.message); // Wipe away the client-side stack trace. Nothing to fill it in with
- // because we don't serialize SSR stack traces for security reasons
- error.stack = "";
- serialized[key] = error;
- } else {
- serialized[key] = val;
- }
- }
- return serialized;
- } //#endregion
- ////////////////////////////////////////////////////////////////////////////////
- //#region Components
- ////////////////////////////////////////////////////////////////////////////////
- /**
- * A `<Router>` for use in web browsers. Provides the cleanest URLs.
- */
- function BrowserRouter({
- basename,
- children,
- window
- }) {
- let historyRef = React.useRef();
- if (historyRef.current == null) {
- historyRef.current = createBrowserHistory({
- window,
- v5Compat: true
- });
- }
- let history = historyRef.current;
- let [state, setState] = React.useState({
- action: history.action,
- location: history.location
- });
- React.useLayoutEffect(() => history.listen(setState), [history]);
- return /*#__PURE__*/React.createElement(Router, {
- basename: basename,
- children: children,
- location: state.location,
- navigationType: state.action,
- navigator: history
- });
- }
- /**
- * A `<Router>` for use in web browsers. Stores the location in the hash
- * portion of the URL so it is not sent to the server.
- */
- function HashRouter({
- basename,
- children,
- window
- }) {
- let historyRef = React.useRef();
- if (historyRef.current == null) {
- historyRef.current = createHashHistory({
- window,
- v5Compat: true
- });
- }
- let history = historyRef.current;
- let [state, setState] = React.useState({
- action: history.action,
- location: history.location
- });
- React.useLayoutEffect(() => history.listen(setState), [history]);
- return /*#__PURE__*/React.createElement(Router, {
- basename: basename,
- children: children,
- location: state.location,
- navigationType: state.action,
- navigator: history
- });
- }
- /**
- * A `<Router>` that accepts a pre-instantiated history object. It's important
- * to note that using your own history object is highly discouraged and may add
- * two versions of the history library to your bundles unless you use the same
- * version of the history library that React Router uses internally.
- */
- function HistoryRouter({
- basename,
- children,
- history
- }) {
- const [state, setState] = React.useState({
- action: history.action,
- location: history.location
- });
- React.useLayoutEffect(() => history.listen(setState), [history]);
- return /*#__PURE__*/React.createElement(Router, {
- basename: basename,
- children: children,
- location: state.location,
- navigationType: state.action,
- navigator: history
- });
- }
- {
- HistoryRouter.displayName = "unstable_HistoryRouter";
- }
- const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined" && typeof window.document.createElement !== "undefined";
- /**
- * The public API for rendering a history-aware <a>.
- */
- const Link = /*#__PURE__*/React.forwardRef(function LinkWithRef({
- onClick,
- relative,
- reloadDocument,
- replace,
- state,
- target,
- to,
- preventScrollReset,
- ...rest
- }, ref) {
- // Rendered into <a href> for absolute URLs
- let absoluteHref;
- let isExternal = false;
- if (isBrowser && typeof to === "string" && /^(?:[a-z][a-z0-9+.-]*:|\/\/)/i.test(to)) {
- absoluteHref = to;
- let currentUrl = new URL(window.location.href);
- let targetUrl = to.startsWith("//") ? new URL(currentUrl.protocol + to) : new URL(to);
- if (targetUrl.origin === currentUrl.origin) {
- // Strip the protocol/origin for same-origin absolute URLs
- to = targetUrl.pathname + targetUrl.search + targetUrl.hash;
- } else {
- isExternal = true;
- }
- } // Rendered into <a href> for relative URLs
- let href = useHref(to, {
- relative
- });
- let internalOnClick = useLinkClickHandler(to, {
- replace,
- state,
- target,
- preventScrollReset,
- relative
- });
- function handleClick(event) {
- if (onClick) onClick(event);
- if (!event.defaultPrevented) {
- internalOnClick(event);
- }
- }
- return (
- /*#__PURE__*/
- // eslint-disable-next-line jsx-a11y/anchor-has-content
- React.createElement("a", Object.assign({}, rest, {
- href: absoluteHref || href,
- onClick: isExternal || reloadDocument ? onClick : handleClick,
- ref: ref,
- target: target
- }))
- );
- });
- {
- Link.displayName = "Link";
- }
- /**
- * A <Link> wrapper that knows if it's "active" or not.
- */
- const NavLink = /*#__PURE__*/React.forwardRef(function NavLinkWithRef({
- "aria-current": ariaCurrentProp = "page",
- caseSensitive = false,
- className: classNameProp = "",
- end = false,
- style: styleProp,
- to,
- children,
- ...rest
- }, ref) {
- let path = useResolvedPath(to, {
- relative: rest.relative
- });
- let location = useLocation();
- let routerState = React.useContext(UNSAFE_DataRouterStateContext);
- let {
- navigator
- } = React.useContext(UNSAFE_NavigationContext);
- let toPathname = navigator.encodeLocation ? navigator.encodeLocation(path).pathname : path.pathname;
- let locationPathname = location.pathname;
- let nextLocationPathname = routerState && routerState.navigation && routerState.navigation.location ? routerState.navigation.location.pathname : null;
- if (!caseSensitive) {
- locationPathname = locationPathname.toLowerCase();
- nextLocationPathname = nextLocationPathname ? nextLocationPathname.toLowerCase() : null;
- toPathname = toPathname.toLowerCase();
- }
- let isActive = locationPathname === toPathname || !end && locationPathname.startsWith(toPathname) && locationPathname.charAt(toPathname.length) === "/";
- let isPending = nextLocationPathname != null && (nextLocationPathname === toPathname || !end && nextLocationPathname.startsWith(toPathname) && nextLocationPathname.charAt(toPathname.length) === "/");
- let ariaCurrent = isActive ? ariaCurrentProp : undefined;
- let className;
- if (typeof classNameProp === "function") {
- className = classNameProp({
- isActive,
- isPending
- });
- } else {
- // If the className prop is not a function, we use a default `active`
- // class for <NavLink />s that are active. In v5 `active` was the default
- // value for `activeClassName`, but we are removing that API and can still
- // use the old default behavior for a cleaner upgrade path and keep the
- // simple styling rules working as they currently do.
- className = [classNameProp, isActive ? "active" : null, isPending ? "pending" : null].filter(Boolean).join(" ");
- }
- let style = typeof styleProp === "function" ? styleProp({
- isActive,
- isPending
- }) : styleProp;
- return /*#__PURE__*/React.createElement(Link, Object.assign({}, rest, {
- "aria-current": ariaCurrent,
- className: className,
- ref: ref,
- style: style,
- to: to
- }), typeof children === "function" ? children({
- isActive,
- isPending
- }) : children);
- });
- {
- NavLink.displayName = "NavLink";
- }
- /**
- * A `@remix-run/router`-aware `<form>`. It behaves like a normal form except
- * that the interaction with the server is with `fetch` instead of new document
- * requests, allowing components to add nicer UX to the page as the form is
- * submitted and returns with data.
- */
- const Form = /*#__PURE__*/React.forwardRef((props, ref) => {
- return /*#__PURE__*/React.createElement(FormImpl, Object.assign({}, props, {
- ref: ref
- }));
- });
- {
- Form.displayName = "Form";
- }
- const FormImpl = /*#__PURE__*/React.forwardRef(({
- reloadDocument,
- replace,
- method: _method = defaultMethod,
- action,
- onSubmit,
- fetcherKey,
- routeId,
- relative,
- preventScrollReset,
- ...props
- }, forwardedRef) => {
- let submit = useSubmitImpl(fetcherKey, routeId);
- let formMethod = _method.toLowerCase() === "get" ? "get" : "post";
- let formAction = useFormAction(action, {
- relative
- });
- let submitHandler = event => {
- onSubmit && onSubmit(event);
- if (event.defaultPrevented) return;
- event.preventDefault();
- let submitter = event.nativeEvent.submitter;
- let submitMethod = submitter?.getAttribute("formmethod") || _method;
- submit(submitter || event.currentTarget, {
- method: submitMethod,
- replace,
- relative,
- preventScrollReset
- });
- };
- return /*#__PURE__*/React.createElement("form", Object.assign({
- ref: forwardedRef,
- method: formMethod,
- action: formAction,
- onSubmit: reloadDocument ? onSubmit : submitHandler
- }, props));
- });
- {
- FormImpl.displayName = "FormImpl";
- }
- /**
- * This component will emulate the browser's scroll restoration on location
- * changes.
- */
- function ScrollRestoration({
- getKey,
- storageKey
- }) {
- useScrollRestoration({
- getKey,
- storageKey
- });
- return null;
- }
- {
- ScrollRestoration.displayName = "ScrollRestoration";
- } //#endregion
- ////////////////////////////////////////////////////////////////////////////////
- //#region Hooks
- ////////////////////////////////////////////////////////////////////////////////
- var DataRouterHook;
- (function (DataRouterHook) {
- DataRouterHook["UseScrollRestoration"] = "useScrollRestoration";
- DataRouterHook["UseSubmitImpl"] = "useSubmitImpl";
- DataRouterHook["UseFetcher"] = "useFetcher";
- })(DataRouterHook || (DataRouterHook = {}));
- var DataRouterStateHook;
- (function (DataRouterStateHook) {
- DataRouterStateHook["UseFetchers"] = "useFetchers";
- DataRouterStateHook["UseScrollRestoration"] = "useScrollRestoration";
- })(DataRouterStateHook || (DataRouterStateHook = {}));
- function getDataRouterConsoleError(hookName) {
- return `${hookName} must be used within a data router. See https://reactrouter.com/routers/picking-a-router.`;
- }
- function useDataRouterContext(hookName) {
- let ctx = React.useContext(UNSAFE_DataRouterContext);
- !ctx ? invariant(false, getDataRouterConsoleError(hookName)) : void 0;
- return ctx;
- }
- function useDataRouterState(hookName) {
- let state = React.useContext(UNSAFE_DataRouterStateContext);
- !state ? invariant(false, getDataRouterConsoleError(hookName)) : void 0;
- return state;
- }
- /**
- * Handles the click behavior for router `<Link>` components. This is useful if
- * you need to create custom `<Link>` components with the same click behavior we
- * use in our exported `<Link>`.
- */
- function useLinkClickHandler(to, {
- target,
- replace: replaceProp,
- state,
- preventScrollReset,
- relative
- } = {}) {
- let navigate = useNavigate();
- let location = useLocation();
- let path = useResolvedPath(to, {
- relative
- });
- return React.useCallback(event => {
- if (shouldProcessLinkClick(event, target)) {
- event.preventDefault(); // If the URL hasn't changed, a regular <a> will do a replace instead of
- // a push, so do the same here unless the replace prop is explicitly set
- let replace = replaceProp !== undefined ? replaceProp : createPath(location) === createPath(path);
- navigate(to, {
- replace,
- state,
- preventScrollReset,
- relative
- });
- }
- }, [location, navigate, path, replaceProp, state, target, to, preventScrollReset, relative]);
- }
- /**
- * A convenient wrapper for reading and writing search parameters via the
- * URLSearchParams interface.
- */
- function useSearchParams(defaultInit) {
- warning(typeof URLSearchParams !== "undefined", `You cannot use the \`useSearchParams\` hook in a browser that does not ` + `support the URLSearchParams API. If you need to support Internet ` + `Explorer 11, we recommend you load a polyfill such as ` + `https://github.com/ungap/url-search-params\n\n` + `If you're unsure how to load polyfills, we recommend you check out ` + `https://polyfill.io/v3/ which provides some recommendations about how ` + `to load polyfills only for users that need them, instead of for every ` + `user.`) ;
- let defaultSearchParamsRef = React.useRef(createSearchParams(defaultInit));
- let hasSetSearchParamsRef = React.useRef(false);
- let location = useLocation();
- let searchParams = React.useMemo(() => // Only merge in the defaults if we haven't yet called setSearchParams.
- // Once we call that we want those to take precedence, otherwise you can't
- // remove a param with setSearchParams({}) if it has an initial value
- getSearchParamsForLocation(location.search, hasSetSearchParamsRef.current ? null : defaultSearchParamsRef.current), [location.search]);
- let navigate = useNavigate();
- let setSearchParams = React.useCallback((nextInit, navigateOptions) => {
- const newSearchParams = createSearchParams(typeof nextInit === "function" ? nextInit(searchParams) : nextInit);
- hasSetSearchParamsRef.current = true;
- navigate("?" + newSearchParams, navigateOptions);
- }, [navigate, searchParams]);
- return [searchParams, setSearchParams];
- }
- /**
- * Returns a function that may be used to programmatically submit a form (or
- * some arbitrary data) to the server.
- */
- function useSubmit() {
- return useSubmitImpl();
- }
- function useSubmitImpl(fetcherKey, routeId) {
- let {
- router
- } = useDataRouterContext(DataRouterHook.UseSubmitImpl);
- let defaultAction = useFormAction();
- return React.useCallback((target, options = {}) => {
- if (typeof document === "undefined") {
- throw new Error("You are calling submit during the server render. " + "Try calling submit within a `useEffect` or callback instead.");
- }
- let {
- method,
- encType,
- formData,
- url
- } = getFormSubmissionInfo(target, defaultAction, options);
- let href = url.pathname + url.search;
- let opts = {
- replace: options.replace,
- preventScrollReset: options.preventScrollReset,
- formData,
- formMethod: method,
- formEncType: encType
- };
- if (fetcherKey) {
- !(routeId != null) ? invariant(false, "No routeId available for useFetcher()") : void 0;
- router.fetch(fetcherKey, routeId, href, opts);
- } else {
- router.navigate(href, opts);
- }
- }, [defaultAction, router, fetcherKey, routeId]);
- }
- function useFormAction(action, {
- relative
- } = {}) {
- let {
- basename
- } = React.useContext(UNSAFE_NavigationContext);
- let routeContext = React.useContext(UNSAFE_RouteContext);
- !routeContext ? invariant(false, "useFormAction must be used inside a RouteContext") : void 0;
- let [match] = routeContext.matches.slice(-1); // Shallow clone path so we can modify it below, otherwise we modify the
- // object referenced by useMemo inside useResolvedPath
- let path = { ...useResolvedPath(action ? action : ".", {
- relative
- })
- }; // Previously we set the default action to ".". The problem with this is that
- // `useResolvedPath(".")` excludes search params and the hash of the resolved
- // URL. This is the intended behavior of when "." is specifically provided as
- // the form action, but inconsistent w/ browsers when the action is omitted.
- // https://github.com/remix-run/remix/issues/927
- let location = useLocation();
- if (action == null) {
- // Safe to write to these directly here since if action was undefined, we
- // would have called useResolvedPath(".") which will never include a search
- // or hash
- path.search = location.search;
- path.hash = location.hash; // When grabbing search params from the URL, remove the automatically
- // inserted ?index param so we match the useResolvedPath search behavior
- // which would not include ?index
- if (match.route.index) {
- let params = new URLSearchParams(path.search);
- params.delete("index");
- path.search = params.toString() ? `?${params.toString()}` : "";
- }
- }
- if ((!action || action === ".") && match.route.index) {
- path.search = path.search ? path.search.replace(/^\?/, "?index&") : "?index";
- } // If we're operating within a basename, prepend it to the pathname prior
- // to creating the form action. If this is a root navigation, then just use
- // the raw basename which allows the basename to have full control over the
- // presence of a trailing slash on root actions
- if (basename !== "/") {
- path.pathname = path.pathname === "/" ? basename : joinPaths([basename, path.pathname]);
- }
- return createPath(path);
- }
- function createFetcherForm(fetcherKey, routeId) {
- let FetcherForm = /*#__PURE__*/React.forwardRef((props, ref) => {
- return /*#__PURE__*/React.createElement(FormImpl, Object.assign({}, props, {
- ref: ref,
- fetcherKey: fetcherKey,
- routeId: routeId
- }));
- });
- {
- FetcherForm.displayName = "fetcher.Form";
- }
- return FetcherForm;
- }
- let fetcherId = 0;
- /**
- * Interacts with route loaders and actions without causing a navigation. Great
- * for any interaction that stays on the same page.
- */
- function useFetcher() {
- let {
- router
- } = useDataRouterContext(DataRouterHook.UseFetcher);
- let route = React.useContext(UNSAFE_RouteContext);
- !route ? invariant(false, `useFetcher must be used inside a RouteContext`) : void 0;
- let routeId = route.matches[route.matches.length - 1]?.route.id;
- !(routeId != null) ? invariant(false, `useFetcher can only be used on routes that contain a unique "id"`) : void 0;
- let [fetcherKey] = React.useState(() => String(++fetcherId));
- let [Form] = React.useState(() => {
- !routeId ? invariant(false, `No routeId available for fetcher.Form()`) : void 0;
- return createFetcherForm(fetcherKey, routeId);
- });
- let [load] = React.useState(() => href => {
- !router ? invariant(false, "No router available for fetcher.load()") : void 0;
- !routeId ? invariant(false, "No routeId available for fetcher.load()") : void 0;
- router.fetch(fetcherKey, routeId, href);
- });
- let submit = useSubmitImpl(fetcherKey, routeId);
- let fetcher = router.getFetcher(fetcherKey);
- let fetcherWithComponents = React.useMemo(() => ({
- Form,
- submit,
- load,
- ...fetcher
- }), [fetcher, Form, submit, load]);
- React.useEffect(() => {
- // Is this busted when the React team gets real weird and calls effects
- // twice on mount? We really just need to garbage collect here when this
- // fetcher is no longer around.
- return () => {
- if (!router) {
- console.warn(`No fetcher available to clean up from useFetcher()`);
- return;
- }
- router.deleteFetcher(fetcherKey);
- };
- }, [router, fetcherKey]);
- return fetcherWithComponents;
- }
- /**
- * Provides all fetchers currently on the page. Useful for layouts and parent
- * routes that need to provide pending/optimistic UI regarding the fetch.
- */
- function useFetchers() {
- let state = useDataRouterState(DataRouterStateHook.UseFetchers);
- return [...state.fetchers.values()];
- }
- const SCROLL_RESTORATION_STORAGE_KEY = "react-router-scroll-positions";
- let savedScrollPositions = {};
- /**
- * When rendered inside a RouterProvider, will restore scroll positions on navigations
- */
- function useScrollRestoration({
- getKey,
- storageKey
- } = {}) {
- let {
- router
- } = useDataRouterContext(DataRouterHook.UseScrollRestoration);
- let {
- restoreScrollPosition,
- preventScrollReset
- } = useDataRouterState(DataRouterStateHook.UseScrollRestoration);
- let location = useLocation();
- let matches = useMatches();
- let navigation = useNavigation(); // Trigger manual scroll restoration while we're active
- React.useEffect(() => {
- window.history.scrollRestoration = "manual";
- return () => {
- window.history.scrollRestoration = "auto";
- };
- }, []); // Save positions on pagehide
- usePageHide(React.useCallback(() => {
- if (navigation.state === "idle") {
- let key = (getKey ? getKey(location, matches) : null) || location.key;
- savedScrollPositions[key] = window.scrollY;
- }
- sessionStorage.setItem(storageKey || SCROLL_RESTORATION_STORAGE_KEY, JSON.stringify(savedScrollPositions));
- window.history.scrollRestoration = "auto";
- }, [storageKey, getKey, navigation.state, location, matches])); // Read in any saved scroll locations
- if (typeof document !== "undefined") {
- // eslint-disable-next-line react-hooks/rules-of-hooks
- React.useLayoutEffect(() => {
- try {
- let sessionPositions = sessionStorage.getItem(storageKey || SCROLL_RESTORATION_STORAGE_KEY);
- if (sessionPositions) {
- savedScrollPositions = JSON.parse(sessionPositions);
- }
- } catch (e) {// no-op, use default empty object
- }
- }, [storageKey]); // Enable scroll restoration in the router
- // eslint-disable-next-line react-hooks/rules-of-hooks
- React.useLayoutEffect(() => {
- let disableScrollRestoration = router?.enableScrollRestoration(savedScrollPositions, () => window.scrollY, getKey);
- return () => disableScrollRestoration && disableScrollRestoration();
- }, [router, getKey]); // Restore scrolling when state.restoreScrollPosition changes
- // eslint-disable-next-line react-hooks/rules-of-hooks
- React.useLayoutEffect(() => {
- // Explicit false means don't do anything (used for submissions)
- if (restoreScrollPosition === false) {
- return;
- } // been here before, scroll to it
- if (typeof restoreScrollPosition === "number") {
- window.scrollTo(0, restoreScrollPosition);
- return;
- } // try to scroll to the hash
- if (location.hash) {
- let el = document.getElementById(location.hash.slice(1));
- if (el) {
- el.scrollIntoView();
- return;
- }
- } // Don't reset if this navigation opted out
- if (preventScrollReset === true) {
- return;
- } // otherwise go to the top on new locations
- window.scrollTo(0, 0);
- }, [location, restoreScrollPosition, preventScrollReset]);
- }
- }
- /**
- * Setup a callback to be fired on the window's `beforeunload` event. This is
- * useful for saving some data to `window.localStorage` just before the page
- * refreshes.
- *
- * Note: The `callback` argument should be a function created with
- * `React.useCallback()`.
- */
- function useBeforeUnload(callback, options) {
- let {
- capture
- } = options || {};
- React.useEffect(() => {
- let opts = capture != null ? {
- capture
- } : undefined;
- window.addEventListener("beforeunload", callback, opts);
- return () => {
- window.removeEventListener("beforeunload", callback, opts);
- };
- }, [callback, capture]);
- }
- /**
- * Setup a callback to be fired on the window's `pagehide` event. This is
- * useful for saving some data to `window.localStorage` just before the page
- * refreshes. This event is better supported than beforeunload across browsers.
- *
- * Note: The `callback` argument should be a function created with
- * `React.useCallback()`.
- */
- function usePageHide(callback, options) {
- let {
- capture
- } = options || {};
- React.useEffect(() => {
- let opts = capture != null ? {
- capture
- } : undefined;
- window.addEventListener("pagehide", callback, opts);
- return () => {
- window.removeEventListener("pagehide", callback, opts);
- };
- }, [callback, capture]);
- }
- /**
- * Wrapper around useBlocker to show a window.confirm prompt to users instead
- * of building a custom UI with useBlocker.
- *
- * Warning: This has *a lot of rough edges* and behaves very differently (and
- * very incorrectly in some cases) across browsers if user click addition
- * back/forward navigations while the confirm is open. Use at your own risk.
- */
- function usePrompt({
- when,
- message
- }) {
- let blocker = unstable_useBlocker(when);
- React.useEffect(() => {
- if (blocker.state === "blocked" && !when) {
- blocker.reset();
- }
- }, [blocker, when]);
- React.useEffect(() => {
- if (blocker.state === "blocked") {
- let proceed = window.confirm(message);
- if (proceed) {
- setTimeout(blocker.proceed, 0);
- } else {
- blocker.reset();
- }
- }
- }, [blocker, message]);
- }
- ////////////////////////////////////////////////////////////////////////////////
- //#region Utils
- ////////////////////////////////////////////////////////////////////////////////
- function warning(cond, message) {
- if (!cond) {
- // eslint-disable-next-line no-console
- if (typeof console !== "undefined") console.warn(message);
- try {
- // Welcome to debugging React Router!
- //
- // This error is thrown as a convenience so you can more easily
- // find the source for a warning that appears in the console by
- // enabling "pause on exceptions" in your JavaScript debugger.
- throw new Error(message); // eslint-disable-next-line no-empty
- } catch (e) {}
- }
- } //#endregion
- export { BrowserRouter, Form, HashRouter, Link, NavLink, ScrollRestoration, useScrollRestoration as UNSAFE_useScrollRestoration, createBrowserRouter, createHashRouter, createSearchParams, HistoryRouter as unstable_HistoryRouter, usePrompt as unstable_usePrompt, useBeforeUnload, useFetcher, useFetchers, useFormAction, useLinkClickHandler, useSearchParams, useSubmit };
- //# sourceMappingURL=react-router-dom.development.js.map
|