@docusaurus/theme-classic 2.0.0-beta.fc64c12e4 → 2.0.0

package/lib/theme/NavbarItem/ComponentTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+import type { ComponentTypesObject } from '@theme/NavbarItem/ComponentTypes';
+declare const ComponentTypes: ComponentTypesObject;
+export default ComponentTypes;

package/lib/theme/NavbarItem/ComponentTypes.js

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
+import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem';
+import LocaleDropdownNavbarItem from '@theme/NavbarItem/LocaleDropdownNavbarItem';
+import SearchNavbarItem from '@theme/NavbarItem/SearchNavbarItem';
+import HtmlNavbarItem from '@theme/NavbarItem/HtmlNavbarItem';
+import DocNavbarItem from '@theme/NavbarItem/DocNavbarItem';
+import DocSidebarNavbarItem from '@theme/NavbarItem/DocSidebarNavbarItem';
+import DocsVersionNavbarItem from '@theme/NavbarItem/DocsVersionNavbarItem';
+import DocsVersionDropdownNavbarItem from '@theme/NavbarItem/DocsVersionDropdownNavbarItem';
+const ComponentTypes = {
+  default: DefaultNavbarItem,
+  localeDropdown: LocaleDropdownNavbarItem,
+  search: SearchNavbarItem,
+  dropdown: DropdownNavbarItem,
+  html: HtmlNavbarItem,
+  doc: DocNavbarItem,
+  docSidebar: DocSidebarNavbarItem,
+  docsVersion: DocsVersionNavbarItem,
+  docsVersionDropdown: DocsVersionDropdownNavbarItem,
+};
+export default ComponentTypes;

package/lib/theme/NavbarItem/DefaultNavbarItem.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/NavbarItem/DefaultNavbarItem';
+export default function DefaultNavbarItem({ mobile, position, // Need to destructure position from props so that it doesn't get passed on.
+...props }: Props): JSX.Element;

package/lib/theme/NavbarItem/DefaultNavbarItem.js

@@ -1,105 +1,52 @@
-"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"));
-
-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 = 'navbar__link--active',
-  prependBaseUrlToHref,
-  ...props
-}) {
-  // 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,
-    to: toUrl,
-    ...(activeBasePath || activeBaseRegex ? {
-      isActive: (_match, location) => activeBaseRegex ? new RegExp(activeBaseRegex).test(location.pathname) : location.pathname.startsWith(activeBaseUrl)
-    } : null)
-  }} {...props}>
-      {isExternalLink ? <span>
-          {label}
-          <_IconExternalLink.default {...isDropdownLink && {
-        width: 12,
-        height: 12
-      }} />
-        </span> : label}
-    </_Link.default>;
-}
-
+import React from 'react';
+import clsx from 'clsx';
+import NavbarNavLink from '@theme/NavbarItem/NavbarNavLink';
 function DefaultNavbarItemDesktop({
   className,
   isDropdownItem = false,
   ...props
 }) {
-  const element = <NavLink className={(0, _clsx.default)(isDropdownItem ? 'dropdown__link' : 'navbar__item navbar__link', className)} {...props} />;
-
+  const element = (
+    <NavbarNavLink
+      className={clsx(
+        isDropdownItem ? 'dropdown__link' : 'navbar__item navbar__link',
+        className,
+      )}
+      isDropdownLink={isDropdownItem}
+      {...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 DefaultNavbarItemMobile({className, isDropdownItem, ...props}) {
+  return (
+    <li className="menu__list-item">
+      <NavbarNavLink className={clsx('menu__link', className)} {...props} />
+    </li>
+  );
 }
-
-function DefaultNavbarItem({
+export default function DefaultNavbarItem({
   mobile = false,
-  position: _position,
-  // Need to destructure position from props so that it doesn't get passed on.
+  position, // Need to destructure position from props so that it doesn't get passed on.
   ...props
 }) {
   const Comp = mobile ? DefaultNavbarItemMobile : DefaultNavbarItemDesktop;
-  return <Comp {...props} />;
+  return (
+    <Comp
+      {...props}
+      activeClassName={
+        props.activeClassName ??
+        (mobile ? 'menu__link--active' : 'navbar__link--active')
+      }
+    />
+  );
 }
-
-var _default = DefaultNavbarItem;
-exports.default = _default;

package/lib/theme/NavbarItem/DocNavbarItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/NavbarItem/DocNavbarItem';
+export default function DocNavbarItem({ docId, label: staticLabel, docsPluginId, ...props }: Props): JSX.Element | null;

package/lib/theme/NavbarItem/DocNavbarItem.js

@@ -1,62 +1,35 @@
-"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 _themeCommon = require("@docusaurus/theme-common");
-
-var _utilsCommon = require("@docusaurus/utils-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({
+import React from 'react';
+import {useActiveDocContext} from '@docusaurus/plugin-content-docs/client';
+import {useLayoutDoc} from '@docusaurus/theme-common/internal';
+import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
+export default function DocNavbarItem({
   docId,
-  activeSidebarClassName,
   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, _utilsCommon.uniq)([activeVersion, preferredVersion, latestVersion].filter(Boolean));
-  const doc = getDocInVersions(versions, docId);
-  return <_DefaultNavbarItem.default exact {...props} className={(0, _clsx.default)(props.className, {
-    [activeSidebarClassName]: activeDoc && activeDoc.sidebar === doc.sidebar
-  })} label={staticLabel !== null && staticLabel !== void 0 ? staticLabel : doc.id} to={doc.path} />;
-}
+  const {activeDoc} = useActiveDocContext(docsPluginId);
+  const doc = useLayoutDoc(docId, docsPluginId);
+  // Draft items are not displayed in the navbar.
+  if (doc === null) {
+    return null;
+  }
+  return (
+    <DefaultNavbarItem
+      exact
+      {...props}
+      isActive={() =>
+        activeDoc?.path === doc.path ||
+        (!!activeDoc?.sidebar && activeDoc.sidebar === doc.sidebar)
+      }
+      label={staticLabel ?? doc.id}
+      to={doc.path}
+    />
+  );
+}

package/lib/theme/NavbarItem/DocSidebarNavbarItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/NavbarItem/DocSidebarNavbarItem';
+export default function DocSidebarNavbarItem({ sidebarId, label, docsPluginId, ...props }: Props): JSX.Element;

package/lib/theme/NavbarItem/DocSidebarNavbarItem.js

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+import React from 'react';
+import {useActiveDocContext} from '@docusaurus/plugin-content-docs/client';
+import {useLayoutDocsSidebar} from '@docusaurus/theme-common/internal';
+import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
+export default function DocSidebarNavbarItem({
+  sidebarId,
+  label,
+  docsPluginId,
+  ...props
+}) {
+  const {activeDoc} = useActiveDocContext(docsPluginId);
+  const sidebarLink = useLayoutDocsSidebar(sidebarId, docsPluginId).link;
+  if (!sidebarLink) {
+    throw new Error(
+      `DocSidebarNavbarItem: Sidebar with ID "${sidebarId}" doesn't have anything to be linked to.`,
+    );
+  }
+  return (
+    <DefaultNavbarItem
+      exact
+      {...props}
+      isActive={() => activeDoc?.sidebar === sidebarId}
+      label={label ?? sidebarLink.label}
+      to={sidebarLink.path}
+    />
+  );
+}

package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/NavbarItem/DocsVersionDropdownNavbarItem';
+export default function DocsVersionDropdownNavbarItem({ mobile, docsPluginId, dropdownActiveClassDisabled, dropdownItemsBefore, dropdownItemsAfter, ...props }: Props): JSX.Element;

package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js

@@ -1,31 +1,22 @@
-"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");
-
-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({
+import React from 'react';
+import {
+  useVersions,
+  useActiveDocContext,
+} from '@docusaurus/plugin-content-docs/client';
+import {useDocsPreferredVersion} from '@docusaurus/theme-common';
+import {useDocsVersionCandidates} from '@docusaurus/theme-common/internal';
+import {translate} from '@docusaurus/Translate';
+import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
+import DropdownNavbarItem from '@theme/NavbarItem/DropdownNavbarItem';
+const getVersionMainDoc = (version) =>
+  version.docs.find((doc) => doc.id === version.mainDocId);
+export default function DocsVersionDropdownNavbarItem({
   mobile,
   docsPluginId,
   dropdownActiveClassDisabled,
@@ -33,45 +24,64 @@ function DocsVersionDropdownNavbarItem({
   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 ? 'Versions' : 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'])
+  const activeDocContext = useActiveDocContext(docsPluginId);
+  const versions = useVersions(docsPluginId);
+  const {savePreferredVersionName} = useDocsPreferredVersion(docsPluginId);
+  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.alternateDocVersions[version.name] ??
+      getVersionMainDoc(version);
+    return {
+      label: version.label,
+      to: versionDoc.path,
+      isActive: () => version === activeDocContext.activeVersion,
+      onClick: () => savePreferredVersionName(version.name),
+    };
+  });
+  const items = [
+    ...dropdownItemsBefore,
+    ...versionLinks,
+    ...dropdownItemsAfter,
+  ];
+  const dropdownVersion = useDocsVersionCandidates(docsPluginId)[0];
+  // Mobile dropdown is handled a bit differently
+  const dropdownLabel =
+    mobile && items.length > 1
+      ? 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.length > 1
+      ? 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 (
+      <DefaultNavbarItem
+        {...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} />;
-}
+  return (
+    <DropdownNavbarItem
+      {...props}
+      mobile={mobile}
+      label={dropdownLabel}
+      to={dropdownTo}
+      items={items}
+      isActive={dropdownActiveClassDisabled ? () => false : undefined}
+    />
+  );
+}

package/lib/theme/NavbarItem/DocsVersionNavbarItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/NavbarItem/DocsVersionNavbarItem';
+export default function DocsVersionNavbarItem({ label: staticLabel, to: staticTo, docsPluginId, ...props }: Props): JSX.Element;

package/lib/theme/NavbarItem/DocsVersionNavbarItem.js

@@ -1,43 +1,22 @@
-"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({
+import React from 'react';
+import {useDocsVersionCandidates} from '@docusaurus/theme-common/internal';
+import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
+const getVersionMainDoc = (version) =>
+  version.docs.find((doc) => doc.id === version.mainDocId);
+export default 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} />;
-}
+  const version = useDocsVersionCandidates(docsPluginId)[0];
+  const label = staticLabel ?? version.label;
+  const path = staticTo ?? getVersionMainDoc(version).path;
+  return <DefaultNavbarItem {...props} label={label} to={path} />;
+}

package/lib/theme/NavbarItem/DropdownNavbarItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/NavbarItem/DropdownNavbarItem';
+export default function DropdownNavbarItem({ mobile, ...props }: Props): JSX.Element;