@docusaurus/theme-classic 2.0.0-beta.0f144213d → 2.0.0-beta.11

package/lib-next/theme/Seo/index.js

@@ -6,14 +6,16 @@
  */
 import React from 'react';
 import Head from '@docusaurus/Head';
-import {useThemeConfig, useTitleFormatter} from '@docusaurus/theme-common';
-import useBaseUrl from '@docusaurus/useBaseUrl';
-export default function Seo({title, description, keywords, image}) {
-  const {image: defaultImage} = useThemeConfig();
+import {useTitleFormatter} from '@docusaurus/theme-common';
+import {useBaseUrlUtils} from '@docusaurus/useBaseUrl';
+export default function Seo({title, description, keywords, image, children}) {
   const pageTitle = useTitleFormatter(title);
-  const pageImage = useBaseUrl(image || defaultImage, {
-    absolute: true,
-  });
+  const {withBaseUrl} = useBaseUrlUtils();
+  const pageImage = image
+    ? withBaseUrl(image, {
+        absolute: true,
+      })
+    : undefined;
   return (
     <Head>
       {title && <title>{pageTitle}</title>}
@@ -31,6 +33,8 @@ export default function Seo({title, description, keywords, image}) {
 
       {pageImage && <meta property="og:image" content={pageImage} />}
       {pageImage && <meta name="twitter:image" content={pageImage} />}
+
+      {children}
     </Head>
   );
 }

package/lib-next/theme/SkipToContent/index.js

@@ -32,13 +32,14 @@ function SkipToContent() {
   };
 
   useLocationChange(({location}) => {
-    if (containerRef.current && !location.hash && action !== 'POP') {
+    if (containerRef.current && !location.hash && action === 'PUSH') {
       programmaticFocus(containerRef.current);
     }
   });
   return (
     <div ref={containerRef}>
-      <a href="#main" className={styles.skipToContent} 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/lib-next/theme/TOC/index.js

@@ -6,45 +6,21 @@
  */
 import React from 'react';
 import clsx from 'clsx';
-import useTOCHighlight from '@theme/hooks/useTOCHighlight';
-import styles from './styles.module.css';
-const LINK_CLASS_NAME = 'table-of-contents__link';
-const ACTIVE_LINK_CLASS_NAME = 'table-of-contents__link--active';
-const TOP_OFFSET = 100;
-/* eslint-disable jsx-a11y/control-has-associated-label */
+import TOCItems from '@theme/TOCItems';
+import styles from './styles.module.css'; // Using a custom className
+// This prevents TOC highlighting to highlight TOCInline/TOCCollapsible by mistake
 
-function Headings({toc, isChild}) {
-  if (!toc.length) {
-    return null;
-  }
+const LINK_CLASS_NAME = 'table-of-contents__link toc-highlight';
+const LINK_ACTIVE_CLASS_NAME = 'table-of-contents__link--active';
 
+function TOC({className, ...props}) {
   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}) {
-  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/lib-next/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/lib-next/theme/TOCCollapsible/index.js

@@ -0,0 +1,54 @@
+/**
+ * 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';
+export default function TOCCollapsible({
+  toc,
+  className,
+  minHeadingLevel,
+  maxHeadingLevel,
+}) {
+  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/lib-next/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/lib-next/theme/TOCInline/index.js

@@ -5,37 +5,19 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import clsx from 'clsx';
 import styles from './styles.module.css';
+import TOCItems from '@theme/TOCItems';
 
-/* eslint-disable jsx-a11y/control-has-associated-label */
-function HeadingsInline({toc, isChild}) {
-  if (!toc.length) {
-    return null;
-  }
-
-  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}) {
+function TOCInline({toc, minHeadingLevel, maxHeadingLevel}) {
   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/lib-next/theme/TOCItems/index.js

@@ -0,0 +1,85 @@
+/**
+ * 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 {
+  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}) {
+  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
+}) {
+  const themeConfig = useThemeConfig();
+  const minHeadingLevel =
+    minHeadingLevelOption ?? themeConfig.tableOfContents.minHeadingLevel;
+  const maxHeadingLevel =
+    maxHeadingLevelOption ?? themeConfig.tableOfContents.maxHeadingLevel;
+  const tocFiltered = useTOCFilter({
+    toc,
+    minHeadingLevel,
+    maxHeadingLevel,
+  });
+  const tocHighlightConfig = 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/lib-next/theme/Tabs/__tests__/index.test.js

@@ -0,0 +1,142 @@
+/**
+ * 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();
+  });
+});

package/lib-next/theme/Tabs/index.js

@@ -4,28 +4,78 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import React, {useState, cloneElement, Children} from 'react';
+import React, {useState, cloneElement, Children, isValidElement} from 'react';
+import useIsBrowser from '@docusaurus/useIsBrowser';
 import useUserPreferencesContext from '@theme/hooks/useUserPreferencesContext';
+import {useScrollPositionBlocker, duplicates} from '@docusaurus/theme-common';
 import clsx from 'clsx';
-import styles from './styles.module.css';
+import styles from './styles.module.css'; // A very rough duck type, but good enough to guard against mistakes while
+// allowing customization
 
-function isInViewport(element) {
-  const {top, left, bottom, right} = element.getBoundingClientRect();
-  const {innerHeight, innerWidth} = window;
-  return top >= 0 && right <= innerWidth && bottom <= innerHeight && left >= 0;
+function isTabItem(comp) {
+  return typeof comp.props.value !== 'undefined';
 }
 
-const keys = {
-  left: 37,
-  right: 39,
-};
+function TabsComponent(props) {
+  const {
+    lazy,
+    block,
+    defaultValue: defaultValueProp,
+    values: valuesProp,
+    groupId,
+    className,
+  } = props;
+  const children = Children.map(props.children, (child) => {
+    if (isValidElement(child) && isTabItem(child)) {
+      return child;
+    } // child.type.name will give non-sensical values in prod because of
+    // minification, but we assume it won't throw in prod.
+
+    throw new Error(
+      `Docusaurus error: Bad <Tabs> child <${
+        // @ts-expect-error: guarding against unexpected cases
+        typeof child.type === 'string' ? child.type : child.type.name
+      }>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`,
+    );
+  });
+  const values =
+    valuesProp ??
+    children.map(({props: {value, label}}) => ({
+      value,
+      label,
+    }));
+  const dup = duplicates(values, (a, b) => a.value === b.value);
+
+  if (dup.length > 0) {
+    throw new Error(
+      `Docusaurus error: Duplicate values "${dup
+        .map((a) => a.value)
+        .join(', ')}" found in <Tabs>. Every value needs to be unique.`,
+    );
+  } // When defaultValueProp is null, don't show a default tab
+
+  const defaultValue =
+    defaultValueProp === null
+      ? defaultValueProp
+      : defaultValueProp ??
+        children.find((child) => child.props.default)?.props.value ??
+        children[0]?.props.value;
+
+  if (defaultValue !== null && !values.some((a) => a.value === defaultValue)) {
+    throw new Error(
+      `Docusaurus error: The <Tabs> has a defaultValue "${defaultValue}" but none of its children has the corresponding value. Available values are: ${values
+        .map((a) => a.value)
+        .join(
+          ', ',
+        )}. If you intend to show no default tab, use defaultValue={null} instead.`,
+    );
+  }
 
-function Tabs(props) {
-  const {lazy, block, defaultValue, values, groupId, className} = props;
   const {tabGroupChoices, setTabGroupChoices} = useUserPreferencesContext();
   const [selectedValue, setSelectedValue] = useState(defaultValue);
-  const children = Children.toArray(props.children);
   const tabRefs = [];
+  const {blockElementScrollPositionUntilNextRender} =
+    useScrollPositionBlocker();
 
   if (groupId != null) {
     const relevantTabGroupChoice = tabGroupChoices[groupId];
@@ -40,43 +90,32 @@ function Tabs(props) {
   }
 
   const handleTabChange = (event) => {
-    const selectedTab = event.currentTarget;
-    const selectedTabIndex = tabRefs.indexOf(selectedTab);
-    const selectedTabValue = values[selectedTabIndex].value;
-    setSelectedValue(selectedTabValue);
-
-    if (groupId != null) {
-      setTabGroupChoices(groupId, selectedTabValue);
-      setTimeout(() => {
-        if (isInViewport(selectedTab)) {
-          return;
-        }
-
-        selectedTab.scrollIntoView({
-          block: 'center',
-          behavior: 'smooth',
-        });
-        selectedTab.classList.add(styles.tabItemActive);
-        setTimeout(
-          () => selectedTab.classList.remove(styles.tabItemActive),
-          2000,
-        );
-      }, 150);
+    const newTab = event.currentTarget;
+    const newTabIndex = tabRefs.indexOf(newTab);
+    const newTabValue = values[newTabIndex].value;
+
+    if (newTabValue !== selectedValue) {
+      blockElementScrollPositionUntilNextRender(newTab);
+      setSelectedValue(newTabValue);
+
+      if (groupId != null) {
+        setTabGroupChoices(groupId, newTabValue);
+      }
     }
   };
 
   const handleKeydown = (event) => {
-    let focusElement;
+    let focusElement = null;
 
-    switch (event.keyCode) {
-      case keys.right: {
-        const nextTab = tabRefs.indexOf(event.target) + 1;
+    switch (event.key) {
+      case 'ArrowRight': {
+        const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
         focusElement = tabRefs[nextTab] || tabRefs[0];
         break;
       }
 
-      case keys.left: {
-        const prevTab = tabRefs.indexOf(event.target) - 1;
+      case 'ArrowLeft': {
+        const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
         focusElement = tabRefs[prevTab] || tabRefs[tabRefs.length - 1];
         break;
       }
@@ -113,7 +152,7 @@ function Tabs(props) {
             onKeyDown={handleKeydown}
             onFocus={handleTabChange}
             onClick={handleTabChange}>
-            {label}
+            {label ?? value}
           </li>
         ))}
       </ul>
@@ -141,4 +180,13 @@ function Tabs(props) {
   );
 }
 
-export default Tabs;
+export default function Tabs(props) {
+  const isBrowser = useIsBrowser();
+  return (
+    <TabsComponent // Remount tabs after hydration
+      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+      key={String(isBrowser)}
+      {...props}
+    />
+  );
+}