@docusaurus/theme-classic 2.0.0-beta.8bda3b2db → 2.0.0-beta.9

package/lib/theme/LayoutHead/index.js

@@ -86,17 +86,17 @@ function CanonicalUrlHeaders({
 function LayoutHead(props) {
   const {
     siteConfig: {
-      favicon,
-      themeConfig: {
-        metadatas,
-        image: defaultImage
-      }
+      favicon
     },
     i18n: {
       currentLocale,
       localeConfigs
     }
   } = (0, _useDocusaurusContext.default)();
+  const {
+    metadatas,
+    image: defaultImage
+  } = (0, _themeCommon.useThemeConfig)();
   const {
     title,
     description,
@@ -117,14 +117,16 @@ function LayoutHead(props) {
         {favicon && <link rel="shortcut icon" href={faviconUrl} />}
         <title>{pageTitle}</title>
         <meta property="og:title" content={pageTitle} />
-        {image || defaultImage && <meta name="twitter:card" content="summary_large_image" />}
+        <meta name="twitter:card" content="summary_large_image" />
       </_Head.default>
 
-      <_Seo.default {...{
-      description,
-      keywords,
-      image
-    }} />
+      {
+      /* image can override the default image */
+    }
+      {defaultImage && <_Seo.default image={defaultImage} />}
+      {image && <_Seo.default image={image} />}
+
+      <_Seo.default description={description} keywords={keywords} />
 
       <CanonicalUrlHeaders />
 

package/lib/theme/LayoutProviders/index.js

@@ -25,10 +25,16 @@ function LayoutProviders({
   children
 }) {
   return <_ThemeProvider.default>
-      <_UserPreferencesProvider.default>
-        <_themeCommon.DocsPreferredVersionContextProvider>
-          {children}
-        </_themeCommon.DocsPreferredVersionContextProvider>
-      </_UserPreferencesProvider.default>
+      <_themeCommon.AnnouncementBarProvider>
+        <_UserPreferencesProvider.default>
+          <_themeCommon.ScrollControllerProvider>
+            <_themeCommon.DocsPreferredVersionContextProvider>
+              <_themeCommon.MobileSecondaryMenuProvider>
+                {children}
+              </_themeCommon.MobileSecondaryMenuProvider>
+            </_themeCommon.DocsPreferredVersionContextProvider>
+          </_themeCommon.ScrollControllerProvider>
+        </_UserPreferencesProvider.default>
+      </_themeCommon.AnnouncementBarProvider>
     </_ThemeProvider.default>;
 }

package/lib/theme/Logo/index.js

@@ -15,6 +15,8 @@ var _useBaseUrl = _interopRequireDefault(require("@docusaurus/useBaseUrl"));
 
 var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
 
+var _themeCommon = require("@docusaurus/theme-common");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -26,18 +28,17 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 const Logo = props => {
   const {
     siteConfig: {
-      title,
-      themeConfig: {
-        navbar: {
-          title: navbarTitle,
-          logo = {
-            src: ''
-          }
-        }
-      }
-    },
-    isClient
+      title
+    }
   } = (0, _useDocusaurusContext.default)();
+  const {
+    navbar: {
+      title: navbarTitle,
+      logo = {
+        src: ''
+      }
+    }
+  } = (0, _themeCommon.useThemeConfig)();
   const {
     imageClassName,
     titleClassName,
@@ -48,10 +49,11 @@ const Logo = props => {
     light: (0, _useBaseUrl.default)(logo.src),
     dark: (0, _useBaseUrl.default)(logo.srcDark || logo.src)
   };
+  const themedImage = <_ThemedImage.default sources={sources} height={logo.height} width={logo.width} alt={logo.alt || navbarTitle || title} />;
   return <_Link.default to={logoLink} {...propsRest} {...logo.target && {
     target: logo.target
   }}>
-      {logo.src && <_ThemedImage.default key={isClient} className={imageClassName} sources={sources} alt={logo.alt || navbarTitle || title} />}
+      {logo.src && (imageClassName ? <div className={imageClassName}>{themedImage}</div> : <>{themedImage}</>)}
       {navbarTitle != null && <b className={titleClassName}>{navbarTitle}</b>}
     </_Link.default>;
 };

package/lib/theme/MDXComponents/index.js

@@ -7,12 +7,18 @@ exports.default = void 0;
 
 var _react = _interopRequireWildcard(require("react"));
 
+var _Head = _interopRequireDefault(require("@docusaurus/Head"));
+
 var _Link = _interopRequireDefault(require("@docusaurus/Link"));
 
 var _CodeBlock = _interopRequireDefault(require("@theme/CodeBlock"));
 
 var _Heading = _interopRequireDefault(require("@theme/Heading"));
 
+var _Details = _interopRequireDefault(require("@theme/Details"));
+
+require("./styles.css");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
@@ -25,7 +31,29 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+// MDX elements are wrapped through the MDX pragma
+// In some cases (notably usage with Head/Helmet) we need to unwrap those elements.
+function unwrapMDXElement(element) {
+  var _element$props, _element$props2;
+
+  if (element !== null && element !== void 0 && (_element$props = element.props) !== null && _element$props !== void 0 && _element$props.mdxType && element !== null && element !== void 0 && (_element$props2 = element.props) !== null && _element$props2 !== void 0 && _element$props2.originalType) {
+    const {
+      mdxType,
+      originalType,
+      ...newProps
+    } = element.props;
+    return _react.default.createElement(element.props.originalType, newProps);
+  }
+
+  return element;
+}
+
 const MDXComponents = {
+  head: props => {
+    const unwrappedChildren = _react.default.Children.map(props.children, child => unwrapMDXElement(child));
+
+    return <_Head.default {...props}>{unwrappedChildren}</_Head.default>;
+  },
   code: props => {
     const {
       children
@@ -46,14 +74,27 @@ const MDXComponents = {
       children
     } = props; // See comment for `code` above
 
-    if ((0, _react.isValidElement)(children === null || children === void 0 ? void 0 : (_children$props = children.props) === null || _children$props === void 0 ? void 0 : _children$props.children)) {
-      return children === null || children === void 0 ? void 0 : children.props.children;
+    if ((0, _react.isValidElement)(children) && (0, _react.isValidElement)(children === null || children === void 0 ? void 0 : (_children$props = children.props) === null || _children$props === void 0 ? void 0 : _children$props.children)) {
+      return children.props.children;
     }
 
-    return <_CodeBlock.default {...(0, _react.isValidElement)(children) ? children === null || children === void 0 ? void 0 : children.props : {
-      children
+    return <_CodeBlock.default {...(0, _react.isValidElement)(children) ? children === null || children === void 0 ? void 0 : children.props : { ...props
     }} />;
   },
+  details: props => {
+    const items = _react.default.Children.toArray(props.children); // Split summary item from the rest to pass it as a separate prop to the Detais theme component
+
+
+    const summary = items.find(item => {
+      var _item$props;
+
+      return (item === null || item === void 0 ? void 0 : (_item$props = item.props) === null || _item$props === void 0 ? void 0 : _item$props.mdxType) === 'summary';
+    });
+    const children = <>{items.filter(item => item !== summary)}</>;
+    return <_Details.default {...props} summary={summary}>
+        {children}
+      </_Details.default>;
+  },
   h1: (0, _Heading.default)('h1'),
   h2: (0, _Heading.default)('h2'),
   h3: (0, _Heading.default)('h3'),

package/lib/theme/MDXComponents/styles.css

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+
+ul.contains-task-list {
+  padding-left: 0;
+  list-style: none;
+}

package/lib/theme/MDXPage/index.js

@@ -34,6 +34,7 @@ function MDXPage(props) {
     content: MDXPageContent
   } = props;
   const {
+    // TODO this frontmatter is not validated/normalized, it's the raw user-provided one. We should expose normalized one too!
     frontMatter,
     metadata
   } = MDXPageContent;
@@ -55,7 +56,7 @@ function MDXPage(props) {
             </_react2.MDXProvider>
           </div>
           {!hideTableOfContents && MDXPageContent.toc && <div className="col col--2">
-              <_TOC.default toc={MDXPageContent.toc} />
+              <_TOC.default toc={MDXPageContent.toc} minHeadingLevel={frontMatter.toc_min_heading_level} maxHeadingLevel={frontMatter.toc_max_heading_level} />
             </div>}
         </div>
       </main>

package/lib/theme/Navbar/index.js

@@ -9,6 +9,8 @@ var _react = _interopRequireWildcard(require("react"));
 
 var _clsx = _interopRequireDefault(require("clsx"));
 
+var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
+
 var _SearchBar = _interopRequireDefault(require("@theme/SearchBar"));
 
 var _Toggle = _interopRequireDefault(require("@theme/Toggle"));
@@ -21,7 +23,9 @@ var _useHideableNavbar = _interopRequireDefault(require("@theme/hooks/useHideabl
 
 var _useLockBodyScroll = _interopRequireDefault(require("@theme/hooks/useLockBodyScroll"));
 
-var _useWindowSize = _interopRequireWildcard(require("@theme/hooks/useWindowSize"));
+var _useWindowSize = _interopRequireDefault(require("@theme/hooks/useWindowSize"));
+
+var _useDocs = require("@theme/hooks/useDocs");
 
 var _NavbarItem = _interopRequireDefault(require("@theme/NavbarItem"));
 
@@ -29,6 +33,8 @@ var _Logo = _interopRequireDefault(require("@theme/Logo"));
 
 var _IconMenu = _interopRequireDefault(require("@theme/IconMenu"));
 
+var _IconClose = _interopRequireDefault(require("@theme/IconClose"));
+
 var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -44,9 +50,15 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  * LICENSE file in the root directory of this source tree.
  */
 // retrocompatible with v1
-const DefaultNavItemPosition = 'right'; // If split links by left/right
+const DefaultNavItemPosition = 'right';
+
+function useNavbarItems() {
+  // TODO temporary casting until ThemeConfig type is improved
+  return (0, _themeCommon.useThemeConfig)().navbar.items;
+} // If split links by left/right
 // if position is unspecified, fallback to right (as v1)
 
+
 function splitNavItemsByPosition(items) {
   const leftItems = items.filter(item => {
     var _item$position;
@@ -64,41 +76,162 @@ function splitNavItemsByPosition(items) {
   };
 }
 
-function Navbar() {
+function useMobileSidebar() {
+  const windowSize = (0, _useWindowSize.default)(); // Mobile sidebar not visible on hydration: can avoid SSR rendering
+
+  const shouldRender = windowSize === 'mobile'; // || windowSize === 'ssr';
+
+  const [shown, setShown] = (0, _react.useState)(false); // Close mobile sidebar on navigation pop
+  // Most likely firing when using the Android back button (but not only)
+
+  (0, _themeCommon.useHistoryPopHandler)(() => {
+    if (shown) {
+      setShown(false); // Should we prevent the navigation here?
+      // See https://github.com/facebook/docusaurus/pull/5462#issuecomment-911699846
+
+      return false; // prevent pop navigation
+    }
+
+    return undefined;
+  });
+  const toggle = (0, _react.useCallback)(() => {
+    setShown(s => !s);
+  }, []);
+  (0, _react.useEffect)(() => {
+    if (windowSize === 'desktop') {
+      setShown(false);
+    }
+  }, [windowSize]);
+  return {
+    shouldRender,
+    toggle,
+    shown
+  };
+}
+
+function useColorModeToggle() {
   const {
-    navbar: {
-      items,
-      hideOnScroll,
-      style
-    },
     colorMode: {
-      disableSwitch: disableColorModeSwitch
+      disableSwitch
     }
   } = (0, _themeCommon.useThemeConfig)();
-  const [sidebarShown, setSidebarShown] = (0, _react.useState)(false);
   const {
     isDarkTheme,
     setLightTheme,
     setDarkTheme
   } = (0, _useThemeContext.default)();
+  const toggle = (0, _react.useCallback)(e => e.target.checked ? setDarkTheme() : setLightTheme(), [setLightTheme, setDarkTheme]);
+  return {
+    isDarkTheme,
+    toggle,
+    disabled: disableSwitch
+  };
+}
+
+function useSecondaryMenu({
+  sidebarShown,
+  toggleSidebar
+}) {
+  var _useMobileSecondaryMe;
+
+  const content = (_useMobileSecondaryMe = (0, _themeCommon.useMobileSecondaryMenuRenderer)()) === null || _useMobileSecondaryMe === void 0 ? void 0 : _useMobileSecondaryMe({
+    toggleSidebar
+  });
+  const previousContent = (0, _themeCommon.usePrevious)(content);
+  const [shown, setShown] = (0, _react.useState)(() => {
+    // /!\ content is set with useEffect,
+    // so it's not available on mount anyway
+    // "return !!content" => always returns false
+    return false;
+  }); // When content is become available for the first time (set in useEffect)
+  // we set this content to be shown!
+
+  (0, _react.useEffect)(() => {
+    const contentBecameAvailable = content && !previousContent;
+
+    if (contentBecameAvailable) {
+      setShown(true);
+    }
+  }, [content, previousContent]);
+  const hasContent = !!content; // On sidebar close, secondary menu is set to be shown on next re-opening
+  // (if any secondary menu content available)
+
+  (0, _react.useEffect)(() => {
+    if (!hasContent) {
+      setShown(false);
+      return;
+    }
+
+    if (!sidebarShown) {
+      setShown(true);
+    }
+  }, [sidebarShown, hasContent]);
+  const hide = (0, _react.useCallback)(() => {
+    setShown(false);
+  }, []);
+  return {
+    shown,
+    hide,
+    content
+  };
+}
+
+function NavbarMobileSidebar({
+  sidebarShown,
+  toggleSidebar
+}) {
+  (0, _useLockBodyScroll.default)(sidebarShown);
+  const items = useNavbarItems();
+  const colorModeToggle = useColorModeToggle();
+  const secondaryMenu = useSecondaryMenu({
+    sidebarShown,
+    toggleSidebar
+  });
+  return <div className="navbar-sidebar">
+      <div className="navbar-sidebar__brand">
+        <_Logo.default className="navbar__brand" imageClassName="navbar__logo" titleClassName="navbar__title" />
+        {!colorModeToggle.disabled && <_Toggle.default className={_stylesModule.default.navbarSidebarToggle} checked={colorModeToggle.isDarkTheme} onChange={colorModeToggle.toggle} />}
+        <button type="button" className="clean-btn navbar-sidebar__close" onClick={toggleSidebar}>
+          <_IconClose.default color="var(--ifm-color-emphasis-600)" className={_stylesModule.default.navbarSidebarCloseSvg} />
+        </button>
+      </div>
+
+      <div className={(0, _clsx.default)('navbar-sidebar__items', {
+      'navbar-sidebar__items--show-secondary': secondaryMenu.shown
+    })}>
+        <div className="navbar-sidebar__item menu">
+          <ul className="menu__list">
+            {items.map((item, i) => <_NavbarItem.default mobile {...item} onClick={toggleSidebar} key={i} />)}
+          </ul>
+        </div>
+
+        <div className="navbar-sidebar__item menu">
+          {items.length > 0 && <button type="button" className="clean-btn navbar-sidebar__back" onClick={secondaryMenu.hide}>
+              <_Translate.default id="theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel" description="The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)">
+                ← Back to main menu
+              </_Translate.default>
+            </button>}
+          {secondaryMenu.content}
+        </div>
+      </div>
+    </div>;
+}
+
+function Navbar() {
+  const {
+    navbar: {
+      hideOnScroll,
+      style
+    }
+  } = (0, _themeCommon.useThemeConfig)();
+  const mobileSidebar = useMobileSidebar();
+  const colorModeToggle = useColorModeToggle();
+  const activeDocPlugin = (0, _useDocs.useActivePlugin)();
   const {
     navbarRef,
     isNavbarVisible
   } = (0, _useHideableNavbar.default)(hideOnScroll);
-  (0, _useLockBodyScroll.default)(sidebarShown);
-  const showSidebar = (0, _react.useCallback)(() => {
-    setSidebarShown(true);
-  }, [setSidebarShown]);
-  const hideSidebar = (0, _react.useCallback)(() => {
-    setSidebarShown(false);
-  }, [setSidebarShown]);
-  const onToggleChange = (0, _react.useCallback)(e => e.target.checked ? setDarkTheme() : setLightTheme(), [setLightTheme, setDarkTheme]);
-  const windowSize = (0, _useWindowSize.default)();
-  (0, _react.useEffect)(() => {
-    if (windowSize === _useWindowSize.windowSizes.desktop) {
-      setSidebarShown(false);
-    }
-  }, [windowSize]);
+  const items = useNavbarItems();
   const hasSearchNavbarItem = items.some(item => item.type === 'search');
   const {
     leftItems,
@@ -107,13 +240,13 @@ function Navbar() {
   return <nav ref={navbarRef} className={(0, _clsx.default)('navbar', 'navbar--fixed-top', {
     'navbar--dark': style === 'dark',
     'navbar--primary': style === 'primary',
-    'navbar-sidebar--show': sidebarShown,
+    'navbar-sidebar--show': mobileSidebar.shown,
     [_stylesModule.default.navbarHideable]: hideOnScroll,
     [_stylesModule.default.navbarHidden]: hideOnScroll && !isNavbarVisible
   })}>
       <div className="navbar__inner">
         <div className="navbar__items">
-          {items != null && items.length !== 0 && <button aria-label="Navigation bar toggle" className="navbar__toggle clean-btn" type="button" tabIndex={0} onClick={showSidebar} onKeyDown={showSidebar}>
+          {((items === null || items === void 0 ? void 0 : items.length) > 0 || activeDocPlugin) && <button aria-label="Navigation bar toggle" className="navbar__toggle clean-btn" type="button" tabIndex={0} onClick={mobileSidebar.toggle} onKeyDown={mobileSidebar.toggle}>
               <_IconMenu.default />
             </button>}
           <_Logo.default className="navbar__brand" imageClassName="navbar__logo" titleClassName="navbar__title" />
@@ -121,25 +254,14 @@ function Navbar() {
         </div>
         <div className="navbar__items navbar__items--right">
           {rightItems.map((item, i) => <_NavbarItem.default {...item} key={i} />)}
-          {!disableColorModeSwitch && <_Toggle.default className={_stylesModule.default.displayOnlyInLargeViewport} checked={isDarkTheme} onChange={onToggleChange} />}
+          {!colorModeToggle.disabled && <_Toggle.default className={_stylesModule.default.toggle} checked={colorModeToggle.isDarkTheme} onChange={colorModeToggle.toggle} />}
           {!hasSearchNavbarItem && <_SearchBar.default />}
         </div>
       </div>
-      <div role="presentation" className="navbar-sidebar__backdrop" onClick={hideSidebar} />
-      <div className="navbar-sidebar">
-        <div className="navbar-sidebar__brand">
-          <_Logo.default className="navbar__brand" imageClassName="navbar__logo" titleClassName="navbar__title" onClick={hideSidebar} />
-          {!disableColorModeSwitch && sidebarShown && <_Toggle.default checked={isDarkTheme} onChange={onToggleChange} />}
-        </div>
-        <div className="navbar-sidebar__items">
-          <div className="menu">
-            <ul className="menu__list">
-              {items.map((item, i) => <_NavbarItem.default mobile {...item} // TODO fix typing
-            onClick={hideSidebar} key={i} />)}
-            </ul>
-          </div>
-        </div>
-      </div>
+
+      <div role="presentation" className="navbar-sidebar__backdrop" onClick={mobileSidebar.toggle} />
+
+      {mobileSidebar.shouldRender && <NavbarMobileSidebar sidebarShown={mobileSidebar.shown} toggleSidebar={mobileSidebar.toggle} />}
     </nav>;
 }
 

package/lib/theme/Navbar/styles.module.css

@@ -5,9 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-@media screen and (max-width: 997px) {
-  .displayOnlyInLargeViewport {
-    display: none !important;
+/*
+Hide toggle in small viewports
+ */
+@media (max-width: 996px) {
+  .toggle {
+    display: none;
   }
 }
 
@@ -18,3 +21,7 @@
 .navbarHidden {
   transform: translate3d(0, calc(-100% - 2px), 0);
 }
+
+.navbarSidebarToggle {
+  margin-right: 1rem;
+}