@docusaurus/theme-classic 2.0.0-beta.1ab8aa0af → 2.0.0-beta.2

package/src/theme/LastUpdated/index.tsx

@@ -6,7 +6,6 @@
  */
 
 import React from 'react';
-import styles from './styles.module.css';
 import Translate from '@docusaurus/Translate';
 import type {Props} from '@theme/LastUpdated';
 
@@ -23,11 +22,11 @@ function LastUpdatedAtDate({
       description="The words used to describe on which date a page has been last updated"
       values={{
         date: (
-          <time
-            dateTime={new Date(lastUpdatedAt * 1000).toISOString()}
-            className={styles.lastUpdatedDate}>
-            {formattedLastUpdatedAt}
-          </time>
+          <b>
+            <time dateTime={new Date(lastUpdatedAt * 1000).toISOString()}>
+              {formattedLastUpdatedAt}
+            </time>
+          </b>
         ),
       }}>
       {' on {date}'}
@@ -45,7 +44,7 @@ function LastUpdatedByUser({
       id="theme.lastUpdated.byUser"
       description="The words used to describe by who the page has been last updated"
       values={{
-        user: <strong>{lastUpdatedBy}</strong>,
+        user: <b>{lastUpdatedBy}</b>,
       }}>
       {' by {user}'}
     </Translate>
@@ -58,37 +57,33 @@ export default function LastUpdated({
   lastUpdatedBy,
 }: Props): JSX.Element {
   return (
-    <div className="col text--right">
-      <em>
-        <small>
-          <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>
-          {process.env.NODE_ENV === 'development' && (
-            <div>
-              <small> (Simulated during dev for better perf)</small>
-            </div>
-          )}
-        </small>
-      </em>
-    </div>
+    <>
+      <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>
+      {process.env.NODE_ENV === 'development' && (
+        <div>
+          <small> (Simulated during dev for better perf)</small>
+        </div>
+      )}
+    </>
   );
 }

package/src/theme/Layout/styles.css

@@ -19,3 +19,9 @@ body {
 .main-wrapper {
   flex: 1 0 auto;
 }
+
+/* Docusaurus-specific utility classes */
+
+.docusaurus-mt-lg {
+  margin-top: 3rem;
+}

package/src/theme/LayoutHead/index.tsx

@@ -85,7 +85,7 @@ export default function LayoutHead(props: Props): JSX.Element {
   const {
     siteConfig: {
       favicon,
-      themeConfig: {metadatas},
+      themeConfig: {metadatas, image: defaultImage},
     },
     i18n: {currentLocale, localeConfigs},
   } = useDocusaurusContext();
@@ -105,6 +105,10 @@ export default function LayoutHead(props: Props): JSX.Element {
         {favicon && <link rel="shortcut icon" href={faviconUrl} />}
         <title>{pageTitle}</title>
         <meta property="og:title" content={pageTitle} />
+        {image ||
+          (defaultImage && (
+            <meta name="twitter:card" content="summary_large_image" />
+          ))}
       </Head>
 
       <Seo {...{description, keywords, image}} />

package/src/theme/LayoutProviders/index.tsx

@@ -8,17 +8,22 @@
 import React from 'react';
 import ThemeProvider from '@theme/ThemeProvider';
 import UserPreferencesProvider from '@theme/UserPreferencesProvider';
-import {DocsPreferredVersionContextProvider} from '@docusaurus/theme-common';
+import {
+  AnnouncementBarProvider,
+  DocsPreferredVersionContextProvider,
+} from '@docusaurus/theme-common';
 import type {Props} from '@theme/LayoutProviders';
 
 export default function LayoutProviders({children}: Props): JSX.Element {
   return (
     <ThemeProvider>
-      <UserPreferencesProvider>
-        <DocsPreferredVersionContextProvider>
-          {children}
-        </DocsPreferredVersionContextProvider>
-      </UserPreferencesProvider>
+      <AnnouncementBarProvider>
+        <UserPreferencesProvider>
+          <DocsPreferredVersionContextProvider>
+            {children}
+          </DocsPreferredVersionContextProvider>
+        </UserPreferencesProvider>
+      </AnnouncementBarProvider>
     </ThemeProvider>
   );
 }

package/src/theme/Logo/index.tsx

@@ -12,13 +12,17 @@ import Link from '@docusaurus/Link';
 import ThemedImage from '@theme/ThemedImage';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import {useThemeConfig} from '@docusaurus/theme-common';
 
 const Logo = (props: Props): JSX.Element => {
-  const {isClient} = useDocusaurusContext();
   const {
-    navbar: {title, logo = {src: ''}},
-  } = useThemeConfig();
+    siteConfig: {
+      title,
+      themeConfig: {
+        navbar: {title: navbarTitle, logo = {src: ''}},
+      },
+    },
+    isClient,
+  } = useDocusaurusContext();
 
   const {imageClassName, titleClassName, ...propsRest} = props;
   const logoLink = useBaseUrl(logo.href || '/');
@@ -37,10 +41,10 @@ const Logo = (props: Props): JSX.Element => {
           key={isClient}
           className={imageClassName}
           sources={sources}
-          alt={logo.alt || title || 'Logo'}
+          alt={logo.alt || navbarTitle || title}
         />
       )}
-      {title != null && <strong className={titleClassName}>{title}</strong>}
+      {navbarTitle != null && <b className={titleClassName}>{navbarTitle}</b>}
     </Link>
   );
 };

package/src/theme/MDXPage/index.tsx

@@ -6,6 +6,7 @@
  */
 
 import React from 'react';
+import clsx from 'clsx';
 import Layout from '@theme/Layout';
 import {MDXProvider} from '@mdx-js/react';
 import MDXComponents from '@theme/MDXComponents';
@@ -13,6 +14,8 @@ import type {Props} from '@theme/MDXPage';
 import TOC from '@theme/TOC';
 import {ThemeClassNames} from '@docusaurus/theme-common';
 
+import styles from './styles.module.css';
+
 function MDXPage(props: Props): JSX.Element {
   const {content: MDXPageContent} = props;
   const {frontMatter, metadata} = MDXPageContent;
@@ -32,24 +35,18 @@ function MDXPage(props: Props): JSX.Element {
       permalink={permalink}
       wrapperClassName={wrapperClassName ?? ThemeClassNames.wrapper.mdxPages}
       pageClassName={ThemeClassNames.page.mdxPage}>
-      <main>
-        <div className="container container--fluid">
-          <div className="margin-vert--lg padding-vert--lg">
-            <div className="row">
-              <div className="col col--8 col--offset-2">
-                <div className="container">
-                  <MDXProvider components={MDXComponents}>
-                    <MDXPageContent />
-                  </MDXProvider>
-                </div>
-              </div>
-              {!hideTableOfContents && MDXPageContent.toc && (
-                <div className="col col--2">
-                  <TOC toc={MDXPageContent.toc} />
-                </div>
-              )}
-            </div>
+      <main className="container container--fluid margin-vert--lg">
+        <div className={clsx('row', styles.mdxPageWrapper)}>
+          <div className={clsx('col', !hideTableOfContents && 'col--8')}>
+            <MDXProvider components={MDXComponents}>
+              <MDXPageContent />
+            </MDXProvider>
           </div>
+          {!hideTableOfContents && MDXPageContent.toc && (
+            <div className="col col--2">
+              <TOC toc={MDXPageContent.toc} />
+            </div>
+          )}
         </div>
       </main>
     </Layout>

package/{lib/theme/LastUpdated → src/theme/MDXPage}/styles.module.css

@@ -5,6 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-.lastUpdatedDate {
-  font-weight: bold;
+.mdxPageWrapper {
+  justify-content: center;
 }

package/src/theme/Navbar/index.tsx

@@ -88,7 +88,7 @@ function Navbar(): JSX.Element {
           {items != null && items.length !== 0 && (
             <button
               aria-label="Navigation bar toggle"
-              className="navbar__toggle"
+              className="navbar__toggle clean-btn"
               type="button"
               tabIndex={0}
               onClick={showSidebar}
@@ -99,7 +99,7 @@ function Navbar(): JSX.Element {
           <Logo
             className="navbar__brand"
             imageClassName="navbar__logo"
-            titleClassName={clsx('navbar__title')}
+            titleClassName="navbar__title"
           />
           {leftItems.map((item, i) => (
             <NavbarItem {...item} key={i} />

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

@@ -16,5 +16,5 @@
 }
 
 .navbarHidden {
-  transform: translate3d(0, calc(var(--ifm-navbar-height) * -1), 0);
+  transform: translate3d(0, calc(-100% - 2px), 0);
 }

package/src/theme/NavbarItem/DefaultNavbarItem.tsx

@@ -16,6 +16,10 @@ import type {
   DesktopOrMobileNavBarItemProps,
   Props,
 } from '@theme/NavbarItem/DefaultNavbarItem';
+import IconExternalLink from '@theme/IconExternalLink';
+import isInternalUrl from '@docusaurus/isInternalUrl';
+
+const dropdownLinkActiveClass = 'dropdown__link--active';
 
 function NavLink({
   activeBasePath,
@@ -32,6 +36,8 @@ function NavLink({
   const toUrl = useBaseUrl(to);
   const activeBaseUrl = useBaseUrl(activeBasePath);
   const normalizedHref = useBaseUrl(href, {forcePrependBaseUrl: true});
+  const isExternalLink = label && href && !isInternalUrl(href);
+  const isDropdownLink = activeClassName === dropdownLinkActiveClass;
 
   return (
     <Link
@@ -53,7 +59,14 @@ function NavLink({
               : null),
           })}
       {...props}>
-      {label}
+      {isExternalLink ? (
+        <span>
+          {label}
+          <IconExternalLink {...(isDropdownLink && {width: 12, height: 12})} />
+        </span>
+      ) : (
+        label
+      )}
     </Link>
   );
 }
@@ -137,7 +150,7 @@ function NavItemDesktop({
                   }
                 }
               }}
-              activeClassName="dropdown__link--active"
+              activeClassName={dropdownLinkActiveClass}
               className={navLinkClassNames(childItemClassName, true)}
               {...childItemProps}
             />

package/src/theme/NavbarItem/DocNavbarItem.tsx

@@ -11,6 +11,30 @@ import {useLatestVersion, useActiveDocContext} from '@theme/hooks/useDocs';
 import clsx from 'clsx';
 import type {Props} from '@theme/NavbarItem/DocNavbarItem';
 import {useDocsPreferredVersion} from '@docusaurus/theme-common';
+import {uniq} from '@docusaurus/utils-common';
+import type {
+  GlobalDataVersion,
+  GlobalDataDoc,
+} from '@docusaurus/plugin-content-docs-types';
+
+function getDocInVersions(versions: GlobalDataVersion[], docId: string) {
+  // vanilla-js flatten, TODO replace soon by ES flat() / flatMap()
+  const allDocs: GlobalDataDoc[] = [].concat(
+    ...versions.map((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;
+}
 
 export default function DocNavbarItem({
   docId,
@@ -23,16 +47,11 @@ export default function DocNavbarItem({
   const {preferredVersion} = useDocsPreferredVersion(docsPluginId);
   const latestVersion = useLatestVersion(docsPluginId);
 
-  const version = activeVersion ?? preferredVersion ?? latestVersion;
-
-  const doc = version.docs.find((versionDoc) => versionDoc.id === docId);
-  if (!doc) {
-    const docIds = version.docs.map((versionDoc) => versionDoc.id).join('\n- ');
-    throw new Error(
-      `DocNavbarItem: couldn't find any doc with id=${docId} in version ${version.name}.
-Available docIds=\n- ${docIds}`,
-    );
-  }
+  // Versions used to look for the doc to link to, ordered + no duplicate
+  const versions: GlobalDataVersion[] = uniq(
+    [activeVersion, preferredVersion, latestVersion].filter(Boolean),
+  );
+  const doc = getDocInVersions(versions, docId);
 
   return (
     <DefaultNavbarItem

package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx

@@ -68,14 +68,15 @@ export default function DocsVersionDropdownNavbarItem({
     return items;
   }
 
+  const items = getItems();
+
   const dropdownVersion =
     activeDocContext.activeVersion ?? preferredVersion ?? latestVersion;
 
-  // Mobile is handled a bit differently
-  const dropdownLabel = mobile ? 'Versions' : dropdownVersion.label;
-  const dropdownTo = mobile
-    ? undefined
-    : getVersionMainDoc(dropdownVersion).path;
+  // Mobile dropdown is handled a bit differently
+  const dropdownLabel = mobile && items ? 'Versions' : dropdownVersion.label;
+  const dropdownTo =
+    mobile && items ? undefined : getVersionMainDoc(dropdownVersion).path;
 
   return (
     <DefaultNavbarItem
@@ -83,7 +84,7 @@ export default function DocsVersionDropdownNavbarItem({
       mobile={mobile}
       label={dropdownLabel}
       to={dropdownTo}
-      items={getItems()}
+      items={items}
       isActive={dropdownActiveClassDisabled ? () => false : undefined}
     />
   );

package/src/theme/NavbarItem/SearchNavbarItem.tsx

@@ -8,16 +8,11 @@
 import React from 'react';
 import type {Props} from '@theme/NavbarItem/SearchNavbarItem';
 import SearchBar from '@theme/SearchBar';
-import styles from './styles.module.css';
 
 export default function SearchNavbarItem({mobile}: Props): JSX.Element | null {
   if (mobile) {
     return null;
   }
 
-  return (
-    <div className={styles.searchWrapper}>
-      <SearchBar />
-    </div>
-  );
+  return <SearchBar />;
 }

package/src/theme/NavbarItem/index.tsx

@@ -34,7 +34,7 @@ const getNavbarItemComponent = (
 ) => {
   const navbarItemComponent = NavbarItemComponents[type];
   if (!navbarItemComponent) {
-    throw new Error(`No NavbarItem component found for type=${type}.`);
+    throw new Error(`No NavbarItem component found for type "${type}".`);
   }
   return navbarItemComponent();
 };

package/src/theme/NotFound.tsx

@@ -7,11 +7,15 @@
 
 import React from 'react';
 import Layout from '@theme/Layout';
-import Translate from '@docusaurus/Translate';
+import Translate, {translate} from '@docusaurus/Translate';
 
 function NotFound(): JSX.Element {
   return (
-    <Layout title="Page Not Found">
+    <Layout
+      title={translate({
+        id: 'theme.NotFound.title',
+        message: 'Page Not Found',
+      })}>
       <main className="container margin-vert--xl">
         <div className="row">
           <div className="col col--6 col--offset-3">

package/src/theme/SearchMetadatas/index.tsx

@@ -20,7 +20,7 @@ export default function SearchMetadatas({
 }: Props): JSX.Element {
   return (
     <Head>
-      {locale && <meta name="docusaurus_locale" content={`${locale}`} />}
+      {locale && <meta name="docusaurus_locale" content={locale} />}
       {version && <meta name="docusaurus_version" content={version} />}
       {tag && <meta name="docusaurus_tag" content={tag} />}
     </Head>

package/src/theme/Seo/index.tsx

@@ -41,7 +41,6 @@ export default function Seo({
 
       {pageImage && <meta property="og:image" content={pageImage} />}
       {pageImage && <meta name="twitter:image" content={pageImage} />}
-      {pageImage && <meta name="twitter:card" content="summary_large_image" />}
     </Head>
   );
 }

package/src/theme/SkipToContent/index.tsx

@@ -7,7 +7,7 @@
 
 import React, {useRef} from 'react';
 import Translate from '@docusaurus/Translate';
-import {useChangeRoute} from '@docusaurus/theme-common';
+import {useLocationChange} from '@docusaurus/theme-common';
 
 import styles from './styles.module.css';
 
@@ -31,8 +31,8 @@ function SkipToContent(): JSX.Element {
     }
   };
 
-  useChangeRoute(() => {
-    if (containerRef.current) {
+  useLocationChange(({location}) => {
+    if (containerRef.current && !location.hash) {
       programmaticFocus(containerRef.current);
     }
   });

package/src/theme/SkipToContent/styles.module.css

@@ -6,11 +6,9 @@
   padding: calc(var(--ifm-global-spacing) / 2) var(--ifm-global-spacing);
   color: var(--ifm-color-emphasis-900);
   background-color: var(--ifm-background-surface-color);
-  border-radius: var(--ifm-global-radius);
-  font: inherit;
-  border: none;
 }
 
 .skipToContent:focus {
   left: 1rem;
+  box-shadow: var(--ifm-global-shadow-md);
 }

package/src/theme/TOC/styles.module.css

@@ -9,7 +9,7 @@
   max-height: calc(100vh - (var(--ifm-navbar-height) + 2rem));
   overflow-y: auto;
   position: sticky;
-  top: calc(var(--ifm-navbar-height) + 2rem);
+  top: calc(var(--ifm-navbar-height) + 1rem);
 }
 
 @media only screen and (max-width: 996px) {

package/src/theme/ThemedImage/index.tsx

@@ -21,10 +21,10 @@ const ThemedImage = (props: Props): JSX.Element => {
 
   type SourceName = keyof Props['sources'];
 
+  const clientThemes: SourceName[] = isDarkTheme ? ['dark'] : ['light'];
+
   const renderedSourceNames: SourceName[] = isClient
-    ? isDarkTheme
-      ? ['dark']
-      : ['light']
+    ? clientThemes
     : // We need to render both images on the server to avoid flash
       // See https://github.com/facebook/docusaurus/pull/3730
       ['light', 'dark'];

package/src/theme/ThemedImage/styles.module.css

@@ -1,3 +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.
+ */
+
 .themedImage {
   display: none;
 }

package/src/theme/Toggle/index.tsx

@@ -11,6 +11,7 @@ import {useThemeConfig} from '@docusaurus/theme-common';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 
 import clsx from 'clsx';
+import './styles.css';
 import styles from './styles.module.css';
 
 interface IconProps {
@@ -44,22 +45,6 @@ const Toggle = memo(
     const [checked, setChecked] = useState(defaultChecked);
     const [focused, setFocused] = useState(false);
     const inputRef = useRef<HTMLInputElement>(null);
-    const handleToggle = (e) => {
-      const checkbox = inputRef.current;
-
-      if (!checkbox) {
-        return;
-      }
-
-      if (e.target !== checkbox) {
-        e.preventDefault();
-        checkbox.focus();
-        checkbox.click();
-        return;
-      }
-
-      setChecked(checkbox?.checked);
-    };
 
     return (
       <div
@@ -67,15 +52,16 @@ const Toggle = memo(
           'react-toggle--checked': checked,
           'react-toggle--focus': focused,
           'react-toggle--disabled': disabled,
-        })}
-        role="button"
-        tabIndex={-1}
-        onClick={handleToggle}>
-        <div className="react-toggle-track">
+        })}>
+        <div
+          className="react-toggle-track"
+          role="button"
+          tabIndex={-1}
+          onClick={() => inputRef.current?.click()}>
           <div className="react-toggle-track-check">{icons.checked}</div>
           <div className="react-toggle-track-x">{icons.unchecked}</div>
+          <div className="react-toggle-thumb" />
         </div>
-        <div className="react-toggle-thumb" />
 
         <input
           ref={inputRef}
@@ -84,6 +70,7 @@ const Toggle = memo(
           className="react-toggle-screenreader-only"
           aria-label="Switch between dark and light mode"
           onChange={onChange}
+          onClick={() => setChecked(!checked)}
           onFocus={() => setFocused(true)}
           onBlur={() => setFocused(false)}
         />