@docusaurus/theme-classic 3.8.1-canary-6352 → 3.8.1-canary-6355

package/lib/theme/MDXComponents/A/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 {useThemeConfig} from '@docusaurus/theme-common';
+import styles from './styles.module.css';
+function isFootnoteRef(props) {
+  return props['data-footnote-ref'] === true;
+}
+function FootnoteRefLink(props) {
+  const {
+    navbar: {hideOnScroll},
+  } = useThemeConfig();
+  return (
+    <Link
+      {...props}
+      className={clsx(
+        hideOnScroll
+          ? styles.footnoteRefHideOnScrollNavbar
+          : styles.footnoteRefStickyNavbar,
+        props.className,
+      )}
+    />
+  );
+}
+export default function MDXA(props) {
+  if (isFootnoteRef(props)) {
+    return <FootnoteRefLink {...props} />;
+  }
+  return <Link {...props} />;
+}

package/lib/theme/MDXComponents/A/styles.module.css

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+
+/*
+When the navbar is sticky, ensure that on footnote click,
+the browser does not scroll to the ref behind the navbar
+See https://github.com/facebook/docusaurus/issues/11232
+See also headings case https://x.com/JoshWComeau/status/1332015868725891076
+ */
+.footnoteRefStickyNavbar {
+  scroll-margin-top: calc(var(--ifm-navbar-height) + 0.5rem);
+}
+
+.footnoteRefHideOnScrollNavbar {
+  scroll-margin-top: 0.5rem;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "3.8.1-canary-6352",
+  "version": "3.8.1-canary-6355",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
   "types": "src/theme-classic.d.ts",
@@ -20,19 +20,19 @@
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
-    "@docusaurus/core": "3.8.1-canary-6352",
-    "@docusaurus/logger": "3.8.1-canary-6352",
-    "@docusaurus/mdx-loader": "3.8.1-canary-6352",
-    "@docusaurus/module-type-aliases": "3.8.1-canary-6352",
-    "@docusaurus/plugin-content-blog": "3.8.1-canary-6352",
-    "@docusaurus/plugin-content-docs": "3.8.1-canary-6352",
-    "@docusaurus/plugin-content-pages": "3.8.1-canary-6352",
-    "@docusaurus/theme-common": "3.8.1-canary-6352",
-    "@docusaurus/theme-translations": "3.8.1-canary-6352",
-    "@docusaurus/types": "3.8.1-canary-6352",
-    "@docusaurus/utils": "3.8.1-canary-6352",
-    "@docusaurus/utils-common": "3.8.1-canary-6352",
-    "@docusaurus/utils-validation": "3.8.1-canary-6352",
+    "@docusaurus/core": "3.8.1-canary-6355",
+    "@docusaurus/logger": "3.8.1-canary-6355",
+    "@docusaurus/mdx-loader": "3.8.1-canary-6355",
+    "@docusaurus/module-type-aliases": "3.8.1-canary-6355",
+    "@docusaurus/plugin-content-blog": "3.8.1-canary-6355",
+    "@docusaurus/plugin-content-docs": "3.8.1-canary-6355",
+    "@docusaurus/plugin-content-pages": "3.8.1-canary-6355",
+    "@docusaurus/theme-common": "3.8.1-canary-6355",
+    "@docusaurus/theme-translations": "3.8.1-canary-6355",
+    "@docusaurus/types": "3.8.1-canary-6355",
+    "@docusaurus/utils": "3.8.1-canary-6355",
+    "@docusaurus/utils-common": "3.8.1-canary-6355",
+    "@docusaurus/utils-validation": "3.8.1-canary-6355",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "copy-text-to-clipboard": "^3.2.0",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "a3190d2cdcb4d4ab6704dbd8de92868ef67165cb"
+  "gitHead": "7ae9abedad811ceda2541c11789266cb66abfbb6"
 }

package/src/theme/MDXComponents/A/index.tsx

@@ -0,0 +1,42 @@
+/**
+ * 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, {type ReactNode} from 'react';
+import clsx from 'clsx';
+import Link from '@docusaurus/Link';
+import {useThemeConfig} from '@docusaurus/theme-common';
+import type {Props} from '@theme/MDXComponents/A';
+import styles from './styles.module.css';
+
+function isFootnoteRef(props: Props) {
+  return props['data-footnote-ref'] === true;
+}
+
+function FootnoteRefLink(props: Props) {
+  const {
+    navbar: {hideOnScroll},
+  } = useThemeConfig();
+  return (
+    <Link
+      {...props}
+      className={clsx(
+        hideOnScroll
+          ? styles.footnoteRefHideOnScrollNavbar
+          : styles.footnoteRefStickyNavbar,
+
+        props.className,
+      )}
+    />
+  );
+}
+
+export default function MDXA(props: Props): ReactNode {
+  if (isFootnoteRef(props)) {
+    return <FootnoteRefLink {...props} />;
+  }
+  return <Link {...props} />;
+}

package/src/theme/MDXComponents/A/styles.module.css

@@ -0,0 +1,20 @@
+/**
+ * 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.
+ */
+
+/*
+When the navbar is sticky, ensure that on footnote click,
+the browser does not scroll to the ref behind the navbar
+See https://github.com/facebook/docusaurus/issues/11232
+See also headings case https://x.com/JoshWComeau/status/1332015868725891076
+ */
+.footnoteRefStickyNavbar {
+  scroll-margin-top: calc(var(--ifm-navbar-height) + 0.5rem);
+}
+
+.footnoteRefHideOnScrollNavbar {
+  scroll-margin-top: 0.5rem;
+}

package/src/theme-classic.d.ts

@@ -1040,7 +1040,9 @@ declare module '@theme/SkipToContent' {
 declare module '@theme/MDXComponents/A' {
   import type {ComponentProps, ReactNode} from 'react';
 
-  export interface Props extends ComponentProps<'a'> {}
+  export interface Props extends ComponentProps<'a'> {
+    'data-footnote-ref'?: true;
+  }
 
   export default function MDXA(props: Props): ReactNode;
 }

package/lib/theme/MDXComponents/A.js

@@ -1,11 +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 React from 'react';
-import Link from '@docusaurus/Link';
-export default function MDXA(props) {
-  return <Link {...props} />;
-}

package/src/theme/MDXComponents/A.tsx

@@ -1,14 +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 React, {type ReactNode} from 'react';
-import Link from '@docusaurus/Link';
-import type {Props} from '@theme/MDXComponents/A';
-
-export default function MDXA(props: Props): ReactNode {
-  return <Link {...props} />;
-}