@docusaurus/theme-classic 2.0.0-beta.2 → 2.0.0-beta.22

package/lib/theme/Icon/ExternalLink/index.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/Icon/ExternalLink';
+export default function IconExternalLink({ width, height, }: Props): JSX.Element;

package/{lib-next/theme/IconExternalLink → lib/theme/Icon/ExternalLink}/index.js

@@ -6,8 +6,7 @@
  */
 import React from 'react';
 import styles from './styles.module.css';
-
-const IconExternalLink = ({width = 13.5, height = 13.5}) => {
+export default function IconExternalLink({width = 13.5, height = 13.5}) {
   return (
     <svg
       width={width}
@@ -21,6 +20,4 @@ const IconExternalLink = ({width = 13.5, height = 13.5}) => {
       />
     </svg>
   );
-};
-
-export default IconExternalLink;
+}

package/lib/theme/{IconExternalLink → Icon/ExternalLink}/styles.module.css

@@ -7,6 +7,4 @@
 
 .iconExternalLink {
   margin-left: 0.3rem;
-  position: relative;
-  top: 1px;
 }

package/lib/theme/Icon/Home/index.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/Icon/Home';
+export default function IconHome(props: Props): JSX.Element;

package/lib/theme/Icon/Home/index.js

@@ -0,0 +1,17 @@
+/**
+ * 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';
+export default function IconHome(props) {
+  return (
+    <svg viewBox="0 0 24 24" {...props}>
+      <path
+        d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z"
+        fill="currentColor"
+      />
+    </svg>
+  );
+}

package/lib/theme/Icon/Language/index.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/Icon/Language';
+export default function IconLanguage({ width, height, ...props }: Props): JSX.Element;

package/lib/theme/Icon/Language/index.js

@@ -0,0 +1,22 @@
+/**
+ * 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';
+export default function IconLanguage({width = 20, height = 20, ...props}) {
+  return (
+    <svg
+      viewBox="0 0 24 24"
+      width={width}
+      height={height}
+      aria-hidden
+      {...props}>
+      <path
+        fill="currentColor"
+        d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"
+      />
+    </svg>
+  );
+}

package/lib/theme/Icon/LightMode/index.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/Icon/LightMode';
+export default function IconLightMode(props: Props): JSX.Element;

package/lib/theme/Icon/LightMode/index.js

@@ -0,0 +1,17 @@
+/**
+ * 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';
+export default function IconLightMode(props) {
+  return (
+    <svg viewBox="0 0 24 24" width={24} height={24} {...props}>
+      <path
+        fill="currentColor"
+        d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"
+      />
+    </svg>
+  );
+}

package/lib/theme/Icon/Menu/index.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/Icon/Menu';
+export default function IconMenu({ width, height, className, ...restProps }: Props): JSX.Element;

package/{lib-next/theme/IconMenu → lib/theme/Icon/Menu}/index.js

@@ -5,8 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-
-const IconMenu = ({width = 30, height = 30, className, ...restProps}) => {
+export default function IconMenu({
+  width = 30,
+  height = 30,
+  className,
+  ...restProps
+}) {
   return (
     <svg
       className={className}
@@ -24,6 +28,4 @@ const IconMenu = ({width = 30, height = 30, className, ...restProps}) => {
       />
     </svg>
   );
-};
-
-export default IconMenu;
+}

package/lib/theme/LastUpdated/index.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/LastUpdated';
+export default function LastUpdated({ lastUpdatedAt, formattedLastUpdatedAt, lastUpdatedBy, }: Props): JSX.Element;

package/lib/theme/LastUpdated/index.js

@@ -1,61 +1,76 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = LastUpdated;
-
-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 LastUpdatedAtDate({
-  lastUpdatedAt,
-  formattedLastUpdatedAt
-}) {
-  return <_Translate.default id="theme.lastUpdated.atDate" description="The words used to describe on which date a page has been last updated" values={{
-    date: <b>
+import React from 'react';
+import Translate from '@docusaurus/Translate';
+import {ThemeClassNames} from '@docusaurus/theme-common';
+function LastUpdatedAtDate({lastUpdatedAt, formattedLastUpdatedAt}) {
+  return (
+    <Translate
+      id="theme.lastUpdated.atDate"
+      description="The words used to describe on which date a page has been last updated"
+      values={{
+        date: (
+          <b>
             <time dateTime={new Date(lastUpdatedAt * 1000).toISOString()}>
               {formattedLastUpdatedAt}
             </time>
           </b>
-  }}>
+        ),
+      }}>
       {' on {date}'}
-    </_Translate.default>;
+    </Translate>
+  );
 }
-
-function LastUpdatedByUser({
-  lastUpdatedBy
-}) {
-  return <_Translate.default id="theme.lastUpdated.byUser" description="The words used to describe by who the page has been last updated" values={{
-    user: <b>{lastUpdatedBy}</b>
-  }}>
+function LastUpdatedByUser({lastUpdatedBy}) {
+  return (
+    <Translate
+      id="theme.lastUpdated.byUser"
+      description="The words used to describe by who the page has been last updated"
+      values={{
+        user: <b>{lastUpdatedBy}</b>,
+      }}>
       {' by {user}'}
-    </_Translate.default>;
+    </Translate>
+  );
 }
-
-function LastUpdated({
+export default function LastUpdated({
   lastUpdatedAt,
   formattedLastUpdatedAt,
-  lastUpdatedBy
+  lastUpdatedBy,
 }) {
-  return <>
-      <_Translate.default id="theme.lastUpdated.lastUpdatedAtBy" description="The sentence used to display when a page has been last updated, and by who" values={{
-      atDate: lastUpdatedAt && formattedLastUpdatedAt ? <LastUpdatedAtDate lastUpdatedAt={lastUpdatedAt} formattedLastUpdatedAt={formattedLastUpdatedAt} /> : '',
-      byUser: lastUpdatedBy ? <LastUpdatedByUser lastUpdatedBy={lastUpdatedBy} /> : ''
-    }}>
+  return (
+    <span className={ThemeClassNames.common.lastUpdated}>
+      <Translate
+        id="theme.lastUpdated.lastUpdatedAtBy"
+        description="The sentence used to display when a page has been last updated, and by who"
+        values={{
+          atDate:
+            lastUpdatedAt && formattedLastUpdatedAt ? (
+              <LastUpdatedAtDate
+                lastUpdatedAt={lastUpdatedAt}
+                formattedLastUpdatedAt={formattedLastUpdatedAt}
+              />
+            ) : (
+              ''
+            ),
+          byUser: lastUpdatedBy ? (
+            <LastUpdatedByUser lastUpdatedBy={lastUpdatedBy} />
+          ) : (
+            ''
+          ),
+        }}>
         {'Last updated{atDate}{byUser}'}
-      </_Translate.default>
-      {process.env.NODE_ENV === 'development' && <div>
+      </Translate>
+      {process.env.NODE_ENV === 'development' && (
+        <div>
+          {/* eslint-disable-next-line @docusaurus/no-untranslated-text */}
           <small> (Simulated during dev for better perf)</small>
-        </div>}
-    </>;
-}
+        </div>
+      )}
+    </span>
+  );
+}

package/lib/theme/Layout/Provider/index.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/Layout/Provider';
+export default function LayoutProvider({ children }: Props): JSX.Element;

package/lib/theme/Layout/Provider/index.js

@@ -0,0 +1,29 @@
+/**
+ * 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 {composeProviders} from '@docusaurus/theme-common';
+import {
+  ColorModeProvider,
+  TabGroupChoiceProvider,
+  AnnouncementBarProvider,
+  DocsPreferredVersionContextProvider,
+  ScrollControllerProvider,
+  NavbarProvider,
+  PluginHtmlClassNameProvider,
+} from '@docusaurus/theme-common/internal';
+const Provider = composeProviders([
+  ColorModeProvider,
+  AnnouncementBarProvider,
+  TabGroupChoiceProvider,
+  ScrollControllerProvider,
+  DocsPreferredVersionContextProvider,
+  PluginHtmlClassNameProvider,
+  NavbarProvider,
+]);
+export default function LayoutProvider({children}) {
+  return <Provider>{children}</Provider>;
+}

package/lib/theme/Layout/index.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/Layout';
+export default function Layout(props: Props): JSX.Element;

package/lib/theme/Layout/index.js

@@ -1,64 +1,53 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _SkipToContent = _interopRequireDefault(require("@theme/SkipToContent"));
-
-var _AnnouncementBar = _interopRequireDefault(require("@theme/AnnouncementBar"));
-
-var _Navbar = _interopRequireDefault(require("@theme/Navbar"));
-
-var _Footer = _interopRequireDefault(require("@theme/Footer"));
-
-var _LayoutProviders = _interopRequireDefault(require("@theme/LayoutProviders"));
-
-var _LayoutHead = _interopRequireDefault(require("@theme/LayoutHead"));
-
-var _useKeyboardNavigation = _interopRequireDefault(require("@theme/hooks/useKeyboardNavigation"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-require("./styles.css");
-
-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 Layout(props) {
+import React from 'react';
+import clsx from 'clsx';
+import ErrorBoundary from '@docusaurus/ErrorBoundary';
+import {PageMetadata, ThemeClassNames} from '@docusaurus/theme-common';
+import {useKeyboardNavigation} from '@docusaurus/theme-common/internal';
+import SkipToContent from '@theme/SkipToContent';
+import AnnouncementBar from '@theme/AnnouncementBar';
+import Navbar from '@theme/Navbar';
+import Footer from '@theme/Footer';
+import LayoutProvider from '@theme/Layout/Provider';
+import ErrorPageContent from '@theme/ErrorPageContent';
+import styles from './styles.module.css';
+export default function Layout(props) {
   const {
     children,
     noFooter,
     wrapperClassName,
-    pageClassName
+    // Not really layout-related, but kept for convenience/retro-compatibility
+    title,
+    description,
   } = props;
-  (0, _useKeyboardNavigation.default)();
-  return <_LayoutProviders.default>
-      <_LayoutHead.default {...props} />
-
-      <_SkipToContent.default />
-
-      <_AnnouncementBar.default />
-
-      <_Navbar.default />
-
-      <div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.wrapper.main, wrapperClassName, pageClassName)}>
-        {children}
+  useKeyboardNavigation();
+  return (
+    <LayoutProvider>
+      <PageMetadata title={title} description={description} />
+
+      <SkipToContent />
+
+      <AnnouncementBar />
+
+      <Navbar />
+
+      <div
+        className={clsx(
+          ThemeClassNames.wrapper.main,
+          styles.mainWrapper,
+          wrapperClassName,
+        )}>
+        <ErrorBoundary fallback={(params) => <ErrorPageContent {...params} />}>
+          {children}
+        </ErrorBoundary>
       </div>
 
-      {!noFooter && <_Footer.default />}
-    </_LayoutProviders.default>;
+      {!noFooter && <Footer />}
+    </LayoutProvider>
+  );
 }
-
-var _default = Layout;
-exports.default = _default;

package/lib/theme/Layout/{styles.css → styles.module.css}

@@ -5,23 +5,21 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-html,
-body {
+:global(html, body) {
   height: 100%;
 }
 
-#__docusaurus {
-  min-height: 100%;
-  display: flex;
-  flex-direction: column;
-}
-
-.main-wrapper {
+.mainWrapper {
   flex: 1 0 auto;
 }
 
-/* Docusaurus-specific utility classes */
-
-.docusaurus-mt-lg {
+/* Docusaurus-specific utility class */
+:global(.docusaurus-mt-lg) {
   margin-top: 3rem;
 }
+
+:global(#__docusaurus) {
+  min-height: 100%;
+  display: flex;
+  flex-direction: column;
+}

package/lib/theme/Logo/index.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/Logo';
+export default function Logo(props: Props): JSX.Element;

package/lib/theme/Logo/index.js

@@ -1,60 +1,66 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _ThemedImage = _interopRequireDefault(require("@theme/ThemedImage"));
-
-var _useBaseUrl = _interopRequireDefault(require("@docusaurus/useBaseUrl"));
-
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
-
-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 Logo = props => {
-  const {
-    siteConfig: {
-      title,
-      themeConfig: {
-        navbar: {
-          title: navbarTitle,
-          logo = {
-            src: ''
-          }
-        }
-      }
-    },
-    isClient
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    imageClassName,
-    titleClassName,
-    ...propsRest
-  } = props;
-  const logoLink = (0, _useBaseUrl.default)(logo.href || '/');
+import React from 'react';
+import Link from '@docusaurus/Link';
+import useBaseUrl from '@docusaurus/useBaseUrl';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import {useThemeConfig} from '@docusaurus/theme-common';
+import ThemedImage from '@theme/ThemedImage';
+function LogoThemedImage({logo, alt, imageClassName}) {
   const sources = {
-    light: (0, _useBaseUrl.default)(logo.src),
-    dark: (0, _useBaseUrl.default)(logo.srcDark || logo.src)
+    light: useBaseUrl(logo.src),
+    dark: useBaseUrl(logo.srcDark || logo.src),
   };
-  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} />}
+  const themedImage = (
+    <ThemedImage
+      className={logo.className}
+      sources={sources}
+      height={logo.height}
+      width={logo.width}
+      alt={alt}
+      style={logo.style}
+    />
+  );
+  // Is this extra div really necessary?
+  // introduced in https://github.com/facebook/docusaurus/pull/5666
+  return imageClassName ? (
+    <div className={imageClassName}>{themedImage}</div>
+  ) : (
+    themedImage
+  );
+}
+export default function Logo(props) {
+  const {
+    siteConfig: {title},
+  } = useDocusaurusContext();
+  const {
+    navbar: {title: navbarTitle, logo},
+  } = useThemeConfig();
+  const {imageClassName, titleClassName, ...propsRest} = props;
+  const logoLink = useBaseUrl(logo?.href || '/');
+  // If visible title is shown, fallback alt text should be
+  // an empty string to mark the logo as decorative.
+  const fallbackAlt = navbarTitle ? '' : title;
+  // Use logo alt text if provided (including empty string),
+  // and provide a sensible fallback otherwise.
+  const alt = logo?.alt ?? fallbackAlt;
+  return (
+    <Link
+      to={logoLink}
+      {...propsRest}
+      {...(logo?.target && {target: logo.target})}>
+      {logo && (
+        <LogoThemedImage
+          logo={logo}
+          alt={alt}
+          imageClassName={imageClassName}
+        />
+      )}
       {navbarTitle != null && <b className={titleClassName}>{navbarTitle}</b>}
-    </_Link.default>;
-};
-
-var _default = Logo;
-exports.default = _default;
+    </Link>
+  );
+}

package/lib/theme/MDXComponents/A.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/MDXComponents/A';
+export default function MDXA(props: Props): JSX.Element;

package/{lib-next/theme/ThemeContext.js → lib/theme/MDXComponents/A.js}

@@ -5,5 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-const ThemeContext = React.createContext(undefined);
-export default ThemeContext;
+import Link from '@docusaurus/Link';
+export default function MDXA(props) {
+  return <Link {...props} />;
+}

package/lib/theme/MDXComponents/Code.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/MDXComponents/Code';
+export default function MDXCode(props: Props): JSX.Element;