fix useBrokenLinks docs examples

facebook · Jan 12, 2024 · 890e8b6 · 890e8b6
1 parent 8e66e05
commit 890e8b6
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 20 deletions.
diff --git a/website/docs/docusaurus-core.mdx b/website/docs/docusaurus-core.mdx
@@ -627,24 +627,18 @@ Usage example:
 ```js title="MyHeading.js"
 import useBrokenLinks from '@docusaurus/useBrokenLinks';
 
-export default function MyHeading({id, ...props}): JSX.Element {
-  const brokenLinks = useBrokenLinks();
-
-  brokenLinks.collectAnchor(id);
-
-  return <h2 id={id}>Heading</h2>;
+export default function MyHeading(props) {
+  useBrokenLinks().collectAnchor(props.id);
+  return <h2 {...props} />;
 }
 ```
 
 ```js title="MyLink.js"
 import useBrokenLinks from '@docusaurus/useBrokenLinks';
 
-export default function MyLink({targetLink, ...props}): JSX.Element {
-  const brokenLinks = useBrokenLinks();
-
-  brokenLinks.collectLink(targetLink);
-
-  return <a href={targetLink}>Link</a>;
+export default function MyLink(props) {
+  useBrokenLinks().collectLink(props.href);
+  return <a {...props} />;
 }
 ```
 

diff --git a/website/versioned_docs/version-3.1.0/docusaurus-core.mdx b/website/versioned_docs/version-3.1.0/docusaurus-core.mdx
@@ -622,19 +622,19 @@ Usage example:
 
 ```js title="MyHeading.js"
 import useBrokenLinks from '@docusaurus/useBrokenLinks';
-export default function MyHeading({id, ...props}): JSX.Element {
-  const brokenLinks = useBrokenLinks();
-  brokenLinks.collectAnchor(id);
-  return <h2 id={id}>Heading</h2>;
+
+export default function MyHeading(props) {
+  useBrokenLinks().collectAnchor(props.id);
+  return <h2 {...props} />;
 }
 ```
 
 ```js title="MyLink.js"
 import useBrokenLinks from '@docusaurus/useBrokenLinks';
-export default function MyLink({targetLink, ...props}): JSX.Element {
-  const brokenLinks = useBrokenLinks();
-  brokenLinks.collectLink(targetLink);
-  return <a href={targetLink}>Link</a>;
+
+export default function MyLink(props) {
+  useBrokenLinks().collectLink(props.href);
+  return <a {...props} />;
 }
 ```