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

package/lib/theme/Tabs/index.js

@@ -3,12 +3,16 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = Tabs;
 
 var _react = _interopRequireWildcard(require("react"));
 
+var _useIsBrowser = _interopRequireDefault(require("@docusaurus/useIsBrowser"));
+
 var _useUserPreferencesContext = _interopRequireDefault(require("@theme/hooks/useUserPreferencesContext"));
 
+var _themeCommon = require("@docusaurus/theme-common");
+
 var _clsx = _interopRequireDefault(require("clsx"));
 
 var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
@@ -25,43 +29,66 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-function isInViewport(element) {
-  const {
-    top,
-    left,
-    bottom,
-    right
-  } = element.getBoundingClientRect();
-  const {
-    innerHeight,
-    innerWidth
-  } = window;
-  return top >= 0 && right <= innerWidth && bottom <= innerHeight && left >= 0;
+// A very rough duck type, but good enough to guard against mistakes while
+// allowing customization
+function isTabItem(comp) {
+  return typeof comp.props.value !== 'undefined';
 }
 
-const keys = {
-  left: 37,
-  right: 39
-};
+function TabsComponent(props) {
+  var _ref, _children$find, _children$;
 
-function Tabs(props) {
   const {
     lazy,
     block,
-    defaultValue,
-    values,
+    defaultValue: defaultValueProp,
+    values: valuesProp,
     groupId,
     className
   } = props;
+
+  const children = _react.Children.map(props.children, child => {
+    if ((0, _react.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 !== null && valuesProp !== void 0 ? valuesProp : children.map(({
+    props: {
+      value,
+      label
+    }
+  }) => ({
+    value,
+    label
+  }));
+  const dup = (0, _themeCommon.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 : (_ref = defaultValueProp !== null && defaultValueProp !== void 0 ? defaultValueProp : (_children$find = children.find(child => child.props.default)) === null || _children$find === void 0 ? void 0 : _children$find.props.value) !== null && _ref !== void 0 ? _ref : (_children$ = children[0]) === null || _children$ === void 0 ? void 0 : _children$.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.`);
+  }
+
   const {
     tabGroupChoices,
     setTabGroupChoices
   } = (0, _useUserPreferencesContext.default)();
   const [selectedValue, setSelectedValue] = (0, _react.useState)(defaultValue);
-
-  const children = _react.Children.toArray(props.children);
-
   const tabRefs = [];
+  const {
+    blockElementScrollPositionUntilNextRender
+  } = (0, _themeCommon.useScrollPositionBlocker)();
 
   if (groupId != null) {
     const relevantTabGroupChoice = tabGroupChoices[groupId];
@@ -72,44 +99,36 @@ 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;
-        }
+    const newTab = event.currentTarget;
+    const newTabIndex = tabRefs.indexOf(newTab);
+    const newTabValue = values[newTabIndex].value;
 
-        selectedTab.scrollIntoView({
-          block: 'center',
-          behavior: 'smooth'
-        });
-        selectedTab.classList.add(_stylesModule.default.tabItemActive);
-        setTimeout(() => selectedTab.classList.remove(_stylesModule.default.tabItemActive), 2000);
-      }, 150);
+    if (newTabValue !== selectedValue) {
+      blockElementScrollPositionUntilNextRender(newTab);
+      setSelectedValue(newTabValue);
+
+      if (groupId != null) {
+        setTabGroupChoices(groupId, newTabValue);
+      }
     }
   };
 
   const handleKeydown = event => {
     var _focusElement;
 
-    let focusElement;
+    let focusElement = null;
 
-    switch (event.keyCode) {
-      case keys.right:
+    switch (event.key) {
+      case 'ArrowRight':
         {
-          const nextTab = tabRefs.indexOf(event.target) + 1;
+          const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
           focusElement = tabRefs[nextTab] || tabRefs[0];
           break;
         }
 
-      case keys.left:
+      case 'ArrowLeft':
         {
-          const prevTab = tabRefs.indexOf(event.target) - 1;
+          const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
           focusElement = tabRefs[prevTab] || tabRefs[tabRefs.length - 1];
           break;
         }
@@ -131,7 +150,7 @@ function Tabs(props) {
       }) => <li role="tab" tabIndex={selectedValue === value ? 0 : -1} aria-selected={selectedValue === value} className={(0, _clsx.default)('tabs__item', _stylesModule.default.tabItem, {
         'tabs__item--active': selectedValue === value
       })} key={value} ref={tabControl => tabRefs.push(tabControl)} onKeyDown={handleKeydown} onFocus={handleTabChange} onClick={handleTabChange}>
-            {label}
+            {label !== null && label !== void 0 ? label : value}
           </li>)}
       </ul>
 
@@ -146,5 +165,9 @@ function Tabs(props) {
     </div>;
 }
 
-var _default = Tabs;
-exports.default = _default;
+function Tabs(props) {
+  const isBrowser = (0, _useIsBrowser.default)();
+  return <TabsComponent // Remount tabs after hydration
+  // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+  key={String(isBrowser)} {...props} />;
+}

package/lib/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/theme/Tag/index.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _clsx = _interopRequireDefault(require("clsx"));
+
+var _Link = _interopRequireDefault(require("@docusaurus/Link"));
+
+var _stylesModule = _interopRequireDefault(require("./styles.module.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 Tag(props) {
+  const {
+    permalink,
+    name,
+    count
+  } = props;
+  return <_Link.default href={permalink} className={(0, _clsx.default)(_stylesModule.default.tag, {
+    [_stylesModule.default.tagRegular]: !count,
+    [_stylesModule.default.tagWithCount]: count
+  })}>
+      {name}
+      {count && <span>{count}</span>}
+    </_Link.default>;
+}
+
+var _default = Tag;
+exports.default = _default;

package/lib/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/theme/TagsListByLetter/index.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _Tag = _interopRequireDefault(require("@theme/Tag"));
+
+var _themeCommon = require("@docusaurus/theme-common");
+
+var _stylesModule = _interopRequireDefault(require("./styles.module.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 TagLetterEntryItem({
+  letterEntry
+}) {
+  return <article>
+      <h2>{letterEntry.letter}</h2>
+      <ul className="padding--none">
+        {letterEntry.tags.map(tag => <li key={tag.permalink} className={_stylesModule.default.tag}>
+            <_Tag.default {...tag} />
+          </li>)}
+      </ul>
+      <hr />
+    </article>;
+}
+
+function TagsListByLetter({
+  tags
+}) {
+  const letterList = (0, _themeCommon.listTagsByLetters)(tags);
+  return <section className="margin-vert--lg">
+      {letterList.map(letterEntry => <TagLetterEntryItem key={letterEntry.letter} letterEntry={letterEntry} />)}
+    </section>;
+}
+
+var _default = TagsListByLetter;
+exports.default = _default;

package/lib/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/theme/TagsListInline/index.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = TagsListInline;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _clsx = _interopRequireDefault(require("clsx"));
+
+var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
+
+var _Tag = _interopRequireDefault(require("@theme/Tag"));
+
+var _stylesModule = _interopRequireDefault(require("./styles.module.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 TagsListInline({
+  tags
+}) {
+  return <>
+      <b>
+        <_Translate.default id="theme.tags.tagsListLabel" description="The label alongside a tag list">
+          Tags:
+        </_Translate.default>
+      </b>
+      <ul className={(0, _clsx.default)(_stylesModule.default.tags, 'padding--none', 'margin-left--sm')}>
+        {tags.map(({
+        label,
+        permalink: tagPermalink
+      }) => <li key={tagPermalink} className={_stylesModule.default.tag}>
+            <_Tag.default name={label} permalink={tagPermalink} />
+          </li>)}
+      </ul>
+    </>;
+}

package/lib/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/theme/ThemeProvider/index.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _react = _interopRequireDefault(require("react"));
+var _react = _interopRequireWildcard(require("react"));
 
 var _useTheme = _interopRequireDefault(require("@theme/hooks/useTheme"));
 
@@ -13,6 +13,10 @@ var _ThemeContext = _interopRequireDefault(require("@theme/ThemeContext"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
@@ -25,11 +29,12 @@ function ThemeProvider(props) {
     setLightTheme,
     setDarkTheme
   } = (0, _useTheme.default)();
-  return <_ThemeContext.default.Provider value={{
+  const contextValue = (0, _react.useMemo)(() => ({
     isDarkTheme,
     setLightTheme,
     setDarkTheme
-  }}>
+  }), [isDarkTheme, setLightTheme, setDarkTheme]);
+  return <_ThemeContext.default.Provider value={contextValue}>
       {props.children}
     </_ThemeContext.default.Provider>;
 }

package/lib/theme/ThemedImage/index.js

@@ -9,7 +9,7 @@ var _react = _interopRequireDefault(require("react"));
 
 var _clsx = _interopRequireDefault(require("clsx"));
 
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
+var _useIsBrowser = _interopRequireDefault(require("@docusaurus/useIsBrowser"));
 
 var _useThemeContext = _interopRequireDefault(require("@theme/hooks/useThemeContext"));
 
@@ -23,10 +23,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-const ThemedImage = props => {
-  const {
-    isClient
-  } = (0, _useDocusaurusContext.default)();
+function ThemedImage(props) {
+  const isBrowser = (0, _useIsBrowser.default)();
   const {
     isDarkTheme
   } = (0, _useThemeContext.default)();
@@ -37,13 +35,13 @@ const ThemedImage = props => {
     ...propsRest
   } = props;
   const clientThemes = isDarkTheme ? ['dark'] : ['light'];
-  const renderedSourceNames = isClient ? clientThemes : // We need to render both images on the server to avoid flash
+  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'];
   return <>
       {renderedSourceNames.map(sourceName => <img key={sourceName} src={sources[sourceName]} alt={alt} className={(0, _clsx.default)(_stylesModule.default.themedImage, _stylesModule.default[`themedImage--${sourceName}`], className)} {...propsRest} />)}
     </>;
-};
+}
 
 var _default = ThemedImage;
 exports.default = _default;

package/lib/theme/Toggle/index.js

@@ -3,18 +3,16 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = _default;
+exports.default = Toggle;
 
 var _react = _interopRequireWildcard(require("react"));
 
 var _themeCommon = require("@docusaurus/theme-common");
 
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
+var _useIsBrowser = _interopRequireDefault(require("@docusaurus/useIsBrowser"));
 
 var _clsx = _interopRequireDefault(require("clsx"));
 
-require("./styles.css");
-
 var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -29,66 +27,65 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-const Dark = ({
-  icon,
-  style
-}) => <span className={(0, _clsx.default)(_stylesModule.default.toggle, _stylesModule.default.dark)} style={style}>
-    {icon}
-  </span>;
-
-const Light = ({
-  icon,
-  style
-}) => <span className={(0, _clsx.default)(_stylesModule.default.toggle, _stylesModule.default.light)} style={style}>
-    {icon}
-  </span>; // Based on react-toggle (https://github.com/aaronshaf/react-toggle/).
-
-
-const Toggle = (0, _react.memo)(({
+// Based on react-toggle (https://github.com/aaronshaf/react-toggle/).
+const ToggleComponent = (0, _react.memo)(({
   className,
-  icons,
+  switchConfig,
   checked: defaultChecked,
   disabled,
   onChange
 }) => {
+  const {
+    darkIcon,
+    darkIconStyle,
+    lightIcon,
+    lightIconStyle
+  } = switchConfig;
   const [checked, setChecked] = (0, _react.useState)(defaultChecked);
   const [focused, setFocused] = (0, _react.useState)(false);
   const inputRef = (0, _react.useRef)(null);
-  return <div className={(0, _clsx.default)('react-toggle', className, {
-    'react-toggle--checked': checked,
-    'react-toggle--focus': focused,
-    'react-toggle--disabled': disabled
+  return <div className={(0, _clsx.default)(_stylesModule.default.toggle, className, {
+    [_stylesModule.default.toggleChecked]: checked,
+    [_stylesModule.default.toggleFocused]: focused,
+    [_stylesModule.default.toggleDisabled]: disabled
   })}>
-        <div className="react-toggle-track" role="button" tabIndex={-1} onClick={() => {
+        {
+      /* eslint-disable-next-line jsx-a11y/click-events-have-key-events */
+    }
+        <div className={_stylesModule.default.toggleTrack} role="button" tabIndex={-1} onClick={() => {
       var _inputRef$current;
 
       return (_inputRef$current = inputRef.current) === null || _inputRef$current === void 0 ? void 0 : _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 className={_stylesModule.default.toggleTrackCheck}>
+            <span className={_stylesModule.default.toggleIcon} style={darkIconStyle}>
+              {darkIcon}
+            </span>
+          </div>
+          <div className={_stylesModule.default.toggleTrackX}>
+            <span className={_stylesModule.default.toggleIcon} style={lightIconStyle}>
+              {lightIcon}
+            </span>
+          </div>
+          <div className={_stylesModule.default.toggleTrackThumb} />
         </div>
 
-        <input ref={inputRef} checked={checked} type="checkbox" className="react-toggle-screenreader-only" aria-label="Switch between dark and light mode" onChange={onChange} onClick={() => setChecked(!checked)} onFocus={() => setFocused(true)} onBlur={() => setFocused(false)} />
+        <input ref={inputRef} checked={checked} type="checkbox" className={_stylesModule.default.toggleScreenReader} aria-label="Switch between dark and light mode" onChange={onChange} onClick={() => setChecked(!checked)} onFocus={() => setFocused(true)} onBlur={() => setFocused(false)} onKeyDown={e => {
+      if (e.key === 'Enter') {
+        var _inputRef$current2;
+
+        (_inputRef$current2 = inputRef.current) === null || _inputRef$current2 === void 0 ? void 0 : _inputRef$current2.click();
+      }
+    }} />
       </div>;
 });
 
-function _default(props) {
+function Toggle(props) {
   const {
     colorMode: {
-      switchConfig: {
-        darkIcon,
-        darkIconStyle,
-        lightIcon,
-        lightIconStyle
-      }
+      switchConfig
     }
   } = (0, _themeCommon.useThemeConfig)();
-  const {
-    isClient
-  } = (0, _useDocusaurusContext.default)();
-  return <Toggle disabled={!isClient} icons={{
-    checked: <Dark icon={darkIcon} style={darkIconStyle} />,
-    unchecked: <Light icon={lightIcon} style={lightIconStyle} />
-  }} {...props} />;
+  const isBrowser = (0, _useIsBrowser.default)();
+  return <ToggleComponent switchConfig={switchConfig} disabled={!isBrowser} {...props} />;
 }