@docusaurus/theme-classic 0.0.0-5044 → 0.0.0-5049

package/lib/index.js

@@ -131,7 +131,7 @@ function themeClassic(context, options) {
                 const plugin = {
                     postcssPlugin: 'RtlCssPlugin',
                     prepare: (result) => {
-                        const file = result.root?.source?.input?.file;
+                        const file = result.root.source?.input.file;
                         // Skip Infima as we are using the its RTL version.
                         if (file === resolvedInfimaFile) {
                             return {};

package/lib/theme/CodeBlock/Content/String.js

@@ -46,7 +46,7 @@ export default function CodeBlockString({
     magicComments,
   });
   const showLineNumbers =
-    showLineNumbersProp || containsLineNumbers(metastring);
+    showLineNumbersProp ?? containsLineNumbers(metastring);
   return (
     <Container
       as="div"

package/lib/theme/DocSidebarItem/Html/index.js

@@ -15,7 +15,7 @@ export default function DocSidebarItemHtml({item, level, index}) {
       className={clsx(
         ThemeClassNames.docs.docSidebarItemLink,
         ThemeClassNames.docs.docSidebarItemLinkLevel(level),
-        defaultStyle && `${styles.menuHtmlItem} menu__list-item`,
+        defaultStyle && [styles.menuHtmlItem, 'menu__list-item'],
         className,
       )}
       key={index}

package/lib/theme/Footer/Links/MultiColumn/index.js

@@ -15,7 +15,7 @@ function ColumnLinkItem({item}) {
       dangerouslySetInnerHTML={{__html: item.html}}
     />
   ) : (
-    <li key={item.href || item.to} className="footer__item">
+    <li key={item.href ?? item.to} className="footer__item">
       <LinkItem item={item} />
     </li>
   );

package/lib/theme/MDXComponents/Details.js

@@ -10,7 +10,9 @@ export default function MDXDetails(props) {
   const items = React.Children.toArray(props.children);
   // Split summary item from the rest to pass it as a separate prop to the
   // Details theme component
-  const summary = items.find((item) => item?.props?.mdxType === 'summary');
+  const summary = items.find(
+    (item) => React.isValidElement(item) && item.props?.mdxType === 'summary',
+  );
   const children = <>{items.filter((item) => item !== summary)}</>;
   return (
     <Details {...props} summary={summary}>

package/lib/theme/MDXComponents/Head.js

@@ -9,7 +9,7 @@ import Head from '@docusaurus/Head';
 // MDX elements are wrapped through the MDX pragma. In some cases (notably usage
 // with Head/Helmet) we need to unwrap those elements.
 function unwrapMDXElement(element) {
-  if (element?.props?.mdxType && element?.props?.originalType) {
+  if (element.props?.mdxType && element.props.originalType) {
     const {mdxType, originalType, ...newProps} = element.props;
     return React.createElement(element.props.originalType, newProps);
   }
@@ -17,7 +17,7 @@ function unwrapMDXElement(element) {
 }
 export default function MDXHead(props) {
   const unwrappedChildren = React.Children.map(props.children, (child) =>
-    unwrapMDXElement(child),
+    React.isValidElement(child) ? unwrapMDXElement(child) : child,
   );
   return <Head {...props}>{unwrappedChildren}</Head>;
 }

package/lib/theme/MDXComponents/Pre.js

@@ -11,8 +11,8 @@ export default function MDXPre(props) {
     <CodeBlock
       // If this pre is created by a ``` fenced codeblock, unwrap the children
       {...(isValidElement(props.children) &&
-      props.children.props.originalType === 'code'
-        ? props.children?.props
+      props.children.props?.originalType === 'code'
+        ? props.children.props
         : {...props})}
     />
   );

package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js

@@ -33,13 +33,13 @@ export default function DocsVersionDropdownNavbarItem({
     // We try to link to the same doc, in another version
     // When not possible, fallback to the "main doc" of the version
     const versionDoc =
-      activeDocContext?.alternateDocVersions[version.name] ??
+      activeDocContext.alternateDocVersions[version.name] ??
       getVersionMainDoc(version);
     return {
       isNavLink: true,
       label: version.label,
       to: versionDoc.path,
-      isActive: () => version === activeDocContext?.activeVersion,
+      isActive: () => version === activeDocContext.activeVersion,
       onClick: () => savePreferredVersionName(version.name),
     };
   });

package/lib/theme/NavbarItem/index.js

@@ -6,23 +6,19 @@
  */
 import React from 'react';
 import ComponentTypes from '@theme/NavbarItem/ComponentTypes';
-const getNavbarItemComponent = (type) => {
-  const component = ComponentTypes[type];
-  if (!component) {
-    throw new Error(`No NavbarItem component found for type "${type}".`);
-  }
-  return component;
-};
-function getComponentType(type, isDropdown) {
+function normalizeComponentType(type, props) {
   // Backward compatibility: navbar item with no type set
   // but containing dropdown items should use the type "dropdown"
   if (!type || type === 'default') {
-    return isDropdown ? 'dropdown' : 'default';
+    return 'items' in props ? 'dropdown' : 'default';
   }
   return type;
 }
 export default function NavbarItem({type, ...props}) {
-  const componentType = getComponentType(type, props.items !== undefined);
-  const NavbarItemComponent = getNavbarItemComponent(componentType);
+  const componentType = normalizeComponentType(type, props);
+  const NavbarItemComponent = ComponentTypes[componentType];
+  if (!NavbarItemComponent) {
+    throw new Error(`No NavbarItem component found for type "${type}".`);
+  }
   return <NavbarItemComponent {...props} />;
 }

package/lib/theme/Tabs/index.js

@@ -62,7 +62,7 @@ function TabsComponent(props) {
       ? defaultValueProp
       : defaultValueProp ??
         children.find((child) => child.props.default)?.props.value ??
-        children[0]?.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
@@ -95,7 +95,7 @@ function TabsComponent(props) {
       blockElementScrollPositionUntilNextRender(newTab);
       setSelectedValue(newTabValue);
       if (groupId != null) {
-        setTabGroupChoices(groupId, newTabValue);
+        setTabGroupChoices(groupId, String(newTabValue));
       }
     }
   };
@@ -104,12 +104,12 @@ function TabsComponent(props) {
     switch (event.key) {
       case 'ArrowRight': {
         const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
-        focusElement = tabRefs[nextTab] || tabRefs[0];
+        focusElement = tabRefs[nextTab] ?? tabRefs[0];
         break;
       }
       case 'ArrowLeft': {
         const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
-        focusElement = tabRefs[prevTab] || tabRefs[tabRefs.length - 1];
+        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1];
         break;
       }
       default:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "0.0.0-5044",
+  "version": "0.0.0-5049",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
   "types": "src/theme-classic.d.ts",
@@ -20,15 +20,15 @@
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5044",
-    "@docusaurus/plugin-content-blog": "0.0.0-5044",
-    "@docusaurus/plugin-content-docs": "0.0.0-5044",
-    "@docusaurus/plugin-content-pages": "0.0.0-5044",
-    "@docusaurus/theme-common": "0.0.0-5044",
-    "@docusaurus/theme-translations": "0.0.0-5044",
-    "@docusaurus/utils": "0.0.0-5044",
-    "@docusaurus/utils-common": "0.0.0-5044",
-    "@docusaurus/utils-validation": "0.0.0-5044",
+    "@docusaurus/core": "0.0.0-5049",
+    "@docusaurus/plugin-content-blog": "0.0.0-5049",
+    "@docusaurus/plugin-content-docs": "0.0.0-5049",
+    "@docusaurus/plugin-content-pages": "0.0.0-5049",
+    "@docusaurus/theme-common": "0.0.0-5049",
+    "@docusaurus/theme-translations": "0.0.0-5049",
+    "@docusaurus/utils": "0.0.0-5049",
+    "@docusaurus/utils-common": "0.0.0-5049",
+    "@docusaurus/utils-validation": "0.0.0-5049",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.0.1",
@@ -43,8 +43,8 @@
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5044",
-    "@docusaurus/types": "0.0.0-5044",
+    "@docusaurus/module-type-aliases": "0.0.0-5049",
+    "@docusaurus/types": "0.0.0-5049",
     "@types/mdx-js__react": "^1.5.5",
     "@types/nprogress": "^0.2.0",
     "@types/prismjs": "^1.26.0",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "9ffd6ca265dc2af7ed5b96daf5ebf32708e899cf"
+  "gitHead": "527b2a01c46b67483327a1a6873fccf81bc19e2c"
 }

package/src/index.ts

@@ -19,8 +19,9 @@ import type webpack from 'webpack';
 const requireFromDocusaurusCore = createRequire(
   require.resolve('@docusaurus/core/package.json'),
 );
-const ContextReplacementPlugin: typeof webpack.ContextReplacementPlugin =
-  requireFromDocusaurusCore('webpack/lib/ContextReplacementPlugin');
+const ContextReplacementPlugin = requireFromDocusaurusCore(
+  'webpack/lib/ContextReplacementPlugin',
+) as typeof webpack.ContextReplacementPlugin;
 
 // Need to be inlined to prevent dark mode FOUC
 // Make sure the key is the same as the one in `/theme/hooks/useTheme.js`
@@ -177,7 +178,7 @@ export default function themeClassic(
         const plugin: PostCssPlugin = {
           postcssPlugin: 'RtlCssPlugin',
           prepare: (result) => {
-            const file = result.root?.source?.input?.file;
+            const file = result.root.source?.input.file;
             // Skip Infima as we are using the its RTL version.
             if (file === resolvedInfimaFile) {
               return {};

package/src/theme/CodeBlock/Content/String.tsx

@@ -52,7 +52,7 @@ export default function CodeBlockString({
     magicComments,
   });
   const showLineNumbers =
-    showLineNumbersProp || containsLineNumbers(metastring);
+    showLineNumbersProp ?? containsLineNumbers(metastring);
 
   return (
     <Container

package/src/theme/DocSidebarItem/Html/index.tsx

@@ -23,7 +23,7 @@ export default function DocSidebarItemHtml({
       className={clsx(
         ThemeClassNames.docs.docSidebarItemLink,
         ThemeClassNames.docs.docSidebarItemLinkLevel(level),
-        defaultStyle && `${styles.menuHtmlItem} menu__list-item`,
+        defaultStyle && [styles.menuHtmlItem, 'menu__list-item'],
         className,
       )}
       key={index}

package/src/theme/Footer/Links/MultiColumn/index.tsx

@@ -21,7 +21,7 @@ function ColumnLinkItem({item}: {item: ColumnItemType}) {
       dangerouslySetInnerHTML={{__html: item.html}}
     />
   ) : (
-    <li key={item.href || item.to} className="footer__item">
+    <li key={item.href ?? item.to} className="footer__item">
       <LinkItem item={item} />
     </li>
   );

package/src/theme/MDXComponents/Details.tsx

@@ -10,11 +10,13 @@ import Details from '@theme/Details';
 import type {Props} from '@theme/MDXComponents/Details';
 
 export default function MDXDetails(props: Props): JSX.Element {
-  const items = React.Children.toArray(props.children) as ReactElement[];
+  const items = React.Children.toArray(props.children);
   // Split summary item from the rest to pass it as a separate prop to the
   // Details theme component
-  const summary: ReactElement<ComponentProps<'summary'>> | undefined =
-    items.find((item) => item?.props?.mdxType === 'summary');
+  const summary = items.find(
+    (item): item is ReactElement<ComponentProps<'summary'>> =>
+      React.isValidElement(item) && item.props?.mdxType === 'summary',
+  );
   const children = <>{items.filter((item) => item !== summary)}</>;
 
   return (

package/src/theme/MDXComponents/Head.tsx

@@ -11,8 +11,10 @@ import type {Props} from '@theme/MDXComponents/Head';
 
 // MDX elements are wrapped through the MDX pragma. In some cases (notably usage
 // with Head/Helmet) we need to unwrap those elements.
-function unwrapMDXElement(element: ReactElement) {
-  if (element?.props?.mdxType && element?.props?.originalType) {
+function unwrapMDXElement(
+  element: ReactElement<{mdxType?: string; originalType?: string} | undefined>,
+) {
+  if (element.props?.mdxType && element.props.originalType) {
     const {mdxType, originalType, ...newProps} = element.props;
     return React.createElement(element.props.originalType, newProps);
   }
@@ -21,7 +23,7 @@ function unwrapMDXElement(element: ReactElement) {
 
 export default function MDXHead(props: Props): JSX.Element {
   const unwrappedChildren = React.Children.map(props.children, (child) =>
-    unwrapMDXElement(child as ReactElement),
+    React.isValidElement(child) ? unwrapMDXElement(child) : child,
   );
   return (
     <Head {...(props as ComponentProps<typeof Head>)}>{unwrappedChildren}</Head>

package/src/theme/MDXComponents/Pre.tsx

@@ -14,8 +14,8 @@ export default function MDXPre(props: Props): JSX.Element {
     <CodeBlock
       // If this pre is created by a ``` fenced codeblock, unwrap the children
       {...(isValidElement(props.children) &&
-      props.children.props.originalType === 'code'
-        ? props.children?.props
+      props.children.props?.originalType === 'code'
+        ? props.children.props
         : {...props})}
     />
   );

package/src/theme/Navbar/Content/index.tsx

@@ -11,13 +11,12 @@ import {
   useNavbarMobileSidebar,
   useThemeConfig,
 } from '@docusaurus/theme-common';
-import NavbarItem from '@theme/NavbarItem';
+import NavbarItem, {type Props as NavbarItemConfig} from '@theme/NavbarItem';
 import NavbarColorModeToggle from '@theme/Navbar/ColorModeToggle';
 import SearchBar from '@theme/SearchBar';
 import NavbarMobileSidebarToggle from '@theme/Navbar/MobileSidebar/Toggle';
 import NavbarLogo from '@theme/Navbar/Logo';
 import NavbarSearch from '@theme/Navbar/Search';
-import type {Props as NavbarItemConfig} from '@theme/NavbarItem';
 
 import styles from './styles.module.css';
 

package/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx

@@ -7,8 +7,7 @@
 
 import React from 'react';
 import {useNavbarMobileSidebar, useThemeConfig} from '@docusaurus/theme-common';
-import NavbarItem from '@theme/NavbarItem';
-import type {Props as NavbarItemConfig} from '@theme/NavbarItem';
+import NavbarItem, {type Props as NavbarItemConfig} from '@theme/NavbarItem';
 
 function useNavbarItems() {
   // TODO temporary casting until ThemeConfig type is improved

package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx

@@ -38,13 +38,13 @@ export default function DocsVersionDropdownNavbarItem({
     // We try to link to the same doc, in another version
     // When not possible, fallback to the "main doc" of the version
     const versionDoc =
-      activeDocContext?.alternateDocVersions[version.name] ??
+      activeDocContext.alternateDocVersions[version.name] ??
       getVersionMainDoc(version);
     return {
       isNavLink: true,
       label: version.label,
       to: versionDoc.path,
-      isActive: () => version === activeDocContext?.activeVersion,
+      isActive: () => version === activeDocContext.activeVersion,
       onClick: () => savePreferredVersionName(version.name),
     };
   });

package/src/theme/NavbarItem/DropdownNavbarItem.tsx

@@ -15,12 +15,11 @@ import {
   useLocalPathname,
 } from '@docusaurus/theme-common';
 import NavbarNavLink from '@theme/NavbarItem/NavbarNavLink';
-import NavbarItem from '@theme/NavbarItem';
+import NavbarItem, {type LinkLikeNavbarItemProps} from '@theme/NavbarItem';
 import type {
   DesktopOrMobileNavBarItemProps,
   Props,
 } from '@theme/NavbarItem/DropdownNavbarItem';
-import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem';
 
 const dropdownLinkActiveClass = 'dropdown__link--active';
 

package/src/theme/NavbarItem/index.tsx

@@ -7,31 +7,22 @@
 
 import React from 'react';
 import ComponentTypes from '@theme/NavbarItem/ComponentTypes';
-import {type Props as DropdownNavbarItemProps} from '@theme/NavbarItem/DropdownNavbarItem';
-import type {Types, Props} from '@theme/NavbarItem';
+import type {NavbarItemType, Props} from '@theme/NavbarItem';
 
-const getNavbarItemComponent = (type: NonNullable<Types>) => {
-  const component = ComponentTypes[type];
-  if (!component) {
-    throw new Error(`No NavbarItem component found for type "${type}".`);
-  }
-  return component;
-};
-
-function getComponentType(type: Types, isDropdown: boolean) {
+function normalizeComponentType(type: NavbarItemType, props: object) {
   // Backward compatibility: navbar item with no type set
   // but containing dropdown items should use the type "dropdown"
   if (!type || type === 'default') {
-    return isDropdown ? 'dropdown' : 'default';
+    return 'items' in props ? 'dropdown' : 'default';
   }
-  return type as NonNullable<Types>;
+  return type;
 }
 
 export default function NavbarItem({type, ...props}: Props): JSX.Element {
-  const componentType = getComponentType(
-    type,
-    (props as DropdownNavbarItemProps).items !== undefined,
-  );
-  const NavbarItemComponent = getNavbarItemComponent(componentType);
+  const componentType = normalizeComponentType(type, props);
+  const NavbarItemComponent = ComponentTypes[componentType];
+  if (!NavbarItemComponent) {
+    throw new Error(`No NavbarItem component found for type "${type}".`);
+  }
   return <NavbarItemComponent {...(props as never)} />;
 }

package/src/theme/Tabs/index.tsx

@@ -75,7 +75,7 @@ function TabsComponent(props: Props): JSX.Element {
       ? defaultValueProp
       : defaultValueProp ??
         children.find((child) => child.props.default)?.props.value ??
-        children[0]?.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
@@ -115,7 +115,7 @@ function TabsComponent(props: Props): JSX.Element {
       setSelectedValue(newTabValue);
 
       if (groupId != null) {
-        setTabGroupChoices(groupId, newTabValue);
+        setTabGroupChoices(groupId, String(newTabValue));
       }
     }
   };
@@ -126,12 +126,12 @@ function TabsComponent(props: Props): JSX.Element {
     switch (event.key) {
       case 'ArrowRight': {
         const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
-        focusElement = tabRefs[nextTab] || tabRefs[0]!;
+        focusElement = tabRefs[nextTab] ?? tabRefs[0]!;
         break;
       }
       case 'ArrowLeft': {
         const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
-        focusElement = tabRefs[prevTab] || tabRefs[tabRefs.length - 1]!;
+        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1]!;
         break;
       }
       default:

package/src/theme-classic.d.ts

@@ -21,12 +21,14 @@
 // in their tsconfig.
 
 declare module '@docusaurus/theme-classic' {
-  import type {LoadContext, Plugin} from '@docusaurus/types';
+  import type {LoadContext, Plugin, PluginModule} from '@docusaurus/types';
 
   export type Options = {
     customCss?: string | string[];
   };
 
+  export const getSwizzleConfig: PluginModule['getSwizzleConfig'];
+
   export default function themeClassic(
     context: LoadContext,
     options: Options,
@@ -814,7 +816,6 @@ declare module '@theme/NavbarItem/NavbarNavLink' {
 
 declare module '@theme/NavbarItem/DropdownNavbarItem' {
   import type {Props as NavbarNavLinkProps} from '@theme/NavbarItem/NavbarNavLink';
-
   import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem';
 
   export type DesktopOrMobileNavBarItemProps = NavbarNavLinkProps & {
@@ -974,7 +975,7 @@ declare module '@theme/NavbarItem' {
         } & SearchNavbarItemProps)
     );
 
-  export type Types = Props['type'];
+  export type NavbarItemType = Props['type'];
 
   export default function NavbarItem(props: Props): JSX.Element;
 }
@@ -1031,10 +1032,10 @@ declare module '@theme/Tabs' {
     readonly lazy?: boolean;
     readonly block?: boolean;
     readonly children: readonly ReactElement<TabItemProps>[];
-    readonly defaultValue?: string | null;
+    readonly defaultValue?: string | number | null;
     readonly values?: readonly {
-      value: string;
-      label?: string;
+      value: string | number;
+      label?: string | number;
       attributes?: {[key: string]: unknown};
     }[];
     readonly groupId?: string;