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

package/lib/theme/DocSidebarItem/index.js

@@ -1,209 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.DocSidebarItems = void 0;
-exports.default = DocSidebarItem;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _isInternalUrl = _interopRequireDefault(require("@docusaurus/isInternalUrl"));
-
-var _Translate = require("@docusaurus/Translate");
-
-var _IconExternalLink = _interopRequireDefault(require("@theme/IconExternalLink"));
-
-var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-
-var _useIsBrowser = _interopRequireDefault(require("@docusaurus/useIsBrowser"));
-
-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.
- */
-// Optimize sidebar at each "level"
-// TODO this item should probably not receive the "activePath" props
-// TODO this triggers whole sidebar re-renders on navigation
-const DocSidebarItems = (0, _react.memo)(({
-  items,
-  ...props
-}) => <>
-      {items.map((item, index) => <DocSidebarItem key={index} // sidebar is static, the index does not change
-  item={item} {...props} />)}
-    </>);
-exports.DocSidebarItems = DocSidebarItems;
-
-function DocSidebarItem({
-  item,
-  ...props
-}) {
-  switch (item.type) {
-    case 'category':
-      if (item.items.length === 0) {
-        return null;
-      }
-
-      return <DocSidebarItemCategory item={item} {...props} />;
-
-    case 'link':
-    default:
-      return <DocSidebarItemLink item={item} {...props} />;
-  }
-} // If we navigate to a category and it becomes active, it should automatically expand itself
-
-
-function useAutoExpandActiveCategory({
-  isActive,
-  collapsed,
-  setCollapsed
-}) {
-  const wasActive = (0, _themeCommon.usePrevious)(isActive);
-  (0, _react.useEffect)(() => {
-    const justBecameActive = isActive && !wasActive;
-
-    if (justBecameActive && collapsed) {
-      setCollapsed(false);
-    }
-  }, [isActive, wasActive, collapsed, setCollapsed]);
-} // When a collapsible category has no link, we still link it to its first child during SSR as a temporary fallback
-// This allows to be able to navigate inside the category even when JS fails to load, is delayed or simply disabled
-// React hydration becomes an optional progressive enhancement
-// see https://github.com/facebookincubator/infima/issues/36#issuecomment-772543188
-// see https://github.com/facebook/docusaurus/issues/3030
-
-
-function useCategoryHrefWithSSRFallback(item) {
-  const isBrowser = (0, _useIsBrowser.default)();
-  return (0, _react.useMemo)(() => {
-    if (item.href) {
-      return item.href;
-    } // In these cases, it's not necessary to render a fallback
-    // We skip the "findFirstCategoryLink" computation
-
-
-    if (isBrowser || !item.collapsible) {
-      return undefined;
-    }
-
-    return (0, _themeCommon.findFirstCategoryLink)(item);
-  }, [item, isBrowser]);
-}
-
-function DocSidebarItemCategory({
-  item,
-  onItemClick,
-  activePath,
-  level,
-  ...props
-}) {
-  const {
-    items,
-    label,
-    collapsible,
-    className,
-    href
-  } = item;
-  const hrefWithSSRFallback = useCategoryHrefWithSSRFallback(item);
-  const isActive = (0, _themeCommon.isActiveSidebarItem)(item, activePath);
-  const {
-    collapsed,
-    setCollapsed,
-    toggleCollapsed
-  } = (0, _themeCommon.useCollapsible)({
-    // active categories are always initialized as expanded
-    // the default (item.collapsed) is only used for non-active categories
-    initialState: () => {
-      if (!collapsible) {
-        return false;
-      }
-
-      return isActive ? false : item.collapsed;
-    }
-  });
-  useAutoExpandActiveCategory({
-    isActive,
-    collapsed,
-    setCollapsed
-  });
-  return <li className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docSidebarItemCategory, _themeCommon.ThemeClassNames.docs.docSidebarItemCategoryLevel(level), 'menu__list-item', {
-    'menu__list-item--collapsed': collapsed
-  }, className)}>
-      <div className="menu__list-item-collapsible">
-        <_Link.default className={(0, _clsx.default)('menu__link', {
-        'menu__link--sublist': collapsible && !href,
-        'menu__link--active': isActive,
-        [_stylesModule.default.menuLinkText]: !collapsible,
-        [_stylesModule.default.hasHref]: !!hrefWithSSRFallback
-      })} onClick={collapsible ? e => {
-        onItemClick === null || onItemClick === void 0 ? void 0 : onItemClick(item);
-
-        if (href) {
-          setCollapsed(false);
-        } else {
-          e.preventDefault();
-          toggleCollapsed();
-        }
-      } : () => {
-        onItemClick === null || onItemClick === void 0 ? void 0 : onItemClick(item);
-      }} href={collapsible ? hrefWithSSRFallback !== null && hrefWithSSRFallback !== void 0 ? hrefWithSSRFallback : '#' : hrefWithSSRFallback} {...props}>
-          {label}
-        </_Link.default>
-        {href && collapsible && <button aria-label={(0, _Translate.translate)({
-        id: 'theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel',
-        message: "Toggle the collapsible sidebar category '{label}'",
-        description: 'The ARIA label to toggle the collapsible sidebar category'
-      }, {
-        label
-      })} type="button" className="clean-btn menu__caret" onClick={e => {
-        e.preventDefault();
-        toggleCollapsed();
-      }} />}
-      </div>
-
-      <_themeCommon.Collapsible lazy as="ul" className="menu__list" collapsed={collapsed}>
-        <DocSidebarItems items={items} tabIndex={collapsed ? -1 : 0} onItemClick={onItemClick} activePath={activePath} level={level + 1} />
-      </_themeCommon.Collapsible>
-    </li>;
-}
-
-function DocSidebarItemLink({
-  item,
-  onItemClick,
-  activePath,
-  level,
-  ...props
-}) {
-  const {
-    href,
-    label,
-    className
-  } = item;
-  const isActive = (0, _themeCommon.isActiveSidebarItem)(item, activePath);
-  return <li className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docSidebarItemLink, _themeCommon.ThemeClassNames.docs.docSidebarItemLinkLevel(level), 'menu__list-item', className)} key={label}>
-      <_Link.default className={(0, _clsx.default)('menu__link', {
-      'menu__link--active': isActive
-    })} aria-current={isActive ? 'page' : undefined} to={href} {...(0, _isInternalUrl.default)(href) && {
-      onClick: onItemClick ? () => onItemClick(item) : undefined
-    }} {...props}>
-        {(0, _isInternalUrl.default)(href) ? label : <span>
-            {label}
-            <_IconExternalLink.default />
-          </span>}
-      </_Link.default>
-    </li>;
-}

package/lib/theme/DocTagDocListPage/index.js

@@ -1,89 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocTagDocListPage;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Layout = _interopRequireDefault(require("@theme/Layout"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-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.
- */
-// Very simple pluralization: probably good enough for now
-function useNDocsTaggedPlural() {
-  const {
-    selectMessage
-  } = (0, _themeCommon.usePluralForm)();
-  return count => selectMessage(count, (0, _Translate.translate)({
-    id: 'theme.docs.tagDocListPageTitle.nDocsTagged',
-    description: 'Pluralized label for "{count} docs tagged". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',
-    message: 'One doc tagged|{count} docs tagged'
-  }, {
-    count
-  }));
-}
-
-function DocItem({
-  doc
-}) {
-  return <article className="margin-vert--lg">
-      <_Link.default to={doc.permalink}>
-        <h2>{doc.title}</h2>
-      </_Link.default>
-      {doc.description && <p>{doc.description}</p>}
-    </article>;
-}
-
-function DocTagDocListPage({
-  tag
-}) {
-  const nDocsTaggedPlural = useNDocsTaggedPlural();
-  const title = (0, _Translate.translate)({
-    id: 'theme.docs.tagDocListPageTitle',
-    description: 'The title of the page for a docs tag',
-    message: '{nDocsTagged} with "{tagName}"'
-  }, {
-    nDocsTagged: nDocsTaggedPlural(tag.docs.length),
-    tagName: tag.name
-  });
-  return <_Layout.default title={title} wrapperClassName={_themeCommon.ThemeClassNames.wrapper.docsPages} pageClassName={_themeCommon.ThemeClassNames.page.docsTagDocListPage} searchMetadata={{
-    // assign unique search tag to exclude this page from search results!
-    tag: 'doc_tag_doc_list'
-  }}>
-      <div className="container margin-vert--lg">
-        <div className="row">
-          <main className="col col--8 col--offset-2">
-            <header className="margin-bottom--xl">
-              <h1>{title}</h1>
-              <_Link.default href={tag.allTagsPath}>
-                <_Translate.default id="theme.tags.tagsPageLink" description="The label of the link targeting the tag list page">
-                  View All Tags
-                </_Translate.default>
-              </_Link.default>
-            </header>
-            <section className="margin-vert--lg">
-              {tag.docs.map(doc => <DocItem key={doc.id} doc={doc} />)}
-            </section>
-          </main>
-        </div>
-      </div>
-    </_Layout.default>;
-}

package/lib/theme/DocTagsListPage/index.js

@@ -1,44 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Layout = _interopRequireDefault(require("@theme/Layout"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _TagsListByLetter = _interopRequireDefault(require("@theme/TagsListByLetter"));
-
-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 DocTagsListPage({
-  tags
-}) {
-  const title = (0, _themeCommon.translateTagsPageTitle)();
-  return <_Layout.default title={title} wrapperClassName={_themeCommon.ThemeClassNames.wrapper.docsPages} pageClassName={_themeCommon.ThemeClassNames.page.docsTagsListPage} searchMetadata={{
-    // assign unique search tag to exclude this page from search results!
-    tag: 'doc_tags_list'
-  }}>
-      <div className="container margin-vert--lg">
-        <div className="row">
-          <main className="col col--8 col--offset-2">
-            <h1>{title}</h1>
-            <_TagsListByLetter.default tags={tags} />
-          </main>
-        </div>
-      </div>
-    </_Layout.default>;
-}
-
-var _default = DocTagsListPage;
-exports.default = _default;

package/lib/theme/DocVersionBadge/index.js

@@ -1,34 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocVersionBadge;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-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 DocVersionBadge({
-  className
-}) {
-  const versionMetadata = (0, _themeCommon.useDocsVersion)();
-
-  if (versionMetadata.badge) {
-    return <span className={(0, _clsx.default)(className, _themeCommon.ThemeClassNames.docs.docVersionBadge, 'badge badge--secondary')}>
-        Version: {versionMetadata.label}
-      </span>;
-  }
-
-  return null;
-}

package/lib/theme/DocVersionBanner/index.js

@@ -1,130 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocVersionBanner;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
-
-var _useDocs = require("@theme/hooks/useDocs");
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-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 UnreleasedVersionLabel({
-  siteTitle,
-  versionMetadata
-}) {
-  return <_Translate.default id="theme.docs.versions.unreleasedVersionLabel" description="The label used to tell the user that he's browsing an unreleased doc version" values={{
-    siteTitle,
-    versionLabel: <b>{versionMetadata.label}</b>
-  }}>
-      {'This is unreleased documentation for {siteTitle} {versionLabel} version.'}
-    </_Translate.default>;
-}
-
-function UnmaintainedVersionLabel({
-  siteTitle,
-  versionMetadata
-}) {
-  return <_Translate.default id="theme.docs.versions.unmaintainedVersionLabel" description="The label used to tell the user that he's browsing an unmaintained doc version" values={{
-    siteTitle,
-    versionLabel: <b>{versionMetadata.label}</b>
-  }}>
-      {'This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.'}
-    </_Translate.default>;
-}
-
-const BannerLabelComponents = {
-  unreleased: UnreleasedVersionLabel,
-  unmaintained: UnmaintainedVersionLabel
-};
-
-function BannerLabel(props) {
-  const BannerLabelComponent = BannerLabelComponents[props.versionMetadata.banner];
-  return <BannerLabelComponent {...props} />;
-}
-
-function LatestVersionSuggestionLabel({
-  versionLabel,
-  to,
-  onClick
-}) {
-  return <_Translate.default id="theme.docs.versions.latestVersionSuggestionLabel" description="The label used to tell the user to check the latest version" values={{
-    versionLabel,
-    latestVersionLink: <b>
-            <_Link.default to={to} onClick={onClick}>
-              <_Translate.default id="theme.docs.versions.latestVersionLinkLabel" description="The label used for the latest version suggestion link label">
-                latest version
-              </_Translate.default>
-            </_Link.default>
-          </b>
-  }}>
-      {'For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).'}
-    </_Translate.default>;
-}
-
-function DocVersionBannerEnabled({
-  className,
-  versionMetadata
-}) {
-  const {
-    siteConfig: {
-      title: siteTitle
-    }
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    pluginId
-  } = (0, _useDocs.useActivePlugin)({
-    failfast: true
-  });
-
-  const getVersionMainDoc = version => version.docs.find(doc => doc.id === version.mainDocId);
-
-  const {
-    savePreferredVersionName
-  } = (0, _themeCommon.useDocsPreferredVersion)(pluginId);
-  const {
-    latestDocSuggestion,
-    latestVersionSuggestion
-  } = (0, _useDocs.useDocVersionSuggestions)(pluginId); // try to link to same doc in latest version (not always possible)
-  // fallback to main doc of latest version
-
-  const latestVersionSuggestedDoc = latestDocSuggestion !== null && latestDocSuggestion !== void 0 ? latestDocSuggestion : getVersionMainDoc(latestVersionSuggestion);
-  return <div className={(0, _clsx.default)(className, _themeCommon.ThemeClassNames.docs.docVersionBanner, 'alert alert--warning margin-bottom--md')} role="alert">
-      <div>
-        <BannerLabel siteTitle={siteTitle} versionMetadata={versionMetadata} />
-      </div>
-      <div className="margin-top--md">
-        <LatestVersionSuggestionLabel versionLabel={latestVersionSuggestion.label} to={latestVersionSuggestedDoc.path} onClick={() => savePreferredVersionName(latestVersionSuggestion.name)} />
-      </div>
-    </div>;
-}
-
-function DocVersionBanner({
-  className
-}) {
-  const versionMetadata = (0, _themeCommon.useDocsVersion)();
-
-  if (versionMetadata.banner) {
-    return <DocVersionBannerEnabled className={className} versionMetadata={versionMetadata} />;
-  }
-
-  return null;
-}

package/lib/theme/EditThisPage/index.js

@@ -1,33 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = EditThisPage;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
-
-var _IconEdit = _interopRequireDefault(require("@theme/IconEdit"));
-
-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 EditThisPage({
-  editUrl
-}) {
-  return <a href={editUrl} target="_blank" rel="noreferrer noopener" className={_themeCommon.ThemeClassNames.common.editThisPage}>
-      <_IconEdit.default />
-      <_Translate.default id="theme.common.editThisPage" description="The link label to edit the current page">
-        Edit this page
-      </_Translate.default>
-    </a>;
-}

package/lib/theme/ErrorPageContent.js

@@ -1,43 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = ErrorPageContent;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Translate = _interopRequireDefault(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.
- */
-function ErrorPageContent({
-  error,
-  tryAgain
-}) {
-  return <main className="container margin-vert--xl">
-      <div className="row">
-        <div className="col col--6 col--offset-3">
-          <h1 className="hero__title">
-            <_Translate.default id="theme.ErrorPageContent.title" description="The title of the fallback page when the page crashed">
-              This page crashed.
-            </_Translate.default>
-          </h1>
-          <p>{error.message}</p>
-          <div>
-            <button type="button" onClick={tryAgain}>
-              <_Translate.default id="theme.ErrorPageContent.tryAgain" description="The label of the button to try again when the page crashed">
-                Try again
-              </_Translate.default>
-            </button>
-          </div>
-        </div>
-      </div>
-    </main>;
-}