@docusaurus/theme-classic 2.0.0-beta.12faed89d → 2.0.0-beta.13

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}
+    />
+  );
+}

package/lib-next/theme/Tabs/styles.module.css

@@ -8,16 +8,3 @@
 .tabItem {
   margin-top: 0 !important;
 }
-
-.tabItemActive {
-  animation: blink 0.5s ease-in-out 5;
-}
-
-@keyframes blink {
-  0% {
-    background-color: var(--ifm-hover-overlay);
-  }
-  100% {
-    background-color: rgba(0, 0, 0, 0);
-  }
-}

package/lib-next/theme/Tag/index.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 React from 'react';
+import clsx from 'clsx';
+import Link from '@docusaurus/Link';
+import styles from './styles.module.css';
+
+function Tag(props) {
+  const {permalink, name, count} = props;
+  return (
+    <Link
+      href={permalink}
+      className={clsx(styles.tag, {
+        [styles.tagRegular]: !count,
+        [styles.tagWithCount]: count,
+      })}>
+      {name}
+      {count && <span>{count}</span>}
+    </Link>
+  );
+}
+
+export default Tag;

package/lib-next/theme/Tag/styles.module.css

@@ -0,0 +1,70 @@
+/**
+ * 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.
+ */
+
+:root {
+  --docusaurus-tag-list-border: var(--ifm-color-emphasis-300);
+}
+
+.tag {
+  border: 1px solid var(--docusaurus-tag-list-border);
+  transition: border var(--ifm-transition-fast);
+}
+
+.tag:hover {
+  --docusaurus-tag-list-border: var(--ifm-link-color);
+  text-decoration: none;
+}
+
+.tagRegular {
+  border-radius: 0.5rem;
+  padding: 0.3rem 0.5rem;
+  font-size: 90%;
+}
+
+.tagWithCount {
+  display: flex;
+  align-items: center;
+  position: relative;
+  padding: 0 0.5rem 0 1rem;
+  border-left: 0;
+}
+
+.tagWithCount:before,
+.tagWithCount:after {
+  content: '';
+  position: absolute;
+  top: 50%;
+  border: 1px solid var(--docusaurus-tag-list-border);
+  transition: inherit;
+}
+
+.tagWithCount:before {
+  right: 100%;
+  transform: translate(50%, -50%) rotate(-45deg);
+  width: 1.18rem;
+  height: 1.18rem;
+  border-right: 0;
+  border-bottom: 0;
+}
+
+.tagWithCount:after {
+  left: 0;
+  transform: translateY(-50%);
+  width: 0.5rem;
+  height: 0.5rem;
+  border-radius: 50%;
+}
+
+.tagWithCount span {
+  background: var(--ifm-color-secondary);
+  color: var(--ifm-color-black);
+  font-size: 0.7rem;
+  line-height: 1.2;
+  border-radius: var(--ifm-global-radius);
+  padding: 0.1rem 0.4rem;
+  margin-left: 0.3rem;
+}

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

@@ -0,0 +1,42 @@
+/**
+ * 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 Tag from '@theme/Tag';
+import {listTagsByLetters} from '@docusaurus/theme-common';
+import styles from './styles.module.css';
+
+function TagLetterEntryItem({letterEntry}) {
+  return (
+    <article>
+      <h2>{letterEntry.letter}</h2>
+      <ul className="padding--none">
+        {letterEntry.tags.map((tag) => (
+          <li key={tag.permalink} className={styles.tag}>
+            <Tag {...tag} />
+          </li>
+        ))}
+      </ul>
+      <hr />
+    </article>
+  );
+}
+
+function TagsListByLetter({tags}) {
+  const letterList = listTagsByLetters(tags);
+  return (
+    <section className="margin-vert--lg">
+      {letterList.map((letterEntry) => (
+        <TagLetterEntryItem
+          key={letterEntry.letter}
+          letterEntry={letterEntry}
+        />
+      ))}
+    </section>
+  );
+}
+
+export default TagsListByLetter;

package/lib-next/theme/TagsListByLetter/styles.module.css

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+
+.tag {
+  display: inline-block;
+  margin: 0.5rem 0.5rem 0 1rem;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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 Tag from '@theme/Tag';
+import styles from './styles.module.css';
+export default function TagsListInline({tags}) {
+  return (
+    <>
+      <b>
+        <Translate
+          id="theme.tags.tagsListLabel"
+          description="The label alongside a tag list">
+          Tags:
+        </Translate>
+      </b>
+      <ul className={clsx(styles.tags, 'padding--none', 'margin-left--sm')}>
+        {tags.map(({label, permalink: tagPermalink}) => (
+          <li key={tagPermalink} className={styles.tag}>
+            <Tag name={label} permalink={tagPermalink} />
+          </li>
+        ))}
+      </ul>
+    </>
+  );
+}

package/lib-next/theme/TagsListInline/styles.module.css

@@ -0,0 +1,15 @@
+/**
+ * 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.
+ */
+
+.tags {
+  display: inline;
+}
+
+.tag {
+  margin: 0 0.4rem 0.5rem 0;
+  display: inline-block;
+}

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

@@ -4,19 +4,22 @@
  * 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 React, {useMemo} from 'react';
 import useTheme from '@theme/hooks/useTheme';
 import ThemeContext from '@theme/ThemeContext';
 
 function ThemeProvider(props) {
   const {isDarkTheme, setLightTheme, setDarkTheme} = useTheme();
+  const contextValue = useMemo(
+    () => ({
+      isDarkTheme,
+      setLightTheme,
+      setDarkTheme,
+    }),
+    [isDarkTheme, setLightTheme, setDarkTheme],
+  );
   return (
-    <ThemeContext.Provider
-      value={{
-        isDarkTheme,
-        setLightTheme,
-        setDarkTheme,
-      }}>
+    <ThemeContext.Provider value={contextValue}>
       {props.children}
     </ThemeContext.Provider>
   );

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

@@ -6,16 +6,16 @@
  */
 import React from 'react';
 import clsx from 'clsx';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import useIsBrowser from '@docusaurus/useIsBrowser';
 import useThemeContext from '@theme/hooks/useThemeContext';
 import styles from './styles.module.css';
 
-const ThemedImage = (props) => {
-  const {isClient} = useDocusaurusContext();
+function ThemedImage(props) {
+  const isBrowser = useIsBrowser();
   const {isDarkTheme} = useThemeContext();
   const {sources, className, alt = '', ...propsRest} = props;
   const clientThemes = isDarkTheme ? ['dark'] : ['light'];
-  const renderedSourceNames = isClient
+  const renderedSourceNames = isBrowser
     ? clientThemes // We need to render both images on the server to avoid flash
     : // See https://github.com/facebook/docusaurus/pull/3730
       ['light', 'dark'];
@@ -36,6 +36,6 @@ const ThemedImage = (props) => {
       ))}
     </>
   );
-};
+}
 
 export default ThemedImage;