@docusaurus/theme-classic 0.0.0-4299 → 0.0.0-4308

package/lib/theme-classic.d.ts

@@ -123,13 +123,22 @@ declare module '@theme/CodeBlock' {
 declare module '@theme/DocPaginator' {
   import type {PropNavigation} from '@docusaurus/plugin-content-docs';
 
-  type PageInfo = {readonly permalink: string; readonly title: string};
-
   // May be simpler to provide a {navigation: PropNavigation} prop?
   export interface Props extends PropNavigation {}
 
-  const DocPaginator: (props: Props) => JSX.Element;
-  export default DocPaginator;
+  export default function DocPaginator(props: Props): JSX.Element;
+}
+
+declare module '@theme/DocPaginatorNavLink' {
+  import type {PropNavigationLink} from '@docusaurus/plugin-content-docs';
+
+  // May be simpler to provide a {navigation: PropNavigation} prop?
+  export interface Props {
+    navLink: PropNavigationLink;
+    next?: boolean;
+  }
+
+  export default function DocPaginatorNavLink(props: Props): JSX.Element;
 }
 
 declare module '@theme/DocSidebar' {

package/lib/translations.js

@@ -69,14 +69,14 @@ function translateNavbar(navbar, navbarTranslations) {
 }
 
 function isMultiColumnFooterLinks(links) {
-  return 'title' in links[0];
+  return links.length > 0 && 'title' in links[0];
 }
 
 function getFooterTranslationFile(footer) {
-  const footerLinkTitles = isMultiColumnFooterLinks(footer.links) ? (0, _lodash.chain)(footer.links.filter(link => !!link.title)).keyBy(link => `link.title.${link.title}`).mapValues(link => ({
+  const footerLinkTitles = (0, _lodash.chain)(isMultiColumnFooterLinks(footer.links) ? 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() : {};
+  })).value();
   const footerLinkLabels = (0, _lodash.chain)(isMultiColumnFooterLinks(footer.links) ? footer.links.flatMap(link => link.items).filter(link => !!link.label) : footer.links.filter(link => !!link.label)).keyBy(linkItem => `link.item.label.${linkItem.label}`).mapValues(linkItem => {
     var _linkItem$to;
 

package/lib/validateThemeConfig.js

@@ -263,9 +263,9 @@ const ThemeConfigSchema = _utilsValidation.Joi.object({
     links: _utilsValidation.Joi.alternatives(_utilsValidation.Joi.array().items(_utilsValidation.Joi.object({
       title: _utilsValidation.Joi.string().allow(null).default(null),
       items: _utilsValidation.Joi.array().items(FooterLinkItemSchema).default([])
-    })).default([]), _utilsValidation.Joi.array().items(FooterLinkItemSchema).default([])).messages({
+    })), _utilsValidation.Joi.array().items(FooterLinkItemSchema)).messages({
       'alternatives.match': `The footer must be either simple or multi-column, and not a mix of the two. See: https://docusaurus.io/docs/api/themes/configuration#footer-links`
-    })
+    }).default([])
   }).optional(),
   prism: _utilsValidation.Joi.object({
     theme: _utilsValidation.Joi.object({

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

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import Link from '@docusaurus/Link';
-import Translate, {translate} from '@docusaurus/Translate';
+import {translate} from '@docusaurus/Translate';
+import DocPaginatorNavLink from '@theme/DocPaginatorNavLink';
 
 function DocPaginator(props) {
   const {previous, next} = props;
@@ -19,34 +19,10 @@ function DocPaginator(props) {
         description: 'The ARIA label for the docs pagination',
       })}>
       <div className="pagination-nav__item">
-        {previous && (
-          <Link className="pagination-nav__link" to={previous.permalink}>
-            <div className="pagination-nav__sublabel">
-              <Translate
-                id="theme.docs.paginator.previous"
-                description="The label used to navigate to the previous doc">
-                Previous
-              </Translate>
-            </div>
-            <div className="pagination-nav__label">
-              &laquo; {previous.title}
-            </div>
-          </Link>
-        )}
+        {previous && <DocPaginatorNavLink navLink={previous} />}
       </div>
       <div className="pagination-nav__item pagination-nav__item--next">
-        {next && (
-          <Link className="pagination-nav__link" to={next.permalink}>
-            <div className="pagination-nav__sublabel">
-              <Translate
-                id="theme.docs.paginator.next"
-                description="The label used to navigate to the next doc">
-                Next
-              </Translate>
-            </div>
-            <div className="pagination-nav__label">{next.title} &raquo;</div>
-          </Link>
-        )}
+        {next && <DocPaginatorNavLink navLink={next} next />}
       </div>
     </nav>
   );

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

@@ -0,0 +1,36 @@
+/**
+ * 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 Translate from '@docusaurus/Translate';
+
+function DocPaginatorNavLink(props) {
+  const {navLink, next} = props;
+  return (
+    <Link className={clsx('pagination-nav__link')} to={navLink.permalink}>
+      <div className="pagination-nav__sublabel">
+        {next ? (
+          <Translate
+            id="theme.docs.paginator.next"
+            description="The label used to navigate to the next doc">
+            Next
+          </Translate>
+        ) : (
+          <Translate
+            id="theme.docs.paginator.previous"
+            description="The label used to navigate to the previous doc">
+            Previous
+          </Translate>
+        )}
+      </div>
+      <div className="pagination-nav__label">{navLink.title}</div>
+    </Link>
+  );
+}
+
+export default DocPaginatorNavLink;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "0.0.0-4299",
+  "version": "0.0.0-4308",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
   "types": "src/theme-classic.d.ts",
@@ -23,20 +23,20 @@
     "update-code-translations": "node -e 'require(\"./update-code-translations.js\").run()'"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4299",
-    "@docusaurus/plugin-content-blog": "0.0.0-4299",
-    "@docusaurus/plugin-content-docs": "0.0.0-4299",
-    "@docusaurus/plugin-content-pages": "0.0.0-4299",
-    "@docusaurus/theme-common": "0.0.0-4299",
-    "@docusaurus/theme-translations": "0.0.0-4299",
-    "@docusaurus/utils": "0.0.0-4299",
-    "@docusaurus/utils-validation": "0.0.0-4299",
+    "@docusaurus/core": "0.0.0-4308",
+    "@docusaurus/plugin-content-blog": "0.0.0-4308",
+    "@docusaurus/plugin-content-docs": "0.0.0-4308",
+    "@docusaurus/plugin-content-pages": "0.0.0-4308",
+    "@docusaurus/theme-common": "0.0.0-4308",
+    "@docusaurus/theme-translations": "0.0.0-4308",
+    "@docusaurus/utils": "0.0.0-4308",
+    "@docusaurus/utils-validation": "0.0.0-4308",
     "@mdx-js/mdx": "^1.6.21",
     "@mdx-js/react": "^1.6.21",
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.0.1",
     "globby": "^11.0.2",
-    "infima": "0.2.0-alpha.36",
+    "infima": "0.2.0-alpha.37",
     "lodash": "^4.17.20",
     "postcss": "^8.3.7",
     "prism-react-renderer": "^1.2.1",
@@ -45,8 +45,8 @@
     "rtlcss": "^3.3.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4299",
-    "@docusaurus/types": "0.0.0-4299",
+    "@docusaurus/module-type-aliases": "0.0.0-4308",
+    "@docusaurus/types": "0.0.0-4308",
     "@types/mdx-js__react": "^1.5.4",
     "@types/parse-numeric-range": "^0.0.1",
     "@types/rtlcss": "^3.1.1",
@@ -61,5 +61,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "57801f0f237dda31b5aae8c8fdddea45528f5bf1"
+  "gitHead": "83ade5a0b1bd84548b0761ce8c2ea2aa929968ac"
 }

package/src/theme/DocPaginator/index.tsx

@@ -6,11 +6,11 @@
  */
 
 import React from 'react';
-import Link from '@docusaurus/Link';
-import Translate, {translate} from '@docusaurus/Translate';
-import type {PropNavigation} from '@docusaurus/plugin-content-docs';
+import {translate} from '@docusaurus/Translate';
+import DocPaginatorNavLink from '@theme/DocPaginatorNavLink';
+import type {Props} from '@theme/DocPaginator';
 
-function DocPaginator(props: PropNavigation): JSX.Element {
+function DocPaginator(props: Props): JSX.Element {
   const {previous, next} = props;
 
   return (
@@ -22,34 +22,10 @@ function DocPaginator(props: PropNavigation): JSX.Element {
         description: 'The ARIA label for the docs pagination',
       })}>
       <div className="pagination-nav__item">
-        {previous && (
-          <Link className="pagination-nav__link" to={previous.permalink}>
-            <div className="pagination-nav__sublabel">
-              <Translate
-                id="theme.docs.paginator.previous"
-                description="The label used to navigate to the previous doc">
-                Previous
-              </Translate>
-            </div>
-            <div className="pagination-nav__label">
-              &laquo; {previous.title}
-            </div>
-          </Link>
-        )}
+        {previous && <DocPaginatorNavLink navLink={previous} />}
       </div>
       <div className="pagination-nav__item pagination-nav__item--next">
-        {next && (
-          <Link className="pagination-nav__link" to={next.permalink}>
-            <div className="pagination-nav__sublabel">
-              <Translate
-                id="theme.docs.paginator.next"
-                description="The label used to navigate to the next doc">
-                Next
-              </Translate>
-            </div>
-            <div className="pagination-nav__label">{next.title} &raquo;</div>
-          </Link>
-        )}
+        {next && <DocPaginatorNavLink navLink={next} next />}
       </div>
     </nav>
   );

package/src/theme/DocPaginatorNavLink/index.tsx

@@ -0,0 +1,38 @@
+/**
+ * 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 Translate from '@docusaurus/Translate';
+import type {Props} from '@theme/DocPaginatorNavLink';
+
+function DocPaginatorNavLink(props: Props): JSX.Element {
+  const {navLink, next} = props;
+  return (
+    <Link className={clsx('pagination-nav__link')} to={navLink.permalink}>
+      <div className="pagination-nav__sublabel">
+        {next ? (
+          <Translate
+            id="theme.docs.paginator.next"
+            description="The label used to navigate to the next doc">
+            Next
+          </Translate>
+        ) : (
+          <Translate
+            id="theme.docs.paginator.previous"
+            description="The label used to navigate to the previous doc">
+            Previous
+          </Translate>
+        )}
+      </div>
+      <div className="pagination-nav__label">{navLink.title}</div>
+    </Link>
+  );
+}
+
+export default DocPaginatorNavLink;

package/src/theme-classic.d.ts

@@ -123,13 +123,22 @@ declare module '@theme/CodeBlock' {
 declare module '@theme/DocPaginator' {
   import type {PropNavigation} from '@docusaurus/plugin-content-docs';
 
-  type PageInfo = {readonly permalink: string; readonly title: string};
-
   // May be simpler to provide a {navigation: PropNavigation} prop?
   export interface Props extends PropNavigation {}
 
-  const DocPaginator: (props: Props) => JSX.Element;
-  export default DocPaginator;
+  export default function DocPaginator(props: Props): JSX.Element;
+}
+
+declare module '@theme/DocPaginatorNavLink' {
+  import type {PropNavigationLink} from '@docusaurus/plugin-content-docs';
+
+  // May be simpler to provide a {navigation: PropNavigation} prop?
+  export interface Props {
+    navLink: PropNavigationLink;
+    next?: boolean;
+  }
+
+  export default function DocPaginatorNavLink(props: Props): JSX.Element;
 }
 
 declare module '@theme/DocSidebar' {

package/src/translations.ts

@@ -74,21 +74,21 @@ function translateNavbar(
 function isMultiColumnFooterLinks(
   links: MultiColumnFooter['links'] | SimpleFooter['links'],
 ): links is MultiColumnFooter['links'] {
-  return 'title' in links[0];
+  return links.length > 0 && 'title' in links[0];
 }
 
 function getFooterTranslationFile(footer: Footer): TranslationFileContent {
-  const footerLinkTitles: TranslationFileContent = isMultiColumnFooterLinks(
-    footer.links,
+  const footerLinkTitles: TranslationFileContent = chain(
+    isMultiColumnFooterLinks(footer.links)
+      ? footer.links.filter((link) => !!link.title)
+      : [],
   )
-    ? 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()
-    : {};
+    .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: TranslationFileContent = chain(
     isMultiColumnFooterLinks(footer.links)

package/src/validateThemeConfig.ts

@@ -312,18 +312,18 @@ const ThemeConfigSchema = Joi.object({
     }),
     copyright: Joi.string(),
     links: Joi.alternatives(
-      Joi.array()
-        .items(
-          Joi.object({
-            title: Joi.string().allow(null).default(null),
-            items: Joi.array().items(FooterLinkItemSchema).default([]),
-          }),
-        )
-        .default([]),
-      Joi.array().items(FooterLinkItemSchema).default([]),
-    ).messages({
-      'alternatives.match': `The footer must be either simple or multi-column, and not a mix of the two. See: https://docusaurus.io/docs/api/themes/configuration#footer-links`,
-    }),
+      Joi.array().items(
+        Joi.object({
+          title: Joi.string().allow(null).default(null),
+          items: Joi.array().items(FooterLinkItemSchema).default([]),
+        }),
+      ),
+      Joi.array().items(FooterLinkItemSchema),
+    )
+      .messages({
+        'alternatives.match': `The footer must be either simple or multi-column, and not a mix of the two. See: https://docusaurus.io/docs/api/themes/configuration#footer-links`,
+      })
+      .default([]),
   }).optional(),
   prism: Joi.object({
     theme: Joi.object({