@docusaurus/core 0.0.0-4923 → 0.0.0-4927

package/lib/client/App.d.ts

@@ -5,5 +5,5 @@
  * LICENSE file in the root directory of this source tree.
  */
 /// <reference types="react" />
-import './clientLifecyclesDispatcher';
+import '@generated/client-modules';
 export default function App(): JSX.Element;

package/lib/client/App.js

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
+import '@generated/client-modules';
 import routes from '@generated/routes';
 import { useLocation } from '@docusaurus/router';
 import normalizeLocation from './normalizeLocation';
@@ -16,7 +17,6 @@ import BaseUrlIssueBanner from './BaseUrlIssueBanner';
 import SiteMetadataDefaults from './SiteMetadataDefaults';
 import Root from '@theme/Root';
 import SiteMetadata from '@theme/SiteMetadata';
-import './clientLifecyclesDispatcher';
 // TODO, quick fix for CSS insertion order
 import ErrorBoundary from '@docusaurus/ErrorBoundary';
 import Error from '@theme/Error';
@@ -30,7 +30,7 @@ export default function App() {
             <SiteMetadataDefaults />
             <SiteMetadata />
             <BaseUrlIssueBanner />
-            <PendingNavigation location={normalizeLocation(location)} delay={200}>
+            <PendingNavigation location={normalizeLocation(location)}>
               {routeElement}
             </PendingNavigation>
           </Root>

package/lib/client/ClientLifecyclesDispatcher.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { type ReactElement } from 'react';
+import type { ClientModule } from '@docusaurus/types';
+import type { Location } from 'history';
+export declare function dispatchLifecycleAction<K extends keyof ClientModule>(lifecycleAction: K, ...args: Parameters<NonNullable<ClientModule[K]>>): () => void;
+declare function ClientLifecyclesDispatcher({ children, location, previousLocation, }: {
+    children: ReactElement;
+    location: Location;
+    previousLocation: Location | null;
+}): JSX.Element;
+export default ClientLifecyclesDispatcher;

package/lib/client/ClientLifecyclesDispatcher.js

@@ -0,0 +1,34 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { useLayoutEffect } from 'react';
+import clientModules from '@generated/client-modules';
+export function dispatchLifecycleAction(lifecycleAction, ...args) {
+    const callbacks = clientModules.map((clientModule) => {
+        const lifecycleFunction = (clientModule?.default?.[lifecycleAction] ??
+            clientModule[lifecycleAction]);
+        return lifecycleFunction?.(...args);
+    });
+    return () => callbacks.forEach((cb) => cb?.());
+}
+function ClientLifecyclesDispatcher({ children, location, previousLocation, }) {
+    useLayoutEffect(() => {
+        if (previousLocation !== location) {
+            const { hash } = location;
+            if (!hash) {
+                window.scrollTo(0, 0);
+            }
+            else {
+                const id = decodeURIComponent(hash.substring(1));
+                const element = document.getElementById(id);
+                element?.scrollIntoView();
+            }
+            dispatchLifecycleAction('onRouteDidUpdate', { previousLocation, location });
+        }
+    }, [previousLocation, location]);
+    return children;
+}
+export default ClientLifecyclesDispatcher;

package/lib/client/PendingNavigation.d.ts

@@ -6,9 +6,7 @@
  */
 import React from 'react';
 import type { Location } from 'history';
-import './nprogress.css';
 declare type Props = {
-    readonly delay: number;
     readonly location: Location;
     readonly children: JSX.Element;
 };
@@ -17,12 +15,9 @@ declare type State = {
 };
 declare class PendingNavigation extends React.Component<Props, State> {
     private previousLocation;
-    private progressBarTimeout;
+    private routeUpdateCleanupCb;
     constructor(props: Props);
     shouldComponentUpdate(nextProps: Props, nextState: State): boolean;
-    private clearProgressBarTimeout;
-    private startProgressBar;
-    private stopProgressBar;
     render(): JSX.Element;
 }
 export default PendingNavigation;

package/lib/client/PendingNavigation.js

@@ -6,17 +6,20 @@
  */
 import React from 'react';
 import { Route } from 'react-router-dom';
-import nprogress from 'nprogress';
-import clientLifecyclesDispatcher from './clientLifecyclesDispatcher';
+import ClientLifecyclesDispatcher, { dispatchLifecycleAction, } from './ClientLifecyclesDispatcher';
+import ExecutionEnvironment from './exports/ExecutionEnvironment';
 import preload from './preload';
-import './nprogress.css';
-nprogress.configure({ showSpinner: false });
 class PendingNavigation extends React.Component {
     constructor(props) {
         super(props);
         // previousLocation doesn't affect rendering, hence not stored in state.
         this.previousLocation = null;
-        this.progressBarTimeout = null;
+        this.routeUpdateCleanupCb = ExecutionEnvironment.canUseDOM
+            ? dispatchLifecycleAction('onRouteUpdate', {
+                previousLocation: null,
+                location: this.props.location,
+            })
+            : () => { };
         this.state = {
             nextRouteHasLoaded: true,
         };
@@ -35,52 +38,26 @@ class PendingNavigation extends React.Component {
         // Save the location first.
         this.previousLocation = this.props.location;
         this.setState({ nextRouteHasLoaded: false });
-        this.startProgressBar();
+        this.routeUpdateCleanupCb = dispatchLifecycleAction('onRouteUpdate', {
+            previousLocation: this.previousLocation,
+            location: nextLocation,
+        });
         // Load data while the old screen remains.
         preload(nextLocation.pathname)
             .then(() => {
-            clientLifecyclesDispatcher.onRouteUpdate({
-                previousLocation: this.previousLocation,
-                location: nextLocation,
-            });
-            this.setState({ nextRouteHasLoaded: true }, this.stopProgressBar);
-            const { hash } = nextLocation;
-            if (!hash) {
-                window.scrollTo(0, 0);
-            }
-            else {
-                const id = decodeURIComponent(hash.substring(1));
-                const element = document.getElementById(id);
-                element?.scrollIntoView();
-            }
+            this.routeUpdateCleanupCb?.();
+            this.setState({ nextRouteHasLoaded: true });
         })
             .catch((e) => console.warn(e));
         return false;
     }
-    clearProgressBarTimeout() {
-        if (this.progressBarTimeout) {
-            window.clearTimeout(this.progressBarTimeout);
-            this.progressBarTimeout = null;
-        }
-    }
-    startProgressBar() {
-        this.clearProgressBarTimeout();
-        this.progressBarTimeout = window.setTimeout(() => {
-            clientLifecyclesDispatcher.onRouteUpdateDelayed({
-                location: this.props.location,
-            });
-            nprogress.start();
-        }, this.props.delay);
-    }
-    stopProgressBar() {
-        this.clearProgressBarTimeout();
-        nprogress.done();
-    }
     render() {
         const { children, location } = this.props;
         // Use a controlled <Route> to trick all descendants into rendering the old
         // location.
-        return <Route location={location} render={() => children}/>;
+        return (<ClientLifecyclesDispatcher previousLocation={this.previousLocation} location={location}>
+        <Route location={location} render={() => children}/>
+      </ClientLifecyclesDispatcher>);
     }
 }
 export default PendingNavigation;

package/lib/client/theme-fallback/Error/index.js

@@ -4,6 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+// Should we translate theme-fallback?
+/* eslint-disable @docusaurus/no-untranslated-text */
 import React from 'react';
 import Layout from '@theme/Layout';
 import ErrorBoundary from '@docusaurus/ErrorBoundary';

package/lib/client/theme-fallback/Loading/index.js

@@ -4,6 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+// Should we translate theme-fallback?
+/* eslint-disable @docusaurus/no-untranslated-text */
 import React from 'react';
 export default function Loading({ error, retry, pastDelay, }) {
     if (error) {

package/lib/client/theme-fallback/NotFound/index.js

@@ -4,6 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+// Should we translate theme-fallback?
+/* eslint-disable @docusaurus/no-untranslated-text */
 import React from 'react';
 import Layout from '@theme/Layout';
 import Head from '@docusaurus/Head';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-4923",
+  "version": "0.0.0-4927",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -41,13 +41,13 @@
     "@babel/runtime": "^7.17.9",
     "@babel/runtime-corejs3": "^7.17.9",
     "@babel/traverse": "^7.17.9",
-    "@docusaurus/cssnano-preset": "0.0.0-4923",
-    "@docusaurus/logger": "0.0.0-4923",
-    "@docusaurus/mdx-loader": "0.0.0-4923",
+    "@docusaurus/cssnano-preset": "0.0.0-4927",
+    "@docusaurus/logger": "0.0.0-4927",
+    "@docusaurus/mdx-loader": "0.0.0-4927",
     "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "0.0.0-4923",
-    "@docusaurus/utils-common": "0.0.0-4923",
-    "@docusaurus/utils-validation": "0.0.0-4923",
+    "@docusaurus/utils": "0.0.0-4927",
+    "@docusaurus/utils-common": "0.0.0-4927",
+    "@docusaurus/utils-validation": "0.0.0-4927",
     "@slorber/static-site-generator-webpack-plugin": "^4.0.4",
     "@svgr/webpack": "^6.2.1",
     "autoprefixer": "^10.4.4",
@@ -77,7 +77,6 @@
     "leven": "^3.1.0",
     "lodash": "^4.17.21",
     "mini-css-extract-plugin": "^2.6.0",
-    "nprogress": "^0.2.0",
     "postcss": "^8.4.12",
     "postcss-loader": "^6.2.1",
     "prompts": "^2.4.2",
@@ -105,10 +104,9 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4923",
-    "@docusaurus/types": "0.0.0-4923",
+    "@docusaurus/module-type-aliases": "0.0.0-4927",
+    "@docusaurus/types": "0.0.0-4927",
     "@types/detect-port": "^1.3.2",
-    "@types/nprogress": "^0.2.0",
     "@types/react-dom": "^18.0.2",
     "@types/react-router-config": "^5.0.6",
     "@types/rtl-detect": "^1.0.0",
@@ -127,5 +125,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "0d7f61e267384e2c272cc3c0df059bdfe16609fd"
+  "gitHead": "1c97d81e5046a346360d7c79d5c1e715b37a94d9"
 }

package/lib/client/clientLifecyclesDispatcher.d.ts

@@ -1,9 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import type { ClientModule } from '@docusaurus/types';
-declare const clientLifecyclesDispatchers: Required<ClientModule>;
-export default clientLifecyclesDispatchers;

package/lib/client/clientLifecyclesDispatcher.js

@@ -1,23 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import clientModules from '@generated/client-modules';
-function dispatchLifecycleAction(lifecycleAction, args) {
-    clientModules.forEach((clientModule) => {
-        const lifecycleFunction = (clientModule?.default?.[lifecycleAction] ??
-            clientModule[lifecycleAction]);
-        lifecycleFunction?.(...args);
-    });
-}
-const clientLifecyclesDispatchers = {
-    onRouteUpdate(...args) {
-        dispatchLifecycleAction('onRouteUpdate', args);
-    },
-    onRouteUpdateDelayed(...args) {
-        dispatchLifecycleAction('onRouteUpdateDelayed', args);
-    },
-};
-export default clientLifecyclesDispatchers;

package/lib/client/nprogress.css

@@ -1,36 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-/**
- * Styles for NProgress
- * Copied over to remove unused styles for the spinner.
- * https://github.com/rstacruz/nprogress/blob/master/nprogress.css
- */
-
-#nprogress {
-  pointer-events: none;
-}
-
-#nprogress .bar {
-  background: #29d;
-  position: fixed;
-  z-index: 1031;
-  top: 0;
-  left: 0;
-  width: 100%;
-  height: 2px;
-}
-
-#nprogress .peg {
-  position: absolute;
-  right: 0;
-  width: 100px;
-  height: 100%;
-  box-shadow: 0 0 10px #29d, 0 0 5px #29d;
-  opacity: 1;
-  transform: rotate(3deg) translate(0, -4px);
-}