@docusaurus/theme-classic 2.0.0-beta.138b4c997 → 2.0.0-beta.14

package/lib-next/theme/hooks/useLocationHash.js

@@ -1,20 +0,0 @@
-/**
- * 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 {useState, useEffect} from 'react';
-
-function useLocationHash(initialHash) {
-  const [hash, setHash] = useState(initialHash);
-  useEffect(() => {
-    const handleHashChange = () => setHash(window.location.hash);
-
-    window.addEventListener('hashchange', handleHashChange);
-    return () => window.removeEventListener('hashchange', handleHashChange);
-  }, []);
-  return [hash, setHash];
-}
-
-export default useLocationHash;

package/lib-next/theme/hooks/useScrollPosition.js

@@ -1,38 +0,0 @@
-/**
- * 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 {useEffect, useRef} from 'react';
-import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
-
-const getScrollPosition = () => ({
-  scrollX: ExecutionEnvironment.canUseDOM ? window.pageXOffset : 0,
-  scrollY: ExecutionEnvironment.canUseDOM ? window.pageYOffset : 0,
-});
-
-const useScrollPosition = (effect, deps = []) => {
-  const scrollPosition = useRef(getScrollPosition());
-
-  const handleScroll = () => {
-    const currentScrollPosition = getScrollPosition();
-
-    if (effect) {
-      effect(currentScrollPosition, scrollPosition.current);
-    }
-
-    scrollPosition.current = currentScrollPosition;
-  };
-
-  useEffect(() => {
-    const opts = {
-      passive: true,
-    };
-    handleScroll();
-    window.addEventListener('scroll', handleScroll, opts);
-    return () => window.removeEventListener('scroll', handleScroll, opts);
-  }, deps);
-};
-
-export default useScrollPosition;

package/lib-next/theme/hooks/useTOCHighlight.js

@@ -1,84 +0,0 @@
-/**
- * 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 {useEffect, useState} from 'react';
-
-function useTOCHighlight(linkClassName, linkActiveClassName, topOffset) {
-  const [lastActiveLink, setLastActiveLink] = useState(undefined);
-  useEffect(() => {
-    function setActiveLink() {
-      function getActiveHeaderAnchor() {
-        const headersAnchors = Array.from(
-          document.getElementsByClassName('anchor'),
-        );
-        const firstAnchorUnderViewportTop = headersAnchors.find((anchor) => {
-          const {top} = anchor.getBoundingClientRect();
-          return top >= topOffset;
-        });
-
-        if (firstAnchorUnderViewportTop) {
-          // If first anchor in viewport is under a certain threshold, we consider it's not the active anchor.
-          // In such case, the active anchor is the previous one (if it exists), that may be above the viewport
-          if (
-            firstAnchorUnderViewportTop.getBoundingClientRect().top >= topOffset
-          ) {
-            const previousAnchor =
-              headersAnchors[
-                headersAnchors.indexOf(firstAnchorUnderViewportTop) - 1
-              ];
-            return previousAnchor ?? firstAnchorUnderViewportTop;
-          } // If the anchor is at the top of the viewport, we consider it's the first anchor
-          else {
-            return firstAnchorUnderViewportTop;
-          }
-        } // no anchor under viewport top? (ie we are at the bottom of the page)
-        else {
-          // highlight the last anchor found
-          return headersAnchors[headersAnchors.length - 1];
-        }
-      }
-
-      const activeHeaderAnchor = getActiveHeaderAnchor();
-
-      if (activeHeaderAnchor) {
-        let index = 0;
-        let itemHighlighted = false; // @ts-expect-error: Must be <a> tags.
-
-        const links = document.getElementsByClassName(linkClassName);
-
-        while (index < links.length && !itemHighlighted) {
-          const link = links[index];
-          const {href} = link;
-          const anchorValue = decodeURIComponent(
-            href.substring(href.indexOf('#') + 1),
-          );
-
-          if (activeHeaderAnchor.id === anchorValue) {
-            if (lastActiveLink) {
-              lastActiveLink.classList.remove(linkActiveClassName);
-            }
-
-            link.classList.add(linkActiveClassName);
-            setLastActiveLink(link);
-            itemHighlighted = true;
-          }
-
-          index += 1;
-        }
-      }
-    }
-
-    document.addEventListener('scroll', setActiveLink);
-    document.addEventListener('resize', setActiveLink);
-    setActiveLink();
-    return () => {
-      document.removeEventListener('scroll', setActiveLink);
-      document.removeEventListener('resize', setActiveLink);
-    };
-  });
-}
-
-export default useTOCHighlight;

package/lib-next/translations.js

@@ -1,145 +0,0 @@
-/**
- * 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 {keyBy, chain, flatten} from 'lodash';
-import {mergeTranslations} from '@docusaurus/utils';
-
-function getNavbarTranslationFile(navbar) {
-  // TODO handle properly all the navbar item types here!
-  function flattenNavbarItems(items) {
-    const subItems = flatten(
-      items.map((item) => {
-        const allSubItems = flatten([item.items ?? []]);
-        return flattenNavbarItems(allSubItems);
-      }),
-    );
-    return [...items, ...subItems];
-  }
-
-  const allNavbarItems = flattenNavbarItems(navbar.items);
-  const navbarItemsTranslations = chain(
-    allNavbarItems.filter((navbarItem) => !!navbarItem.label),
-  )
-    .keyBy((navbarItem) => `item.label.${navbarItem.label}`)
-    .mapValues((navbarItem) => ({
-      message: navbarItem.label,
-      description: `Navbar item with label ${navbarItem.label}`,
-    }))
-    .value();
-  const titleTranslations = navbar.title
-    ? {
-        title: {
-          message: navbar.title,
-          description: 'The title in the navbar',
-        },
-      }
-    : {};
-  return mergeTranslations([titleTranslations, navbarItemsTranslations]);
-}
-
-function translateNavbar(navbar, navbarTranslations) {
-  return {
-    ...navbar,
-    title: navbarTranslations.title?.message ?? navbar.title,
-    //  TODO handle properly all the navbar item types here!
-    items: navbar.items.map((item) => {
-      const subItems = item.items?.map((subItem) => ({
-        ...subItem,
-        label:
-          navbarTranslations[`item.label.${subItem.label}`]?.message ??
-          subItem.label,
-      }));
-      return {
-        ...item,
-        label:
-          navbarTranslations[`item.label.${item.label}`]?.message ?? item.label,
-        ...(subItems
-          ? {
-              items: subItems,
-            }
-          : undefined),
-      };
-    }),
-  };
-}
-
-function getFooterTranslationFile(footer) {
-  // TODO POC code
-  const footerLinkTitles = chain(footer.links.filter((link) => !!link.title))
-    .keyBy((link) => `link.title.${link.title}`)
-    .mapValues((link) => ({
-      message: link.title,
-      description: `The title of the footer links column with title=${link.title} in the footer`,
-    }))
-    .value();
-  const footerLinkLabels = chain(
-    flatten(footer.links.map((link) => link.items)).filter(
-      (link) => !!link.label,
-    ),
-  )
-    .keyBy((linkItem) => `link.item.label.${linkItem.label}`)
-    .mapValues((linkItem) => ({
-      message: linkItem.label,
-      description: `The label of footer link with label=${
-        linkItem.label
-      } linking to ${linkItem.to ?? linkItem.href}`,
-    }))
-    .value();
-  const copyright = footer.copyright
-    ? {
-        copyright: {
-          message: footer.copyright,
-          description: 'The footer copyright',
-        },
-      }
-    : {};
-  return mergeTranslations([footerLinkTitles, footerLinkLabels, copyright]);
-}
-
-function translateFooter(footer, footerTranslations) {
-  const links = footer.links.map((link) => ({
-    ...link,
-    title:
-      footerTranslations[`link.title.${link.title}`]?.message ?? link.title,
-    items: link.items.map((linkItem) => ({
-      ...linkItem,
-      label:
-        footerTranslations[`link.item.label.${linkItem.label}`]?.message ??
-        linkItem.label,
-    })),
-  }));
-  const copyright = footerTranslations.copyright?.message ?? footer.copyright;
-  return {...footer, links, copyright};
-}
-
-export function getTranslationFiles({themeConfig}) {
-  const translationFiles = [
-    {
-      path: 'navbar',
-      content: getNavbarTranslationFile(themeConfig.navbar),
-    },
-    themeConfig.footer
-      ? {
-          path: 'footer',
-          content: getFooterTranslationFile(themeConfig.footer),
-        }
-      : undefined,
-  ];
-  return translationFiles.filter(Boolean);
-}
-export function translateThemeConfig({themeConfig, translationFiles}) {
-  const translationFilesMap = keyBy(translationFiles, (f) => f.path);
-  return {
-    ...themeConfig,
-    navbar: translateNavbar(
-      themeConfig.navbar,
-      translationFilesMap.navbar.content,
-    ),
-    footer: themeConfig.footer
-      ? translateFooter(themeConfig.footer, translationFilesMap.footer.content)
-      : undefined,
-  };
-}

package/lib-next/validateThemeConfig.js

@@ -1,317 +0,0 @@
-/**
- * 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.
- */
-
-const {Joi, URISchema} = require('@docusaurus/utils-validation');
-
-const DEFAULT_DOCS_CONFIG = {
-  versionPersistence: 'localStorage',
-};
-const DocsSchema = Joi.object({
-  versionPersistence: Joi.string()
-    .equal('localStorage', 'none')
-    .default(DEFAULT_DOCS_CONFIG.versionPersistence),
-}).default(DEFAULT_DOCS_CONFIG);
-
-const DEFAULT_COLOR_MODE_CONFIG = {
-  defaultMode: 'light',
-  disableSwitch: false,
-  respectPrefersColorScheme: false,
-  switchConfig: {
-    darkIcon: '🌜',
-    darkIconStyle: {},
-    lightIcon: '🌞',
-    lightIconStyle: {},
-  },
-};
-
-const DEFAULT_CONFIG = {
-  colorMode: DEFAULT_COLOR_MODE_CONFIG,
-  docs: DEFAULT_DOCS_CONFIG,
-  metadatas: [],
-  prism: {
-    additionalLanguages: [],
-  },
-  navbar: {
-    hideOnScroll: false,
-    items: [],
-  },
-  hideableSidebar: false,
-};
-exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
-
-const NavbarItemPosition = Joi.string().equal('left', 'right').default('left');
-
-const BaseNavbarItemSchema = Joi.object({
-  to: Joi.string(),
-  href: URISchema,
-  label: Joi.string(),
-  className: Joi.string(),
-  prependBaseUrlToHref: Joi.bool(),
-})
-  // We allow any unknown attributes on the links
-  // (users may need additional attributes like target, aria-role, data-customAttribute...)
-  .unknown();
-
-// TODO we should probably create a custom navbar item type "dropdown"
-// having this recursive structure is bad because we only support 2 levels
-// + parent/child don't have exactly the same props
-const DefaultNavbarItemSchema = BaseNavbarItemSchema.append({
-  items: Joi.array().optional().items(BaseNavbarItemSchema),
-  position: NavbarItemPosition,
-  activeBasePath: Joi.string(),
-  activeBaseRegex: Joi.string(),
-});
-// TODO the dropdown parent item can have no href/to
-// should check should not apply to dropdown parent item
-// .xor('href', 'to');
-
-const DocsVersionNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('docsVersion').required(),
-  position: NavbarItemPosition,
-  label: Joi.string(),
-  to: Joi.string(),
-  docsPluginId: Joi.string(),
-  className: Joi.string(),
-});
-
-const DocsVersionDropdownNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('docsVersionDropdown').required(),
-  position: NavbarItemPosition,
-  docsPluginId: Joi.string(),
-  dropdownActiveClassDisabled: Joi.boolean(),
-  dropdownItemsBefore: Joi.array().items(BaseNavbarItemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(BaseNavbarItemSchema).default([]),
-  className: Joi.string(),
-});
-
-const DocItemSchema = Joi.object({
-  type: Joi.string().equal('doc').required(),
-  position: NavbarItemPosition,
-  docId: Joi.string().required(),
-  label: Joi.string(),
-  docsPluginId: Joi.string(),
-  activeSidebarClassName: Joi.string().default('navbar__link--active'),
-  className: Joi.string(),
-});
-
-const LocaleDropdownNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('localeDropdown').required(),
-  position: NavbarItemPosition,
-  dropdownItemsBefore: Joi.array().items(BaseNavbarItemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(BaseNavbarItemSchema).default([]),
-  className: Joi.string(),
-});
-
-const SearchItemSchema = Joi.object({
-  type: Joi.string().equal('search').required(),
-  position: NavbarItemPosition,
-});
-
-// Can this be made easier? :/
-const isOfType = (type) => {
-  let typeSchema = Joi.string().required();
-  // because equal(undefined) is not supported :/
-  if (type) {
-    typeSchema = typeSchema.equal(type);
-  }
-  return Joi.object({
-    type: typeSchema,
-  })
-    .unknown()
-    .required();
-};
-
-const NavbarItemSchema = Joi.object().when({
-  switch: [
-    {
-      is: isOfType('docsVersion'),
-      then: DocsVersionNavbarItemSchema,
-    },
-    {
-      is: isOfType('docsVersionDropdown'),
-      then: DocsVersionDropdownNavbarItemSchema,
-    },
-    {
-      is: isOfType('doc'),
-      then: DocItemSchema,
-    },
-    {
-      is: isOfType('localeDropdown'),
-      then: LocaleDropdownNavbarItemSchema,
-    },
-    {
-      is: isOfType('search'),
-      then: SearchItemSchema,
-    },
-    {
-      is: isOfType(undefined),
-      then: Joi.forbidden().messages({
-        'any.unknown': 'Bad navbar item type {.type}',
-      }),
-    },
-  ],
-  otherwise: DefaultNavbarItemSchema,
-});
-
-/*
-const NavbarItemSchema = Joi.object({
-  type: Joi.string().only(['docsVersion'])
-})
-  .when(Joi.object({ type: 'docsVersion' }).unknown(), {
-    then: Joi.object({ pepperoni: Joi.boolean() })
-  })
-  .when(Joi.object().unknown(), {
-    then: Joi.object({ croutons: Joi.boolean() })
-  })
-
- */
-
-/*
-const NavbarItemSchema = Joi.object().when('type', {
-  is: Joi.valid('docsVersion'),
-  then: DocsVersionNavbarItemSchema,
-  otherwise: DefaultNavbarItemSchema,
-});
- */
-
-const ColorModeSchema = Joi.object({
-  defaultMode: Joi.string()
-    .equal('dark', 'light')
-    .default(DEFAULT_COLOR_MODE_CONFIG.defaultMode),
-  disableSwitch: Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.disableSwitch),
-  respectPrefersColorScheme: Joi.bool().default(
-    DEFAULT_COLOR_MODE_CONFIG.respectPrefersColorScheme,
-  ),
-  switchConfig: Joi.object({
-    darkIcon: Joi.string().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.darkIcon,
-    ),
-    darkIconStyle: Joi.object().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.darkIconStyle,
-    ),
-    lightIcon: Joi.string().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIcon,
-    ),
-    lightIconStyle: Joi.object().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIconStyle,
-    ),
-  }).default(DEFAULT_COLOR_MODE_CONFIG.switchConfig),
-}).default(DEFAULT_COLOR_MODE_CONFIG);
-
-// schema can probably be improved
-const HtmlMetadataSchema = Joi.object({
-  id: Joi.string(),
-  name: Joi.string(),
-  property: Joi.string(),
-  content: Joi.string(),
-  itemprop: Joi.string(),
-}).unknown();
-
-const FooterLinkItemSchema = Joi.object({
-  to: Joi.string(),
-  href: URISchema,
-  html: Joi.string(),
-  label: Joi.string(),
-})
-  .xor('to', 'href', 'html')
-  .with('to', 'label')
-  .with('href', 'label')
-  .nand('html', 'label')
-  // We allow any unknown attributes on the links
-  // (users may need additional attributes like target, aria-role, data-customAttribute...)
-  .unknown();
-
-const CustomCssSchema = Joi.alternatives()
-  .try(Joi.array().items(Joi.string().required()), Joi.string().required())
-  .optional();
-
-const ThemeConfigSchema = Joi.object({
-  // TODO temporary (@alpha-58)
-  disableDarkMode: Joi.any().forbidden(false).messages({
-    'any.unknown':
-      'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true',
-  }),
-  // TODO temporary (@alpha-58)
-  defaultDarkMode: Joi.any().forbidden(false).messages({
-    'any.unknown':
-      'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"',
-  }),
-  customCss: CustomCssSchema,
-  colorMode: ColorModeSchema,
-  image: Joi.string(),
-  docs: DocsSchema,
-  metadatas: Joi.array()
-    .items(HtmlMetadataSchema)
-    .default(DEFAULT_CONFIG.metadatas),
-  announcementBar: Joi.object({
-    id: Joi.string().default('announcement-bar'),
-    content: Joi.string(),
-    backgroundColor: Joi.string(),
-    textColor: Joi.string(),
-    isCloseable: Joi.bool().default(true),
-  }).optional(),
-  navbar: Joi.object({
-    style: Joi.string().equal('dark', 'primary'),
-    hideOnScroll: Joi.bool().default(DEFAULT_CONFIG.navbar.hideOnScroll),
-    // TODO temporary (@alpha-58)
-    links: Joi.any().forbidden().messages({
-      'any.unknown':
-        'themeConfig.navbar.links has been renamed as themeConfig.navbar.items',
-    }),
-    items: Joi.array()
-      .items(NavbarItemSchema)
-      .default(DEFAULT_CONFIG.navbar.items),
-    title: Joi.string().allow('', null),
-    logo: Joi.object({
-      alt: Joi.string().allow(''),
-      src: Joi.string().required(),
-      srcDark: Joi.string(),
-      href: Joi.string(),
-      target: Joi.string(),
-    }),
-  }).default(DEFAULT_CONFIG.navbar),
-  footer: Joi.object({
-    style: Joi.string().equal('dark', 'light').default('light'),
-    logo: Joi.object({
-      alt: Joi.string().allow(''),
-      src: Joi.string(),
-      srcDark: Joi.string(),
-      href: Joi.string(),
-    }),
-    copyright: Joi.string(),
-    links: Joi.array()
-      .items(
-        Joi.object({
-          title: Joi.string().allow(null),
-          items: Joi.array().items(FooterLinkItemSchema).default([]),
-        }),
-      )
-      .default([]),
-  }).optional(),
-  prism: Joi.object({
-    theme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-    }),
-    darkTheme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-    }),
-    defaultLanguage: Joi.string(),
-    additionalLanguages: Joi.array()
-      .items(Joi.string())
-      .default(DEFAULT_CONFIG.prism.additionalLanguages),
-  })
-    .default(DEFAULT_CONFIG.prism)
-    .unknown(),
-  hideableSidebar: Joi.bool().default(DEFAULT_CONFIG.hideableSidebar),
-});
-exports.ThemeConfigSchema = ThemeConfigSchema;
-
-exports.validateThemeConfig = ({validate, themeConfig}) => {
-  return validate(ThemeConfigSchema, themeConfig);
-};