@docusaurus/theme-classic 2.0.0-beta.18 → 2.0.0-beta.19

package/lib/getSwizzleConfig.js

@@ -33,7 +33,7 @@ function getSwizzleConfig() {
       DocSidebar: {
         actions: {
           eject: 'unsafe',
-          // too much technical code in sidebar, not very safe atm
+          // Too much technical code in sidebar, not very safe atm
           wrap: 'safe'
         },
         description: 'The sidebar component on docs pages'
@@ -200,6 +200,13 @@ function getSwizzleConfig() {
         },
         description: 'A component wrapping all MDX content and providing the MDXComponents to the MDX context'
       },
+      'NavbarItem/ComponentTypes': {
+        actions: {
+          eject: 'safe',
+          wrap: 'forbidden'
+        },
+        description: 'The Navbar item components mapping. Can be ejected to add custom navbar item types. See https://github.com/facebook/docusaurus/issues/7227.'
+      },
       // TODO should probably not even appear here
       'NavbarItem/utils': {
         actions: {
@@ -226,7 +233,7 @@ function getSwizzleConfig() {
       'prism-include-languages': {
         actions: {
           eject: 'safe',
-          wrap: 'forbidden' // not a component!
+          wrap: 'forbidden' // Not a component!
 
         },
         description: 'The Prism languages to include for code block syntax highlighting. Meant to be ejected.'

package/lib/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.AnnouncementBarDismissStorageKey = void 0;
-exports.default = docusaurusThemeClassic;
+exports.default = themeClassic;
 Object.defineProperty(exports, "getSwizzleConfig", {
   enumerable: true,
   get: function () {
@@ -108,7 +108,7 @@ function getInfimaCSSFile(direction) {
   return `infima/dist/css/default/default${direction === 'rtl' ? '-rtl' : ''}.css`;
 }
 
-function docusaurusThemeClassic(context, options) {
+function themeClassic(context, options) {
   const {
     i18n: {
       currentLocale,
@@ -140,7 +140,7 @@ function docusaurusThemeClassic(context, options) {
       return '../src/theme';
     },
 
-    getTranslationFiles: async () => (0, _translations.getTranslationFiles)({
+    getTranslationFiles: () => (0, _translations.getTranslationFiles)({
       themeConfig
     }),
     translateThemeConfig: params => (0, _translations.translateThemeConfig)({
@@ -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;