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

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/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"));
 
@@ -24,9 +24,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * LICENSE file in the root directory of this source tree.
  */
 const ThemedImage = props => {
-  const {
-    isClient
-  } = (0, _useDocusaurusContext.default)();
+  const isBrowser = (0, _useIsBrowser.default)();
   const {
     isDarkTheme
   } = (0, _useThemeContext.default)();
@@ -36,7 +34,8 @@ const ThemedImage = props => {
     alt = '',
     ...propsRest
   } = props;
-  const renderedSourceNames = isClient ? isDarkTheme ? ['dark'] : ['light'] : // We need to render both images on the server to avoid flash
+  const clientThemes = isDarkTheme ? ['dark'] : ['light'];
+  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 <>

package/lib/theme/Toggle/index.js

@@ -9,12 +9,10 @@ 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 }; }
@@ -32,14 +30,14 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 const Dark = ({
   icon,
   style
-}) => <span className={(0, _clsx.default)(_stylesModule.default.toggle, _stylesModule.default.dark)} style={style}>
+}) => <span className={(0, _clsx.default)(_stylesModule.default.toggleIcon, _stylesModule.default.dark)} style={style}>
     {icon}
   </span>;
 
 const Light = ({
   icon,
   style
-}) => <span className={(0, _clsx.default)(_stylesModule.default.toggle, _stylesModule.default.light)} style={style}>
+}) => <span className={(0, _clsx.default)(_stylesModule.default.toggleIcon, _stylesModule.default.light)} style={style}>
     {icon}
   </span>; // Based on react-toggle (https://github.com/aaronshaf/react-toggle/).
 
@@ -54,22 +52,31 @@ const Toggle = (0, _react.memo)(({
   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}>{icons.checked}</div>
+          <div className={_stylesModule.default.toggleTrackX}>{icons.unchecked}</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>;
 });
 
@@ -84,10 +91,8 @@ function _default(props) {
       }
     }
   } = (0, _themeCommon.useThemeConfig)();
-  const {
-    isClient
-  } = (0, _useDocusaurusContext.default)();
-  return <Toggle disabled={!isClient} icons={{
+  const isBrowser = (0, _useIsBrowser.default)();
+  return <Toggle disabled={!isBrowser} icons={{
     checked: <Dark icon={darkIcon} style={darkIconStyle} />,
     unchecked: <Light icon={lightIcon} style={lightIconStyle} />
   }} {...props} />;

package/lib/theme/Toggle/styles.module.css

@@ -6,6 +6,97 @@
  */
 
 .toggle {
+  touch-action: pan-x;
+  position: relative;
+  cursor: pointer;
+  user-select: none;
+  -webkit-tap-highlight-color: transparent;
+}
+
+.toggleScreenReader {
+  border: 0;
+  clip: rect(0 0 0 0);
+  height: 1px;
+  margin: -1px;
+  overflow: hidden;
+  position: absolute;
+  width: 1px;
+}
+
+.toggleDisabled {
+  cursor: not-allowed;
+}
+
+.toggleTrack {
+  width: 50px;
+  height: 24px;
+  border-radius: 30px;
+  background-color: #4d4d4d;
+  transition: all 0.2s ease;
+}
+
+.toggleTrackCheck {
+  position: absolute;
+  width: 14px;
+  height: 10px;
+  top: 0px;
+  bottom: 0px;
+  margin: auto 0;
+  left: 8px;
+  opacity: 0;
+  transition: opacity 0.25s ease;
+}
+
+[data-theme='dark'] .toggle .toggleTrackCheck,
+.toggleChecked .toggleTrackCheck {
+  opacity: 1;
+  transition: opacity 0.25s ease;
+}
+
+.toggleTrackX {
+  position: absolute;
+  width: 10px;
+  height: 10px;
+  top: 0px;
+  bottom: 0px;
+  margin: auto 0;
+  right: 10px;
+  opacity: 1;
+  transition: opacity 0.25s ease;
+}
+
+[data-theme='dark'] .toggle .toggleTrackX,
+.toggleChecked .toggleTrackX {
+  opacity: 0;
+}
+
+.toggleTrackThumb {
+  position: absolute;
+  top: 1px;
+  left: 1px;
+  width: 22px;
+  height: 22px;
+  border: 1px solid #4d4d4d;
+  border-radius: 50%;
+  background-color: #fafafa;
+  transition: all 0.25s ease;
+}
+
+[data-theme='dark'] .toggle .toggleTrackThumb,
+.toggleChecked .toggleTrackThumb {
+  left: 27px;
+}
+
+.toggleFocused .toggleTrackThumb,
+.toggle:hover .toggleTrackThumb {
+  box-shadow: 0px 0px 2px 3px var(--ifm-color-primary);
+}
+
+.toggle:active:not(.toggleDisabled) .toggleTrackThumb {
+  box-shadow: 0px 0px 5px 5px var(--ifm-color-primary);
+}
+
+.toggleIcon {
   align-items: center;
   display: flex;
   height: 10px;

package/lib/theme/UserPreferencesProvider/index.js

@@ -9,8 +9,6 @@ var _react = _interopRequireDefault(require("react"));
 
 var _useTabGroupChoice = _interopRequireDefault(require("@theme/hooks/useTabGroupChoice"));
 
-var _useAnnouncementBar = _interopRequireDefault(require("@theme/hooks/useAnnouncementBar"));
-
 var _UserPreferencesContext = _interopRequireDefault(require("@theme/UserPreferencesContext"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -26,15 +24,9 @@ function UserPreferencesProvider(props) {
     tabGroupChoices,
     setTabGroupChoices
   } = (0, _useTabGroupChoice.default)();
-  const {
-    isAnnouncementBarClosed,
-    closeAnnouncementBar
-  } = (0, _useAnnouncementBar.default)();
   return <_UserPreferencesContext.default.Provider value={{
     tabGroupChoices,
-    setTabGroupChoices,
-    isAnnouncementBarClosed,
-    closeAnnouncementBar
+    setTabGroupChoices
   }}>
       {props.children}
     </_UserPreferencesContext.default.Provider>;

package/lib/theme/hooks/useHideableNavbar.js

@@ -7,14 +7,8 @@ exports.default = void 0;
 
 var _react = require("react");
 
-var _router = require("@docusaurus/router");
-
-var _useScrollPosition = _interopRequireDefault(require("@theme/hooks/useScrollPosition"));
-
 var _themeCommon = require("@docusaurus/theme-common");
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
@@ -22,40 +16,33 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * LICENSE file in the root directory of this source tree.
  */
 const useHideableNavbar = hideOnScroll => {
-  const location = (0, _router.useLocation)();
   const [isNavbarVisible, setIsNavbarVisible] = (0, _react.useState)(hideOnScroll);
   const isFocusedAnchor = (0, _react.useRef)(false);
-  const [navbarHeight, setNavbarHeight] = (0, _react.useState)(0);
+  const navbarHeight = (0, _react.useRef)(0);
   const navbarRef = (0, _react.useCallback)(node => {
     if (node !== null) {
-      setNavbarHeight(node.getBoundingClientRect().height);
+      navbarHeight.current = node.getBoundingClientRect().height;
     }
   }, []);
-  (0, _useScrollPosition.default)(({
-    scrollY: scrollTop
-  }, {
-    scrollY: lastScrollTop
-  }) => {
+  (0, _themeCommon.useScrollPosition)((currentPosition, lastPosition) => {
     if (!hideOnScroll) {
       return;
     }
 
-    if (scrollTop < navbarHeight) {
+    const scrollTop = currentPosition.scrollY; // It needed for mostly to handle rubber band scrolling
+
+    if (scrollTop < navbarHeight.current) {
       setIsNavbarVisible(true);
       return;
     }
 
     if (isFocusedAnchor.current) {
       isFocusedAnchor.current = false;
-      setIsNavbarVisible(false);
       return;
     }
 
-    if (lastScrollTop && scrollTop === 0) {
-      setIsNavbarVisible(true);
-    }
-
-    const documentHeight = document.documentElement.scrollHeight - navbarHeight;
+    const lastScrollTop = lastPosition === null || lastPosition === void 0 ? void 0 : lastPosition.scrollY;
+    const documentHeight = document.documentElement.scrollHeight - navbarHeight.current;
     const windowHeight = window.innerHeight;
 
     if (lastScrollTop && scrollTop >= lastScrollTop) {
@@ -63,25 +50,20 @@ const useHideableNavbar = hideOnScroll => {
     } else if (scrollTop + windowHeight < documentHeight) {
       setIsNavbarVisible(true);
     }
-  }, [navbarHeight, isFocusedAnchor]);
-  (0, _themeCommon.useLocationChange)(locationChangeEvent => {
-    if (!hideOnScroll || locationChangeEvent.location.hash) {
-      return;
-    }
-
-    setIsNavbarVisible(true);
   });
-  (0, _react.useEffect)(() => {
+  (0, _themeCommon.useLocationChange)(locationChangeEvent => {
     if (!hideOnScroll) {
       return;
     }
 
-    if (!location.hash) {
+    if (locationChangeEvent.location.hash) {
+      isFocusedAnchor.current = true;
+      setIsNavbarVisible(false);
       return;
     }
 
-    isFocusedAnchor.current = true;
-  }, [location.hash]);
+    setIsNavbarVisible(true);
+  });
   return {
     navbarRef,
     isNavbarVisible

package/lib/theme/hooks/useTabGroupChoice.js

@@ -25,14 +25,12 @@ const useTabGroupChoice = () => {
   (0, _react.useEffect)(() => {
     try {
       const localStorageChoices = {};
-
-      for (const storageKey of (0, _themeCommon.listStorageKeys)()) {
+      (0, _themeCommon.listStorageKeys)().forEach(storageKey => {
         if (storageKey.startsWith(TAB_CHOICE_PREFIX)) {
           const groupId = storageKey.substring(TAB_CHOICE_PREFIX.length);
           localStorageChoices[groupId] = (0, _themeCommon.createStorageSlot)(storageKey).get();
         }
-      }
-
+      });
       setChoices(localStorageChoices);
     } catch (err) {
       console.error(err);

package/lib/theme/hooks/useTheme.js

@@ -76,7 +76,7 @@ const useTheme = () => {
     } catch (err) {
       console.error(err);
     }
-  }, [setTheme]);
+  }, [disableSwitch, setTheme]);
   (0, _react.useEffect)(() => {
     if (disableSwitch && !respectPrefersColorScheme) {
       return;
@@ -87,7 +87,7 @@ const useTheme = () => {
     }) => {
       setTheme(matches ? themes.dark : themes.light);
     });
-  }, []);
+  }, [disableSwitch, respectPrefersColorScheme]);
   return {
     isDarkTheme: theme === themes.dark,
     setLightTheme,

package/lib/theme/hooks/useWindowSize.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.windowSizes = void 0;
+exports.default = void 0;
 
 var _react = require("react");
 
@@ -17,36 +17,49 @@ 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 desktopThresholdWidth = 996;
 const windowSizes = {
   desktop: 'desktop',
-  mobile: 'mobile'
+  mobile: 'mobile',
+  // This "ssr" value is very important to handle hydration FOUC / layout shifts
+  // You have to handle server-rendering explicitly on the call-site
+  // On the server, you may need to render BOTH the mobile/desktop elements (and hide one of them with mediaquery)
+  // We don't return "undefined" on purpose, to make it more explicit
+  ssr: 'ssr'
 };
-exports.windowSizes = windowSizes;
+const DesktopThresholdWidth = 996;
 
-function useWindowSize() {
-  const isClient = _ExecutionEnvironment.default.canUseDOM;
+function getWindowSize() {
+  if (!_ExecutionEnvironment.default.canUseDOM) {
+    return windowSizes.ssr;
+  }
 
-  function getSize() {
-    if (!isClient) {
-      return undefined;
-    }
+  return window.innerWidth > DesktopThresholdWidth ? windowSizes.desktop : windowSizes.mobile;
+} // Simulate the SSR window size in dev, so that potential hydration FOUC/layout shift problems can be seen in dev too!
 
-    return window.innerWidth > desktopThresholdWidth ? windowSizes.desktop : windowSizes.mobile;
-  }
 
-  const [windowSize, setWindowSize] = (0, _react.useState)(getSize);
-  (0, _react.useEffect)(() => {
-    if (!isClient) {
-      return undefined;
+const DevSimulateSSR = process.env.NODE_ENV === 'development' && true; // This hook returns an enum value on purpose!
+// We don't want it to return the actual width value, for resize perf reasons
+// We only want to re-render once a breakpoint is crossed
+
+function useWindowSize() {
+  const [windowSize, setWindowSize] = (0, _react.useState)(() => {
+    if (DevSimulateSSR) {
+      return 'ssr';
     }
 
-    function handleResize() {
-      setWindowSize(getSize());
+    return getWindowSize();
+  });
+  (0, _react.useEffect)(() => {
+    function updateWindowSize() {
+      setWindowSize(getWindowSize());
     }
 
-    window.addEventListener('resize', handleResize);
-    return () => window.removeEventListener('resize', handleResize);
+    const timeout = DevSimulateSSR ? window.setTimeout(updateWindowSize, 1000) : undefined;
+    window.addEventListener('resize', updateWindowSize);
+    return () => {
+      window.removeEventListener('resize', updateWindowSize);
+      clearTimeout(timeout);
+    };
   }, []);
   return windowSize;
 }

package/lib/theme/prism-include-languages.js

@@ -21,11 +21,12 @@ const prismIncludeLanguages = PrismObject => {
   if (_ExecutionEnvironment.default.canUseDOM) {
     const {
       themeConfig: {
-        prism: {
-          additionalLanguages = []
-        } = {}
+        prism = {}
       }
     } = _docusaurus.default;
+    const {
+      additionalLanguages = []
+    } = prism;
     window.Prism = PrismObject;
     additionalLanguages.forEach(lang => {
       require(`prismjs/components/prism-${lang}`); // eslint-disable-line