@docusaurus/theme-classic 2.0.0-beta.13 → 2.0.0-beta.15

package/lib/theme/Navbar/index.js

@@ -1,267 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-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"));
-
-var _useThemeContext = _interopRequireDefault(require("@theme/hooks/useThemeContext"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _useHideableNavbar = _interopRequireDefault(require("@theme/hooks/useHideableNavbar"));
-
-var _useLockBodyScroll = _interopRequireDefault(require("@theme/hooks/useLockBodyScroll"));
-
-var _useWindowSize = _interopRequireDefault(require("@theme/hooks/useWindowSize"));
-
-var _useDocs = require("@theme/hooks/useDocs");
-
-var _NavbarItem = _interopRequireDefault(require("@theme/NavbarItem"));
-
-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 }; }
-
-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); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-/**
- * 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.
- */
-// retrocompatible with v1
-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;
-
-    return ((_item$position = item.position) !== null && _item$position !== void 0 ? _item$position : DefaultNavItemPosition) === 'left';
-  });
-  const rightItems = items.filter(item => {
-    var _item$position2;
-
-    return ((_item$position2 = item.position) !== null && _item$position2 !== void 0 ? _item$position2 : DefaultNavItemPosition) === 'right';
-  });
-  return {
-    leftItems,
-    rightItems
-  };
-}
-
-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 {
-    colorMode: {
-      disableSwitch
-    }
-  } = (0, _themeCommon.useThemeConfig)();
-  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
-  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);
-  const items = useNavbarItems();
-  const hasSearchNavbarItem = items.some(item => item.type === 'search');
-  const {
-    leftItems,
-    rightItems
-  } = splitNavItemsByPosition(items);
-  return <nav ref={navbarRef} className={(0, _clsx.default)('navbar', 'navbar--fixed-top', {
-    'navbar--dark': style === 'dark',
-    'navbar--primary': style === 'primary',
-    '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 === 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" />
-          {leftItems.map((item, i) => <_NavbarItem.default {...item} key={i} />)}
-        </div>
-        <div className="navbar__items navbar__items--right">
-          {rightItems.map((item, i) => <_NavbarItem.default {...item} key={i} />)}
-          {!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={mobileSidebar.toggle} />
-
-      {mobileSidebar.shouldRender && <NavbarMobileSidebar sidebarShown={mobileSidebar.shown} toggleSidebar={mobileSidebar.toggle} />}
-    </nav>;
-}
-
-var _default = Navbar;
-exports.default = _default;

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

@@ -1,27 +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.
- */
-
-/*
-Hide toggle in small viewports
- */
-@media (max-width: 996px) {
-  .toggle {
-    display: none;
-  }
-}
-
-.navbarHideable {
-  transition: transform var(--ifm-transition-fast) ease;
-}
-
-.navbarHidden {
-  transform: translate3d(0, calc(-100% - 2px), 0);
-}
-
-.navbarSidebarToggle {
-  margin-right: 1rem;
-}

package/lib/theme/NavbarItem/DefaultNavbarItem.js

@@ -1,113 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.NavLink = NavLink;
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _useBaseUrl = _interopRequireDefault(require("@docusaurus/useBaseUrl"));
-
-var _IconExternalLink = _interopRequireDefault(require("@theme/IconExternalLink"));
-
-var _isInternalUrl = _interopRequireDefault(require("@docusaurus/isInternalUrl"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _index = require("./index");
-
-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.
- */
-const dropdownLinkActiveClass = 'dropdown__link--active';
-
-function NavLink({
-  activeBasePath,
-  activeBaseRegex,
-  to,
-  href,
-  label,
-  activeClassName = '',
-  prependBaseUrlToHref,
-  ...props
-}) {
-  var _props$className;
-
-  // TODO all this seems hacky
-  // {to: 'version'} should probably be forbidden, in favor of {to: '/version'}
-  const toUrl = (0, _useBaseUrl.default)(to);
-  const activeBaseUrl = (0, _useBaseUrl.default)(activeBasePath);
-  const normalizedHref = (0, _useBaseUrl.default)(href, {
-    forcePrependBaseUrl: true
-  });
-  const isExternalLink = label && href && !(0, _isInternalUrl.default)(href);
-  const isDropdownLink = activeClassName === dropdownLinkActiveClass;
-  return <_Link.default {...href ? {
-    href: prependBaseUrlToHref ? normalizedHref : href
-  } : {
-    isNavLink: true,
-    activeClassName: !((_props$className = props.className) !== null && _props$className !== void 0 && _props$className.includes(activeClassName)) ? activeClassName : '',
-    to: toUrl,
-    ...(activeBasePath || activeBaseRegex ? {
-      isActive: (_match, location) => activeBaseRegex ? (0, _themeCommon.isRegexpStringMatch)(activeBaseRegex, location.pathname) : location.pathname.startsWith(activeBaseUrl)
-    } : null)
-  }} {...props}>
-      {isExternalLink ? <span>
-          {label}
-          <_IconExternalLink.default {...isDropdownLink && {
-        width: 12,
-        height: 12
-      }} />
-        </span> : label}
-    </_Link.default>;
-}
-
-function DefaultNavbarItemDesktop({
-  className,
-  isDropdownItem = false,
-  ...props
-}) {
-  const element = <NavLink className={(0, _clsx.default)(isDropdownItem ? 'dropdown__link' : 'navbar__item navbar__link', className)} {...props} />;
-
-  if (isDropdownItem) {
-    return <li>{element}</li>;
-  }
-
-  return element;
-}
-
-function DefaultNavbarItemMobile({
-  className,
-  isDropdownItem: _isDropdownItem,
-  ...props
-}) {
-  return <li className="menu__list-item">
-      <NavLink className={(0, _clsx.default)('menu__link', className)} {...props} />
-    </li>;
-}
-
-function DefaultNavbarItem({
-  mobile = false,
-  position: _position,
-  // Need to destructure position from props so that it doesn't get passed on.
-  ...props
-}) {
-  var _props$activeClassNam;
-
-  const Comp = mobile ? DefaultNavbarItemMobile : DefaultNavbarItemDesktop;
-  return <Comp {...props} activeClassName={(_props$activeClassNam = props.activeClassName) !== null && _props$activeClassNam !== void 0 ? _props$activeClassNam : (0, _index.getInfimaActiveClassName)(mobile)} />;
-}
-
-var _default = DefaultNavbarItem;
-exports.default = _default;

package/lib/theme/NavbarItem/DocNavbarItem.js

@@ -1,62 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocNavbarItem;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _DefaultNavbarItem = _interopRequireDefault(require("@theme/NavbarItem/DefaultNavbarItem"));
-
-var _useDocs = require("@theme/hooks/useDocs");
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _index = require("./index");
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-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.
- */
-function getDocInVersions(versions, docId) {
-  const allDocs = versions.flatMap(version => version.docs);
-  const doc = allDocs.find(versionDoc => versionDoc.id === docId);
-
-  if (!doc) {
-    const docIds = allDocs.map(versionDoc => versionDoc.id).join('\n- ');
-    throw new Error(`DocNavbarItem: couldn't find any doc with id "${docId}" in version${versions.length ? 's' : ''} ${versions.map(version => version.name).join(', ')}".
-Available doc ids are:\n- ${docIds}`);
-  }
-
-  return doc;
-}
-
-function DocNavbarItem({
-  docId,
-  label: staticLabel,
-  docsPluginId,
-  ...props
-}) {
-  const {
-    activeVersion,
-    activeDoc
-  } = (0, _useDocs.useActiveDocContext)(docsPluginId);
-  const {
-    preferredVersion
-  } = (0, _themeCommon.useDocsPreferredVersion)(docsPluginId);
-  const latestVersion = (0, _useDocs.useLatestVersion)(docsPluginId); // Versions used to look for the doc to link to, ordered + no duplicate
-
-  const versions = (0, _themeCommon.uniq)([activeVersion, preferredVersion, latestVersion].filter(Boolean));
-  const doc = getDocInVersions(versions, docId);
-  const activeDocInfimaClassName = (0, _index.getInfimaActiveClassName)(props.mobile);
-  return <_DefaultNavbarItem.default exact {...props} className={(0, _clsx.default)(props.className, {
-    [activeDocInfimaClassName]: (activeDoc === null || activeDoc === void 0 ? void 0 : activeDoc.sidebar) && activeDoc.sidebar === doc.sidebar
-  })} activeClassName={activeDocInfimaClassName} label={staticLabel !== null && staticLabel !== void 0 ? staticLabel : doc.id} to={doc.path} />;
-}

package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js

@@ -1,83 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocsVersionDropdownNavbarItem;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _DefaultNavbarItem = _interopRequireDefault(require("@theme/NavbarItem/DefaultNavbarItem"));
-
-var _DropdownNavbarItem = _interopRequireDefault(require("@theme/NavbarItem/DropdownNavbarItem"));
-
-var _useDocs = require("@theme/hooks/useDocs");
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _Translate = require("@docusaurus/Translate");
-
-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.
- */
-const getVersionMainDoc = version => version.docs.find(doc => doc.id === version.mainDocId);
-
-function DocsVersionDropdownNavbarItem({
-  mobile,
-  docsPluginId,
-  dropdownActiveClassDisabled,
-  dropdownItemsBefore,
-  dropdownItemsAfter,
-  ...props
-}) {
-  var _ref, _activeDocContext$act;
-
-  const activeDocContext = (0, _useDocs.useActiveDocContext)(docsPluginId);
-  const versions = (0, _useDocs.useVersions)(docsPluginId);
-  const latestVersion = (0, _useDocs.useLatestVersion)(docsPluginId);
-  const {
-    preferredVersion,
-    savePreferredVersionName
-  } = (0, _themeCommon.useDocsPreferredVersion)(docsPluginId);
-
-  function getItems() {
-    const versionLinks = versions.map(version => {
-      // We try to link to the same doc, in another version
-      // When not possible, fallback to the "main doc" of the version
-      const versionDoc = (activeDocContext === null || activeDocContext === void 0 ? void 0 : activeDocContext.alternateDocVersions[version.name]) || getVersionMainDoc(version);
-      return {
-        isNavLink: true,
-        label: version.label,
-        to: versionDoc.path,
-        isActive: () => version === (activeDocContext === null || activeDocContext === void 0 ? void 0 : activeDocContext.activeVersion),
-        onClick: () => {
-          savePreferredVersionName(version.name);
-        }
-      };
-    });
-    return [...dropdownItemsBefore, ...versionLinks, ...dropdownItemsAfter];
-  }
-
-  const items = getItems();
-  const dropdownVersion = (_ref = (_activeDocContext$act = activeDocContext.activeVersion) !== null && _activeDocContext$act !== void 0 ? _activeDocContext$act : preferredVersion) !== null && _ref !== void 0 ? _ref : latestVersion; // Mobile dropdown is handled a bit differently
-
-  const dropdownLabel = mobile && items ? (0, _Translate.translate)({
-    id: 'theme.navbar.mobileVersionsDropdown.label',
-    message: 'Versions',
-    description: 'The label for the navbar versions dropdown on mobile view'
-  }) : dropdownVersion.label;
-  const dropdownTo = mobile && items ? undefined : getVersionMainDoc(dropdownVersion).path; // We don't want to render a version dropdown with 0 or 1 item
-  // If we build the site with a single docs version (onlyIncludeVersions: ['1.0.0'])
-  // We'd rather render a button instead of a dropdown
-
-  if (items.length <= 1) {
-    return <_DefaultNavbarItem.default {...props} mobile={mobile} label={dropdownLabel} to={dropdownTo} isActive={dropdownActiveClassDisabled ? () => false : undefined} />;
-  }
-
-  return <_DropdownNavbarItem.default {...props} mobile={mobile} label={dropdownLabel} to={dropdownTo} items={items} isActive={dropdownActiveClassDisabled ? () => false : undefined} />;
-}

package/lib/theme/NavbarItem/DocsVersionNavbarItem.js

@@ -1,43 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocsVersionNavbarItem;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _DefaultNavbarItem = _interopRequireDefault(require("@theme/NavbarItem/DefaultNavbarItem"));
-
-var _useDocs = require("@theme/hooks/useDocs");
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-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.
- */
-const getVersionMainDoc = version => version.docs.find(doc => doc.id === version.mainDocId);
-
-function DocsVersionNavbarItem({
-  label: staticLabel,
-  to: staticTo,
-  docsPluginId,
-  ...props
-}) {
-  var _ref;
-
-  const activeVersion = (0, _useDocs.useActiveVersion)(docsPluginId);
-  const {
-    preferredVersion
-  } = (0, _themeCommon.useDocsPreferredVersion)(docsPluginId);
-  const latestVersion = (0, _useDocs.useLatestVersion)(docsPluginId);
-  const version = (_ref = activeVersion !== null && activeVersion !== void 0 ? activeVersion : preferredVersion) !== null && _ref !== void 0 ? _ref : latestVersion;
-  const label = staticLabel !== null && staticLabel !== void 0 ? staticLabel : version.label;
-  const path = staticTo !== null && staticTo !== void 0 ? staticTo : getVersionMainDoc(version).path;
-  return <_DefaultNavbarItem.default {...props} label={label} to={path} />;
-}