@docusaurus/theme-classic 2.0.0-beta.8bda3b2db → 2.0.0-beta.9

package/src/theme/NavbarItem/index.tsx

@@ -7,39 +7,64 @@
 
 import React from 'react';
 import DefaultNavbarItem from '@theme/NavbarItem/DefaultNavbarItem';
+import DropdownNavbarItem, {
+  Props as DropdownNavbarItemProps,
+} from '@theme/NavbarItem/DropdownNavbarItem';
 import LocaleDropdownNavbarItem from '@theme/NavbarItem/LocaleDropdownNavbarItem';
 import SearchNavbarItem from '@theme/NavbarItem/SearchNavbarItem';
-import type {Props} from '@theme/NavbarItem';
+import type {Types, Props} from '@theme/NavbarItem';
 
-const NavbarItemComponents = {
+const NavbarItemComponents: Record<
+  Exclude<Types, undefined>,
+  // TODO: properly type this
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  () => (props: any) => JSX.Element
+> = {
   default: () => DefaultNavbarItem,
   localeDropdown: () => LocaleDropdownNavbarItem,
   search: () => SearchNavbarItem,
+  dropdown: () => DropdownNavbarItem,
 
   // Need to lazy load these items as we don't know for sure the docs plugin is loaded
   // See https://github.com/facebook/docusaurus/issues/3360
-  docsVersion: () =>
-    // eslint-disable-next-line @typescript-eslint/no-var-requires, global-require
-    require('@theme/NavbarItem/DocsVersionNavbarItem').default,
+  /* eslint-disable @typescript-eslint/no-var-requires, global-require */
+  docsVersion: () => require('@theme/NavbarItem/DocsVersionNavbarItem').default,
   docsVersionDropdown: () =>
-    // eslint-disable-next-line @typescript-eslint/no-var-requires, global-require
     require('@theme/NavbarItem/DocsVersionDropdownNavbarItem').default,
-  doc: () =>
-    // eslint-disable-next-line @typescript-eslint/no-var-requires, global-require
-    require('@theme/NavbarItem/DocNavbarItem').default,
+  doc: () => require('@theme/NavbarItem/DocNavbarItem').default,
+  /* eslint-enable @typescript-eslint/no-var-requires, global-require */
 } as const;
 
-const getNavbarItemComponent = (
-  type: keyof typeof NavbarItemComponents = 'default',
-) => {
-  const navbarItemComponent = NavbarItemComponents[type];
-  if (!navbarItemComponent) {
+type NavbarItemComponentType = keyof typeof NavbarItemComponents;
+
+const getNavbarItemComponent = (type: NavbarItemComponentType) => {
+  const navbarItemComponentFn = NavbarItemComponents[type];
+  if (!navbarItemComponentFn) {
     throw new Error(`No NavbarItem component found for type "${type}".`);
   }
-  return navbarItemComponent();
+  return navbarItemComponentFn();
 };
 
+function getComponentType(
+  type: Types,
+  isDropdown: boolean,
+): NavbarItemComponentType {
+  // Backward compatibility: navbar item with no type set
+  // but containing dropdown items should use the type "dropdown"
+  if (!type || type === 'default') {
+    return isDropdown ? 'dropdown' : 'default';
+  }
+  return type as NavbarItemComponentType;
+}
+
+export const getInfimaActiveClassName = (mobile?: boolean): string =>
+  mobile ? 'menu__link--active' : 'navbar__link--active';
+
 export default function NavbarItem({type, ...props}: Props): JSX.Element {
-  const NavbarItemComponent = getNavbarItemComponent(type);
+  const componentType = getComponentType(
+    type,
+    (props as DropdownNavbarItemProps).items !== undefined,
+  );
+  const NavbarItemComponent = getNavbarItemComponent(componentType);
   return <NavbarItemComponent {...props} />;
 }

package/src/theme/Seo/index.tsx

@@ -7,8 +7,8 @@
 
 import React from 'react';
 import Head from '@docusaurus/Head';
-import {useThemeConfig, useTitleFormatter} from '@docusaurus/theme-common';
-import useBaseUrl from '@docusaurus/useBaseUrl';
+import {useTitleFormatter} from '@docusaurus/theme-common';
+import {useBaseUrlUtils} from '@docusaurus/useBaseUrl';
 
 import type {Props} from '@theme/Seo';
 
@@ -17,10 +17,11 @@ export default function Seo({
   description,
   keywords,
   image,
+  children,
 }: Props): JSX.Element {
-  const {image: defaultImage} = useThemeConfig();
   const pageTitle = useTitleFormatter(title);
-  const pageImage = useBaseUrl(image || defaultImage, {absolute: true});
+  const {withBaseUrl} = useBaseUrlUtils();
+  const pageImage = image ? withBaseUrl(image, {absolute: true}) : undefined;
 
   return (
     <Head>
@@ -41,6 +42,8 @@ export default function Seo({
 
       {pageImage && <meta property="og:image" content={pageImage} />}
       {pageImage && <meta name="twitter:image" content={pageImage} />}
+
+      {children}
     </Head>
   );
 }

package/src/theme/SkipToContent/index.tsx

@@ -6,7 +6,7 @@
  */
 
 import React, {useRef} from 'react';
-import clsx from 'clsx';
+import {useHistory} from '@docusaurus/router';
 import Translate from '@docusaurus/Translate';
 import {useLocationChange} from '@docusaurus/theme-common';
 
@@ -20,6 +20,7 @@ function programmaticFocus(el: HTMLElement) {
 
 function SkipToContent(): JSX.Element {
   const containerRef = useRef<HTMLDivElement>(null);
+  const {action} = useHistory();
   const handleSkip = (e: React.MouseEvent<HTMLAnchorElement>) => {
     e.preventDefault();
 
@@ -33,17 +34,15 @@ function SkipToContent(): JSX.Element {
   };
 
   useLocationChange(({location}) => {
-    if (containerRef.current && !location.hash) {
+    if (containerRef.current && !location.hash && action === 'PUSH') {
       programmaticFocus(containerRef.current);
     }
   });
 
   return (
     <div ref={containerRef}>
-      <a
-        href="#main"
-        className={clsx(styles.skipToContent, 'shadow--md')}
-        onClick={handleSkip}>
+      {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
+      <a href="#" className={styles.skipToContent} onClick={handleSkip}>
         <Translate
           id="theme.common.skipToMainContent"
           description="The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation">

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

@@ -10,4 +10,5 @@
 
 .skipToContent:focus {
   left: 1rem;
+  box-shadow: var(--ifm-global-shadow-md);
 }

package/src/theme/TOC/index.tsx

@@ -7,52 +7,23 @@
 
 import React from 'react';
 import clsx from 'clsx';
-import useTOCHighlight from '@theme/hooks/useTOCHighlight';
 import type {TOCProps} from '@theme/TOC';
+import TOCItems from '@theme/TOCItems';
 import styles from './styles.module.css';
-import {TOCItem} from '@docusaurus/types';
 
-const LINK_CLASS_NAME = 'table-of-contents__link';
-const ACTIVE_LINK_CLASS_NAME = 'table-of-contents__link--active';
-const TOP_OFFSET = 100;
+// Using a custom className
+// This prevents TOC highlighting to highlight TOCInline/TOCCollapsible by mistake
+const LINK_CLASS_NAME = 'table-of-contents__link toc-highlight';
+const LINK_ACTIVE_CLASS_NAME = 'table-of-contents__link--active';
 
-/* eslint-disable jsx-a11y/control-has-associated-label */
-function Headings({
-  toc,
-  isChild,
-}: {
-  toc: readonly TOCItem[];
-  isChild?: boolean;
-}) {
-  if (!toc.length) {
-    return null;
-  }
+function TOC({className, ...props}: TOCProps): JSX.Element {
   return (
-    <ul
-      className={
-        isChild ? '' : 'table-of-contents table-of-contents__left-border'
-      }>
-      {toc.map((heading) => (
-        <li key={heading.id}>
-          <a
-            href={`#${heading.id}`}
-            className={LINK_CLASS_NAME}
-            // Developer provided the HTML, so assume it's safe.
-            // eslint-disable-next-line react/no-danger
-            dangerouslySetInnerHTML={{__html: heading.value}}
-          />
-          <Headings isChild toc={heading.children} />
-        </li>
-      ))}
-    </ul>
-  );
-}
-
-function TOC({toc}: TOCProps): JSX.Element {
-  useTOCHighlight(LINK_CLASS_NAME, ACTIVE_LINK_CLASS_NAME, TOP_OFFSET);
-  return (
-    <div className={clsx(styles.tableOfContents, 'thin-scrollbar')}>
-      <Headings toc={toc} />
+    <div className={clsx(styles.tableOfContents, 'thin-scrollbar', className)}>
+      <TOCItems
+        {...props}
+        linkClassName={LINK_CLASS_NAME}
+        linkActiveClassName={LINK_ACTIVE_CLASS_NAME}
+      />
     </div>
   );
 }

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

@@ -12,7 +12,7 @@
   top: calc(var(--ifm-navbar-height) + 1rem);
 }
 
-@media only screen and (max-width: 996px) {
+@media (max-width: 996px) {
   .tableOfContents {
     display: none;
   }

package/src/theme/TOCCollapsible/index.tsx

@@ -0,0 +1,58 @@
+/**
+ * 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 clsx from 'clsx';
+import Translate from '@docusaurus/Translate';
+import {useCollapsible, Collapsible} from '@docusaurus/theme-common';
+import styles from './styles.module.css';
+import TOCItems from '@theme/TOCItems';
+import type {TOCCollapsibleProps} from '@theme/TOCCollapsible';
+
+export default function TOCCollapsible({
+  toc,
+  className,
+  minHeadingLevel,
+  maxHeadingLevel,
+}: TOCCollapsibleProps): JSX.Element {
+  const {collapsed, toggleCollapsed} = useCollapsible({
+    initialState: true,
+  });
+
+  return (
+    <div
+      className={clsx(
+        styles.tocCollapsible,
+        {
+          [styles.tocCollapsibleExpanded]: !collapsed,
+        },
+        className,
+      )}>
+      <button
+        type="button"
+        className={clsx('clean-btn', styles.tocCollapsibleButton)}
+        onClick={toggleCollapsed}>
+        <Translate
+          id="theme.TOCCollapsible.toggleButtonLabel"
+          description="The label used by the button on the collapsible TOC component">
+          On this page
+        </Translate>
+      </button>
+
+      <Collapsible
+        lazy
+        className={styles.tocCollapsibleContent}
+        collapsed={collapsed}>
+        <TOCItems
+          toc={toc}
+          minHeadingLevel={minHeadingLevel}
+          maxHeadingLevel={maxHeadingLevel}
+        />
+      </Collapsible>
+    </div>
+  );
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+
+.tocCollapsible {
+  background-color: var(--ifm-menu-color-background-active);
+  border-radius: var(--ifm-global-radius);
+  margin: 1rem 0;
+}
+
+.tocCollapsibleButton {
+  font-size: inherit;
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  padding: 0.4rem 0.8rem;
+  width: 100%;
+}
+
+.tocCollapsibleButton:after {
+  content: '';
+  background: var(--ifm-menu-link-sublist-icon) 50% 50% / 2rem 2rem no-repeat;
+  filter: var(--ifm-menu-link-sublist-icon-filter);
+  height: 1.25rem;
+  width: 1.25rem;
+  transform: rotate(180deg);
+  transition: transform var(--ifm-transition-fast);
+}
+
+.tocCollapsibleContent > ul {
+  border-left: none;
+  border-top: 1px solid var(--ifm-color-emphasis-300);
+  padding: 0.2rem 0;
+  font-size: 15px;
+}
+
+.tocCollapsibleContent ul li {
+  margin: 0.4rem 0.8rem;
+}
+
+.tocCollapsibleContent a {
+  display: block;
+}
+
+.tocCollapsibleExpanded .tocCollapsibleButton:after {
+  transform: none;
+}

package/src/theme/TOCInline/index.tsx

@@ -6,43 +6,24 @@
  */
 
 import React from 'react';
-import clsx from 'clsx';
 import type {TOCInlineProps} from '@theme/TOCInline';
 import styles from './styles.module.css';
-import {TOCItem} from '@docusaurus/types';
+import TOCItems from '@theme/TOCItems';
 
-/* eslint-disable jsx-a11y/control-has-associated-label */
-function HeadingsInline({
+function TOCInline({
   toc,
-  isChild,
-}: {
-  toc: readonly TOCItem[];
-  isChild?: boolean;
-}) {
-  if (!toc.length) {
-    return null;
-  }
+  minHeadingLevel,
+  maxHeadingLevel,
+}: TOCInlineProps): JSX.Element {
   return (
-    <ul className={isChild ? '' : 'table-of-contents'}>
-      {toc.map((heading) => (
-        <li key={heading.id}>
-          <a
-            href={`#${heading.id}`}
-            // Developer provided the HTML, so assume it's safe.
-            // eslint-disable-next-line react/no-danger
-            dangerouslySetInnerHTML={{__html: heading.value}}
-          />
-          <HeadingsInline isChild toc={heading.children} />
-        </li>
-      ))}
-    </ul>
-  );
-}
-
-function TOCInline({toc}: TOCInlineProps): JSX.Element {
-  return (
-    <div className={clsx(styles.tableOfContentsInline)}>
-      <HeadingsInline toc={toc} />
+    <div className={styles.tableOfContentsInline}>
+      <TOCItems
+        toc={toc}
+        minHeadingLevel={minHeadingLevel}
+        maxHeadingLevel={maxHeadingLevel}
+        className="table-of-contents"
+        linkClassName={null}
+      />
     </div>
   );
 }

package/src/theme/TOCItems/index.tsx

@@ -0,0 +1,96 @@
+/**
+ * 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, {useMemo} from 'react';
+import type {TOCItemsProps} from '@theme/TOCItems';
+import {TOCItem} from '@docusaurus/types';
+import {
+  TOCHighlightConfig,
+  useThemeConfig,
+  useTOCFilter,
+  useTOCHighlight,
+} from '@docusaurus/theme-common';
+
+// Recursive component rendering the toc tree
+/* eslint-disable jsx-a11y/control-has-associated-label */
+function TOCItemList({
+  toc,
+  className,
+  linkClassName,
+  isChild,
+}: {
+  readonly toc: readonly TOCItem[];
+  readonly className: string;
+  readonly linkClassName: string | null;
+  readonly isChild?: boolean;
+}): JSX.Element | null {
+  if (!toc.length) {
+    return null;
+  }
+  return (
+    <ul className={isChild ? undefined : className}>
+      {toc.map((heading) => (
+        <li key={heading.id}>
+          <a
+            href={`#${heading.id}`}
+            className={linkClassName ?? undefined}
+            // Developer provided the HTML, so assume it's safe.
+            // eslint-disable-next-line react/no-danger
+            dangerouslySetInnerHTML={{__html: heading.value}}
+          />
+          <TOCItemList
+            isChild
+            toc={heading.children}
+            className={className}
+            linkClassName={linkClassName}
+          />
+        </li>
+      ))}
+    </ul>
+  );
+}
+
+export default function TOCItems({
+  toc,
+  className = 'table-of-contents table-of-contents__left-border',
+  linkClassName = 'table-of-contents__link',
+  linkActiveClassName = undefined,
+  minHeadingLevel: minHeadingLevelOption,
+  maxHeadingLevel: maxHeadingLevelOption,
+  ...props
+}: TOCItemsProps): JSX.Element | null {
+  const themeConfig = useThemeConfig();
+
+  const minHeadingLevel =
+    minHeadingLevelOption ?? themeConfig.tableOfContents.minHeadingLevel;
+  const maxHeadingLevel =
+    maxHeadingLevelOption ?? themeConfig.tableOfContents.maxHeadingLevel;
+
+  const tocFiltered = useTOCFilter({toc, minHeadingLevel, maxHeadingLevel});
+
+  const tocHighlightConfig: TOCHighlightConfig | undefined = useMemo(() => {
+    if (linkClassName && linkActiveClassName) {
+      return {
+        linkClassName,
+        linkActiveClassName,
+        minHeadingLevel,
+        maxHeadingLevel,
+      };
+    }
+    return undefined;
+  }, [linkClassName, linkActiveClassName, minHeadingLevel, maxHeadingLevel]);
+  useTOCHighlight(tocHighlightConfig);
+
+  return (
+    <TOCItemList
+      toc={tocFiltered}
+      className={className}
+      linkClassName={linkClassName}
+      {...props}
+    />
+  );
+}

package/src/theme/Tabs/__tests__/index.test.tsx

@@ -0,0 +1,129 @@
+/**
+ * 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 renderer from 'react-test-renderer';
+import Tabs from '../index';
+import TabItem from '../../TabItem';
+import UserPreferencesProvider from '@theme/UserPreferencesProvider';
+import {ScrollControllerProvider} from '@docusaurus/theme-common';
+
+describe('Tabs', () => {
+  test('Should reject bad Tabs child', () => {
+    expect(() => {
+      renderer.create(
+        <Tabs>
+          <div>Naughty</div>
+          <TabItem value="good">Good</TabItem>
+        </Tabs>,
+      );
+    }).toThrowErrorMatchingInlineSnapshot(
+      `"Docusaurus error: Bad <Tabs> child <div>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique \\"value\\" prop."`,
+    );
+  });
+  test('Should reject bad Tabs defaultValue', () => {
+    expect(() => {
+      renderer.create(
+        <Tabs defaultValue="bad">
+          <TabItem value="v1">Tab 1</TabItem>
+          <TabItem value="v2">Tab 2</TabItem>
+        </Tabs>,
+      );
+    }).toThrowErrorMatchingInlineSnapshot(
+      `"Docusaurus error: The <Tabs> has a defaultValue \\"bad\\" but none of its children has the corresponding value. Available values are: v1, v2. If you intend to show no default tab, use defaultValue={null} instead."`,
+    );
+  });
+  test('Should reject duplicate values', () => {
+    expect(() => {
+      renderer.create(
+        <Tabs>
+          <TabItem value="v1">Tab 1</TabItem>
+          <TabItem value="v2">Tab 2</TabItem>
+          <TabItem value="v3">Tab 3</TabItem>
+          <TabItem value="v4">Tab 4</TabItem>
+          <TabItem value="v1">Tab 5</TabItem>
+          <TabItem value="v2">Tab 6</TabItem>
+        </Tabs>,
+      );
+    }).toThrowErrorMatchingInlineSnapshot(
+      `"Docusaurus error: Duplicate values \\"v1, v2\\" found in <Tabs>. Every value needs to be unique."`,
+    );
+  });
+  test('Should accept valid Tabs config', () => {
+    expect(() => {
+      renderer.create(
+        <ScrollControllerProvider>
+          <UserPreferencesProvider>
+            <Tabs>
+              <TabItem value="v1">Tab 1</TabItem>
+              <TabItem value="v2">Tab 2</TabItem>
+            </Tabs>
+            <Tabs>
+              <TabItem value="v1">Tab 1</TabItem>
+              <TabItem value="v2" default>
+                Tab 2
+              </TabItem>
+            </Tabs>
+            <Tabs defaultValue="v1">
+              <TabItem value="v1" label="V1">
+                Tab 1
+              </TabItem>
+              <TabItem value="v2" label="V2">
+                Tab 2
+              </TabItem>
+            </Tabs>
+            <Tabs
+              defaultValue="v1"
+              values={[
+                {value: 'v1', label: 'V1'},
+                {value: 'v2', label: 'V2'},
+              ]}>
+              <TabItem value="v1">Tab 1</TabItem>
+              <TabItem value="v2">Tab 2</TabItem>
+            </Tabs>
+            <Tabs
+              defaultValue={null}
+              values={[
+                {value: 'v1', label: 'V1'},
+                {value: 'v2', label: 'V2'},
+              ]}>
+              <TabItem value="v1">Tab 1</TabItem>
+              <TabItem value="v2">Tab 2</TabItem>
+            </Tabs>
+            <Tabs defaultValue={null}>
+              <TabItem value="v1" label="V1">
+                Tab 1
+              </TabItem>
+              <TabItem value="v2" label="V2">
+                Tab 2
+              </TabItem>
+            </Tabs>
+          </UserPreferencesProvider>
+        </ScrollControllerProvider>,
+      );
+    }).not.toThrow(); // TODO Better Jest infrastructure to mock the Layout
+  });
+  // https://github.com/facebook/docusaurus/issues/5729
+  test('Should accept dynamic Tabs with number values', () => {
+    expect(() => {
+      const tabs = ['Apple', 'Banana', 'Carrot'];
+      renderer.create(
+        <ScrollControllerProvider>
+          <UserPreferencesProvider>
+            <Tabs
+              values={tabs.map((t, idx) => ({label: t, value: idx}))}
+              defaultValue={0}>
+              {tabs.map((t, idx) => (
+                <TabItem value={idx}>{t}</TabItem>
+              ))}
+            </Tabs>
+          </UserPreferencesProvider>
+        </ScrollControllerProvider>,
+      );
+    }).not.toThrow();
+  });
+});