@docusaurus/theme-classic 0.0.0-4279 → 0.0.0-4286

package/lib/theme/DocPage/index.js

@@ -1,154 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _react2 = require("@mdx-js/react");
-
-var _renderRoutes = _interopRequireDefault(require("@docusaurus/renderRoutes"));
-
-var _Layout = _interopRequireDefault(require("@theme/Layout"));
-
-var _DocSidebar = _interopRequireDefault(require("@theme/DocSidebar"));
-
-var _MDXComponents = _interopRequireDefault(require("@theme/MDXComponents"));
-
-var _NotFound = _interopRequireDefault(require("@theme/NotFound"));
-
-var _IconArrow = _interopRequireDefault(require("@theme/IconArrow"));
-
-var _BackToTopButton = _interopRequireDefault(require("@theme/BackToTopButton"));
-
-var _router = require("@docusaurus/router");
-
-var _Translate = require("@docusaurus/Translate");
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _Head = _interopRequireDefault(require("@docusaurus/Head"));
-
-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.
- */
-function DocPageContent({
-  currentDocRoute,
-  versionMetadata,
-  children,
-  sidebarName
-}) {
-  const sidebar = (0, _themeCommon.useDocsSidebar)();
-  const {
-    pluginId,
-    version
-  } = versionMetadata;
-  const [hiddenSidebarContainer, setHiddenSidebarContainer] = (0, _react.useState)(false);
-  const [hiddenSidebar, setHiddenSidebar] = (0, _react.useState)(false);
-  const toggleSidebar = (0, _react.useCallback)(() => {
-    if (hiddenSidebar) {
-      setHiddenSidebar(false);
-    }
-
-    setHiddenSidebarContainer(value => !value);
-  }, [hiddenSidebar]);
-  return <_Layout.default wrapperClassName={_themeCommon.ThemeClassNames.wrapper.docsPages} pageClassName={_themeCommon.ThemeClassNames.page.docsDocPage} searchMetadata={{
-    version,
-    tag: (0, _themeCommon.docVersionSearchTag)(pluginId, version)
-  }}>
-      <div className={_stylesModule.default.docPage}>
-        <_BackToTopButton.default />
-
-        {sidebar && <aside className={(0, _clsx.default)(_stylesModule.default.docSidebarContainer, {
-        [_stylesModule.default.docSidebarContainerHidden]: hiddenSidebarContainer
-      })} onTransitionEnd={e => {
-        if (!e.currentTarget.classList.contains(_stylesModule.default.docSidebarContainer)) {
-          return;
-        }
-
-        if (hiddenSidebarContainer) {
-          setHiddenSidebar(true);
-        }
-      }}>
-            <_DocSidebar.default key={// Reset sidebar state on sidebar changes
-        // See https://github.com/facebook/docusaurus/issues/3414
-        sidebarName} sidebar={sidebar} path={currentDocRoute.path} onCollapse={toggleSidebar} isHidden={hiddenSidebar} />
-
-            {hiddenSidebar && <div className={_stylesModule.default.collapsedDocSidebar} title={(0, _Translate.translate)({
-          id: 'theme.docs.sidebar.expandButtonTitle',
-          message: 'Expand sidebar',
-          description: 'The ARIA label and title attribute for expand button of doc sidebar'
-        })} aria-label={(0, _Translate.translate)({
-          id: 'theme.docs.sidebar.expandButtonAriaLabel',
-          message: 'Expand sidebar',
-          description: 'The ARIA label and title attribute for expand button of doc sidebar'
-        })} tabIndex={0} role="button" onKeyDown={toggleSidebar} onClick={toggleSidebar}>
-                <_IconArrow.default className={_stylesModule.default.expandSidebarButtonIcon} />
-              </div>}
-          </aside>}
-        <main className={(0, _clsx.default)(_stylesModule.default.docMainContainer, {
-        [_stylesModule.default.docMainContainerEnhanced]: hiddenSidebarContainer || !sidebar
-      })}>
-          <div className={(0, _clsx.default)('container padding-top--md padding-bottom--lg', _stylesModule.default.docItemWrapper, {
-          [_stylesModule.default.docItemWrapperEnhanced]: hiddenSidebarContainer
-        })}>
-            <_react2.MDXProvider components={_MDXComponents.default}>{children}</_react2.MDXProvider>
-          </div>
-        </main>
-      </div>
-    </_Layout.default>;
-}
-
-function DocPage(props) {
-  const {
-    route: {
-      routes: docRoutes
-    },
-    versionMetadata,
-    location
-  } = props;
-  const currentDocRoute = docRoutes.find(docRoute => (0, _router.matchPath)(location.pathname, docRoute));
-
-  if (!currentDocRoute) {
-    return <_NotFound.default />;
-  } // For now, the sidebarName is added as route config: not ideal!
-
-
-  const sidebarName = currentDocRoute.sidebar;
-  const sidebar = sidebarName ? versionMetadata.docsSidebars[sidebarName] : null;
-  return <>
-      <_Head.default>
-        {
-        /* TODO we should add a core addRoute({htmlClassName}) generic plugin option */
-      }
-        <html className={versionMetadata.className} />
-      </_Head.default>
-      <_themeCommon.DocsVersionProvider version={versionMetadata}>
-        <_themeCommon.DocsSidebarProvider sidebar={sidebar}>
-          <DocPageContent currentDocRoute={currentDocRoute} versionMetadata={versionMetadata} sidebarName={sidebarName}>
-            {(0, _renderRoutes.default)(docRoutes, {
-            versionMetadata
-          })}
-          </DocPageContent>
-        </_themeCommon.DocsSidebarProvider>
-      </_themeCommon.DocsVersionProvider>
-    </>;
-}
-
-var _default = DocPage;
-exports.default = _default;

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

@@ -1,85 +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.
- */
-
-:root {
-  --doc-sidebar-width: 300px;
-  --doc-sidebar-hidden-width: 30px;
-}
-
-:global(.docs-wrapper) {
-  display: flex;
-}
-
-.docPage,
-.docMainContainer {
-  display: flex;
-  width: 100%;
-}
-
-.docSidebarContainer {
-  display: none;
-}
-
-@media (min-width: 997px) {
-  .docMainContainer {
-    flex-grow: 1;
-    max-width: calc(100% - var(--doc-sidebar-width));
-  }
-
-  .docMainContainerEnhanced {
-    max-width: calc(100% - var(--doc-sidebar-hidden-width));
-  }
-
-  .docSidebarContainer {
-    display: block;
-    width: var(--doc-sidebar-width);
-    margin-top: calc(-1 * var(--ifm-navbar-height));
-    border-right: 1px solid var(--ifm-toc-border-color);
-    will-change: width;
-    transition: width var(--ifm-transition-fast) ease;
-    clip-path: inset(0);
-  }
-
-  .docSidebarContainerHidden {
-    width: var(--doc-sidebar-hidden-width);
-    cursor: pointer;
-  }
-
-  .collapsedDocSidebar {
-    position: sticky;
-    top: 0;
-    height: 100%;
-    max-height: 100vh;
-    display: flex;
-    align-items: center;
-    justify-content: center;
-    transition: background-color var(--ifm-transition-fast) ease;
-  }
-
-  .collapsedDocSidebar:hover,
-  .collapsedDocSidebar:focus {
-    background-color: var(--ifm-color-emphasis-200);
-  }
-
-  .expandSidebarButtonIcon {
-    transform: rotate(0);
-  }
-  html[dir='rtl'] .expandSidebarButtonIcon {
-    transform: rotate(180deg);
-  }
-
-  html[data-theme='dark'] .collapsedDocSidebar:hover,
-  html[data-theme='dark'] .collapsedDocSidebar:focus {
-    background-color: var(--collapse-button-bg-color-dark);
-  }
-
-  .docItemWrapperEnhanced {
-    max-width: calc(
-      var(--ifm-container-width) + var(--doc-sidebar-width)
-    ) !important;
-  }
-}

package/lib/theme/DocPaginator/index.js

@@ -1,62 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _Translate = _interopRequireWildcard(require("@docusaurus/Translate"));
-
-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; }
-
-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 DocPaginator(props) {
-  const {
-    previous,
-    next
-  } = props;
-  return <nav className="pagination-nav docusaurus-mt-lg" aria-label={(0, _Translate.translate)({
-    id: 'theme.docs.paginator.navAriaLabel',
-    message: 'Docs pages navigation',
-    description: 'The ARIA label for the docs pagination'
-  })}>
-      <div className="pagination-nav__item">
-        {previous && <_Link.default className="pagination-nav__link" to={previous.permalink}>
-            <div className="pagination-nav__sublabel">
-              <_Translate.default id="theme.docs.paginator.previous" description="The label used to navigate to the previous doc">
-                Previous
-              </_Translate.default>
-            </div>
-            <div className="pagination-nav__label">
-              &laquo; {previous.title}
-            </div>
-          </_Link.default>}
-      </div>
-      <div className="pagination-nav__item pagination-nav__item--next">
-        {next && <_Link.default className="pagination-nav__link" to={next.permalink}>
-            <div className="pagination-nav__sublabel">
-              <_Translate.default id="theme.docs.paginator.next" description="The label used to navigate to the next doc">
-                Next
-              </_Translate.default>
-            </div>
-            <div className="pagination-nav__label">{next.title} &raquo;</div>
-          </_Link.default>}
-      </div>
-    </nav>;
-}
-
-var _default = DocPaginator;
-exports.default = _default;

package/lib/theme/DocSidebar/index.js

@@ -1,134 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocSidebar;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _useWindowSize = _interopRequireDefault(require("@theme/hooks/useWindowSize"));
-
-var _Logo = _interopRequireDefault(require("@theme/Logo"));
-
-var _IconArrow = _interopRequireDefault(require("@theme/IconArrow"));
-
-var _Translate = require("@docusaurus/Translate");
-
-var _DocSidebarItem = require("@theme/DocSidebarItem");
-
-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.
- */
-function useShowAnnouncementBar() {
-  const {
-    isActive
-  } = (0, _themeCommon.useAnnouncementBar)();
-  const [showAnnouncementBar, setShowAnnouncementBar] = (0, _react.useState)(isActive);
-  (0, _themeCommon.useScrollPosition)(({
-    scrollY
-  }) => {
-    if (isActive) {
-      setShowAnnouncementBar(scrollY === 0);
-    }
-  }, [isActive]);
-  return isActive && showAnnouncementBar;
-}
-
-function HideableSidebarButton({
-  onClick
-}) {
-  return <button type="button" title={(0, _Translate.translate)({
-    id: 'theme.docs.sidebar.collapseButtonTitle',
-    message: 'Collapse sidebar',
-    description: 'The title attribute for collapse button of doc sidebar'
-  })} aria-label={(0, _Translate.translate)({
-    id: 'theme.docs.sidebar.collapseButtonAriaLabel',
-    message: 'Collapse sidebar',
-    description: 'The title attribute for collapse button of doc sidebar'
-  })} className={(0, _clsx.default)('button button--secondary button--outline', _stylesModule.default.collapseSidebarButton)} onClick={onClick}>
-      <_IconArrow.default className={_stylesModule.default.collapseSidebarButtonIcon} />
-    </button>;
-}
-
-function DocSidebarDesktop({
-  path,
-  sidebar,
-  onCollapse,
-  isHidden
-}) {
-  const showAnnouncementBar = useShowAnnouncementBar();
-  const {
-    navbar: {
-      hideOnScroll
-    },
-    hideableSidebar
-  } = (0, _themeCommon.useThemeConfig)();
-  return <div className={(0, _clsx.default)(_stylesModule.default.sidebar, {
-    [_stylesModule.default.sidebarWithHideableNavbar]: hideOnScroll,
-    [_stylesModule.default.sidebarHidden]: isHidden
-  })}>
-      {hideOnScroll && <_Logo.default tabIndex={-1} className={_stylesModule.default.sidebarLogo} />}
-      <nav className={(0, _clsx.default)('menu thin-scrollbar', _stylesModule.default.menu, {
-      [_stylesModule.default.menuWithAnnouncementBar]: showAnnouncementBar
-    })}>
-        <ul className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docSidebarMenu, 'menu__list')}>
-          <_DocSidebarItem.DocSidebarItems items={sidebar} activePath={path} level={1} />
-        </ul>
-      </nav>
-      {hideableSidebar && <HideableSidebarButton onClick={onCollapse} />}
-    </div>;
-} // eslint-disable-next-line react/function-component-definition
-
-
-const DocSidebarMobileSecondaryMenu = ({
-  toggleSidebar,
-  sidebar,
-  path
-}) => <ul className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docSidebarMenu, 'menu__list')}>
-    <_DocSidebarItem.DocSidebarItems items={sidebar} activePath={path} onItemClick={item => {
-    // Mobile sidebar should only be closed if the category has a link
-    if (item.type === 'category' && item.href) {
-      toggleSidebar();
-    }
-
-    if (item.type === 'link') {
-      toggleSidebar();
-    }
-  }} level={1} />
-  </ul>;
-
-function DocSidebarMobile(props) {
-  return <_themeCommon.MobileSecondaryMenuFiller component={DocSidebarMobileSecondaryMenu} props={props} />;
-}
-
-const DocSidebarDesktopMemo = _react.default.memo(DocSidebarDesktop);
-
-const DocSidebarMobileMemo = _react.default.memo(DocSidebarMobile);
-
-function DocSidebar(props) {
-  const windowSize = (0, _useWindowSize.default)(); // Desktop sidebar visible on hydration: need SSR rendering
-
-  const shouldRenderSidebarDesktop = windowSize === 'desktop' || windowSize === 'ssr'; // Mobile sidebar not visible on hydration: can avoid SSR rendering
-
-  const shouldRenderSidebarMobile = windowSize === 'mobile';
-  return <>
-      {shouldRenderSidebarDesktop && <DocSidebarDesktopMemo {...props} />}
-      {shouldRenderSidebarMobile && <DocSidebarMobileMemo {...props} />}
-    </>;
-}

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

@@ -1,106 +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.
- */
-
-:root {
-  --collapse-button-bg-color-dark: #2e333a;
-}
-
-@media (min-width: 997px) {
-  .sidebar {
-    display: flex;
-    flex-direction: column;
-    max-height: 100vh;
-    height: 100%;
-    position: sticky;
-    top: 0;
-    padding-top: var(--ifm-navbar-height);
-    width: var(--doc-sidebar-width);
-    transition: opacity 50ms ease;
-  }
-
-  .sidebarWithHideableNavbar {
-    padding-top: 0;
-  }
-
-  .sidebarHidden {
-    opacity: 0;
-    height: 0;
-    overflow: hidden;
-    visibility: hidden;
-  }
-
-  .sidebarLogo {
-    display: flex !important;
-    align-items: center;
-    margin: 0 var(--ifm-navbar-padding-horizontal);
-    min-height: var(--ifm-navbar-height);
-    max-height: var(--ifm-navbar-height);
-    color: inherit !important;
-    text-decoration: none !important;
-  }
-
-  .sidebarLogo img {
-    margin-right: 0.5rem;
-    height: 2rem;
-  }
-
-  .menu {
-    flex-grow: 1;
-    padding: 0.5rem;
-  }
-
-  .menuWithAnnouncementBar {
-    margin-bottom: var(--docusaurus-announcement-bar-height);
-  }
-
-  .collapseSidebarButton {
-    display: block !important;
-    background-color: var(--ifm-button-background-color);
-    height: 40px;
-    position: sticky;
-    bottom: 0;
-    border-radius: 0;
-    border: 1px solid var(--ifm-toc-border-color);
-  }
-
-  .collapseSidebarButtonIcon {
-    transform: rotate(180deg);
-    margin-top: 4px;
-  }
-  html[dir='rtl'] .collapseSidebarButtonIcon {
-    transform: rotate(0);
-  }
-
-  html[data-theme='dark'] .collapseSidebarButton {
-    background-color: var(--collapse-button-bg-color-dark);
-  }
-
-  html[data-theme='dark'] .collapseSidebarButton:hover,
-  html[data-theme='dark'] .collapseSidebarButton:focus {
-    background-color: var(--ifm-color-emphasis-200);
-  }
-}
-
-.sidebarLogo,
-.collapseSidebarButton {
-  display: none;
-}
-
-.sidebarMenuIcon {
-  vertical-align: middle;
-}
-
-.sidebarMenuCloseIcon {
-  display: inline-flex;
-  justify-content: center;
-  align-items: center;
-  height: 24px;
-  font-size: 1.5rem;
-  font-weight: var(--ifm-font-weight-bold);
-  line-height: 0.9;
-  width: 24px;
-}