@docusaurus/theme-classic 0.0.0-4923 → 0.0.0-4924

package/lib/index.js

@@ -156,7 +156,7 @@ function docusaurusThemeClassic(context, options) {
     },
 
     getClientModules() {
-      const modules = [require.resolve(getInfimaCSSFile(direction)), './prism-include-languages', './admonitions.css'];
+      const modules = [require.resolve(getInfimaCSSFile(direction)), './prism-include-languages', './admonitions.css', './nprogress'];
 
       if (customCss) {
         if (Array.isArray(customCss)) {

package/lib/nprogress.css

@@ -0,0 +1,41 @@
+/**
+ * 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
+ */
+
+:root {
+  --docusaurus-progress-bar-color: var(--ifm-color-primary);
+}
+
+#nprogress {
+  pointer-events: none;
+}
+
+#nprogress .bar {
+  background: var(--docusaurus-progress-bar-color);
+  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 var(--docusaurus-progress-bar-color),
+    0 0 5px var(--docusaurus-progress-bar-color);
+  opacity: 1;
+  transform: rotate(3deg) translate(0, -4px);
+}

package/lib/nprogress.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _nprogress = _interopRequireDefault(require("nprogress"));
+
+require("./nprogress.css");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * 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.
+ */
+_nprogress.default.configure({
+  showSpinner: false
+});
+
+const delay = 200;
+const clientModule = {
+  onRouteUpdate({
+    location,
+    previousLocation
+  }) {
+    if (previousLocation && location.pathname !== previousLocation.pathname) {
+      const progressBarTimeout = window.setTimeout(() => {
+        _nprogress.default.start();
+      }, delay);
+      return () => window.clearTimeout(progressBarTimeout);
+    }
+
+    return undefined;
+  },
+
+  onRouteDidUpdate() {
+    _nprogress.default.done();
+  }
+
+};
+var _default = clientModule;
+exports.default = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "0.0.0-4923",
+  "version": "0.0.0-4924",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
   "types": "src/theme-classic.d.ts",
@@ -21,20 +21,21 @@
     "format:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4923",
-    "@docusaurus/plugin-content-blog": "0.0.0-4923",
-    "@docusaurus/plugin-content-docs": "0.0.0-4923",
-    "@docusaurus/plugin-content-pages": "0.0.0-4923",
-    "@docusaurus/theme-common": "0.0.0-4923",
-    "@docusaurus/theme-translations": "0.0.0-4923",
-    "@docusaurus/utils": "0.0.0-4923",
-    "@docusaurus/utils-common": "0.0.0-4923",
-    "@docusaurus/utils-validation": "0.0.0-4923",
+    "@docusaurus/core": "0.0.0-4924",
+    "@docusaurus/plugin-content-blog": "0.0.0-4924",
+    "@docusaurus/plugin-content-docs": "0.0.0-4924",
+    "@docusaurus/plugin-content-pages": "0.0.0-4924",
+    "@docusaurus/theme-common": "0.0.0-4924",
+    "@docusaurus/theme-translations": "0.0.0-4924",
+    "@docusaurus/utils": "0.0.0-4924",
+    "@docusaurus/utils-common": "0.0.0-4924",
+    "@docusaurus/utils-validation": "0.0.0-4924",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.0.1",
     "infima": "0.2.0-alpha.38",
     "lodash": "^4.17.21",
+    "nprogress": "^0.2.0",
     "postcss": "^8.4.12",
     "prism-react-renderer": "^1.3.1",
     "prismjs": "^1.28.0",
@@ -45,9 +46,10 @@
     "@babel/cli": "^7.17.6",
     "@babel/core": "^7.17.9",
     "@babel/preset-typescript": "^7.16.7",
-    "@docusaurus/module-type-aliases": "0.0.0-4923",
-    "@docusaurus/types": "0.0.0-4923",
+    "@docusaurus/module-type-aliases": "0.0.0-4924",
+    "@docusaurus/types": "0.0.0-4924",
     "@types/mdx-js__react": "^1.5.5",
+    "@types/nprogress": "^0.2.0",
     "@types/prismjs": "^1.26.0",
     "@types/rtlcss": "^3.1.4",
     "cross-env": "^7.0.3",
@@ -62,5 +64,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "0d7f61e267384e2c272cc3c0df059bdfe16609fd"
+  "gitHead": "9a5e4f9e3588967ccfb235a808f4bfc1447e403c"
 }

package/src/index.ts

@@ -138,6 +138,7 @@ export default function docusaurusThemeClassic(
         require.resolve(getInfimaCSSFile(direction)),
         './prism-include-languages',
         './admonitions.css',
+        './nprogress',
       ];
 
       if (customCss) {

package/src/nprogress.css

@@ -0,0 +1,41 @@
+/**
+ * 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
+ */
+
+:root {
+  --docusaurus-progress-bar-color: var(--ifm-color-primary);
+}
+
+#nprogress {
+  pointer-events: none;
+}
+
+#nprogress .bar {
+  background: var(--docusaurus-progress-bar-color);
+  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 var(--docusaurus-progress-bar-color),
+    0 0 5px var(--docusaurus-progress-bar-color);
+  opacity: 1;
+  transform: rotate(3deg) translate(0, -4px);
+}

package/src/nprogress.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 nprogress from 'nprogress';
+import './nprogress.css';
+import type {ClientModule} from '@docusaurus/types';
+
+nprogress.configure({showSpinner: false});
+
+const delay = 200;
+
+const clientModule: ClientModule = {
+  onRouteUpdate({location, previousLocation}) {
+    if (previousLocation && location.pathname !== previousLocation.pathname) {
+      const progressBarTimeout = window.setTimeout(() => {
+        nprogress.start();
+      }, delay);
+      return () => window.clearTimeout(progressBarTimeout);
+    }
+    return undefined;
+  },
+  onRouteDidUpdate() {
+    nprogress.done();
+  },
+};
+
+export default clientModule;