From c7878533edb3ae03f15351d1d91b49d50b8a59f1 Mon Sep 17 00:00:00 2001 From: Jack Hsu Date: Fri, 5 Jul 2024 09:29:08 -0400 Subject: [PATCH] docs(misc): disable prefetch on page load for links (#26837) This PR changes `` to use `prefetch={false}` in the following components: 1. Header 2. Sidebar 3. Docs header 4. Markdown content This means that prefetch happens on hover of the link rather than page load, and will reduce the amount of edge requests made from the app. ## Current Behavior ## Expected Behavior ## Related Issue(s) Fixes # --- .../src/lib/related-documents-section.tsx | 1 + .../src/lib/table-of-contents.tsx | 1 + .../src/lib/content.tsx | 1 + nx-dev/feature-search/src/lib/algolia-search.tsx | 6 +++++- nx-dev/nx-dev/pages/changelog.tsx | 6 +++++- nx-dev/nx-dev/pages/nx-api/index.tsx | 7 ++++++- nx-dev/nx-dev/pages/tips.tsx | 16 ++++++++++++++++ nx-dev/ui-blog/src/lib/blog-details.tsx | 1 + nx-dev/ui-blog/src/lib/blog-entry.tsx | 1 + nx-dev/ui-blog/src/lib/more-blogs.tsx | 1 + nx-dev/ui-common/src/lib/button.tsx | 1 + nx-dev/ui-common/src/lib/footer.tsx | 5 +++++ .../src/lib/headers/default-menu-item.tsx | 1 + .../src/lib/headers/documentation-header.tsx | 6 ++++++ nx-dev/ui-common/src/lib/headers/header.tsx | 9 +++++++++ .../src/lib/headers/mobile-menu-item.tsx | 1 + nx-dev/ui-common/src/lib/plugin-card.tsx | 1 + nx-dev/ui-common/src/lib/sidebar.tsx | 10 +++++++++- nx-dev/ui-community/src/lib/connect-with-us.tsx | 6 +++++- nx-dev/ui-contact/src/lib/contact-links.tsx | 1 + nx-dev/ui-enterprise/src/lib/bento-grid.tsx | 1 + nx-dev/ui-enterprise/src/lib/call-to-action.tsx | 2 ++ nx-dev/ui-enterprise/src/lib/hero.tsx | 1 + .../src/lib/extensible-and-integrated.tsx | 4 ++++ .../ide-integration-tab.tsx | 2 +- nx-dev/ui-home/src/lib/hero.tsx | 1 + .../src/lib/migrations-and-code-generation.tsx | 1 + nx-dev/ui-home/src/lib/monorepo-styles.tsx | 2 ++ nx-dev/ui-home/src/lib/nx-with-ci.tsx | 1 + .../ui-markdoc/src/lib/nodes/link.component.tsx | 1 + .../ui-markdoc/src/lib/tags/cards.component.tsx | 3 +++ .../src/lib/tags/personas.component.tsx | 1 + .../ui-markdoc/src/lib/tags/pill.component.tsx | 1 + 33 files changed, 97 insertions(+), 6 deletions(-) diff --git a/nx-dev/feature-doc-viewer/src/lib/related-documents-section.tsx b/nx-dev/feature-doc-viewer/src/lib/related-documents-section.tsx index a9d733d82c..2fab5c2ffc 100644 --- a/nx-dev/feature-doc-viewer/src/lib/related-documents-section.tsx +++ b/nx-dev/feature-doc-viewer/src/lib/related-documents-section.tsx @@ -54,6 +54,7 @@ function CategoryBox({ category }: { category: RelatedDocumentsCategory }) { {d.name} diff --git a/nx-dev/feature-doc-viewer/src/lib/table-of-contents.tsx b/nx-dev/feature-doc-viewer/src/lib/table-of-contents.tsx index 05c35a399a..364a4c18c5 100644 --- a/nx-dev/feature-doc-viewer/src/lib/table-of-contents.tsx +++ b/nx-dev/feature-doc-viewer/src/lib/table-of-contents.tsx @@ -93,6 +93,7 @@ export function TableOfContents({ 'pl-6': item.level === 3, } )} + prefetch={false} > {item.level === 1 ? 'Overview' : item.title} diff --git a/nx-dev/feature-package-schema-viewer/src/lib/content.tsx b/nx-dev/feature-package-schema-viewer/src/lib/content.tsx index bd79892d3e..1101c0e561 100644 --- a/nx-dev/feature-package-schema-viewer/src/lib/content.tsx +++ b/nx-dev/feature-package-schema-viewer/src/lib/content.tsx @@ -129,6 +129,7 @@ export function Content({ className="relative mx-4 inline-flex rounded-md border border-green-100 bg-green-50 px-4 py-2 text-xs font-medium text-green-600 dark:border-green-900 dark:bg-green-900/30 dark:text-green-400" href="/recipes/other/rescope" title="Nx 16 package name changes" + prefetch={false} > Rescope @nrwl to @nx diff --git a/nx-dev/feature-search/src/lib/algolia-search.tsx b/nx-dev/feature-search/src/lib/algolia-search.tsx index b82187f93f..4a0742d2bf 100644 --- a/nx-dev/feature-search/src/lib/algolia-search.tsx +++ b/nx-dev/feature-search/src/lib/algolia-search.tsx @@ -20,7 +20,11 @@ function Hit({ hit: InternalDocSearchHit | StoredDocSearchHit; children: ReactNode; }): JSX.Element { - return {children}; + return ( + + {children} + + ); } export function AlgoliaSearch({ diff --git a/nx-dev/nx-dev/pages/changelog.tsx b/nx-dev/nx-dev/pages/changelog.tsx index 903f6a1374..931345fe82 100644 --- a/nx-dev/nx-dev/pages/changelog.tsx +++ b/nx-dev/nx-dev/pages/changelog.tsx @@ -240,7 +240,11 @@ export default function Changelog(props: ChangeLogProps): JSX.Element {

All the Nx goodies in one page, sorted by release. See our{' '} - + release page {' '} for information about the release cycle and LTS policy. diff --git a/nx-dev/nx-dev/pages/nx-api/index.tsx b/nx-dev/nx-dev/pages/nx-api/index.tsx index 15bcc686ef..0a5b1d57a2 100644 --- a/nx-dev/nx-dev/pages/nx-api/index.tsx +++ b/nx-dev/nx-dev/pages/nx-api/index.tsx @@ -114,7 +114,11 @@ export default function Packages({

In version 16, we have rescoped our packages to{' '} @nx/* from @nrwl/*.{' '} - + Read more about the rescope ≫

@@ -129,6 +133,7 @@ export default function Packages({ key={'ref-' + pkg.name} href={pkg.path} className="group relative flex items-center gap-3 rounded-md border border-slate-200 bg-slate-50/40 p-4 text-sm capitalize shadow-sm transition hover:bg-slate-50 dark:border-slate-800/40 dark:bg-slate-800/60 dark:hover:bg-slate-800" + prefetch={false} > Intro to Nx @@ -78,6 +79,7 @@ const tips: NewYearTip[] = [ Types of Repos Guide @@ -109,6 +111,7 @@ const tips: NewYearTip[] = [ Nx Agents @@ -120,6 +123,7 @@ const tips: NewYearTip[] = [ CI with Nx @@ -153,6 +157,7 @@ const tips: NewYearTip[] = [ Add Nx to an Existing Project @@ -187,6 +192,7 @@ const tips: NewYearTip[] = [ Micro Frontends with Nx @@ -211,18 +217,21 @@ const tips: NewYearTip[] = [ {frameworkIcons.react.image} {frameworkIcons.angular.image} {frameworkIcons.vue.image} @@ -232,6 +241,7 @@ const tips: NewYearTip[] = [ Nx with your Favorite Tech @@ -266,6 +276,7 @@ const tips: NewYearTip[] = [ Build Your Own CLI @@ -304,6 +315,7 @@ const tips: NewYearTip[] = [ Sign up now for early access. @@ -313,6 +325,7 @@ const tips: NewYearTip[] = [ Nx Agents @@ -347,6 +360,7 @@ const tips: NewYearTip[] = [ convert a standalone app repo to a monorepo @@ -378,6 +392,7 @@ const tips: NewYearTip[] = [ Evergreen Tooling @@ -388,6 +403,7 @@ const tips: NewYearTip[] = [ Automate Updating Dependencies diff --git a/nx-dev/ui-blog/src/lib/blog-details.tsx b/nx-dev/ui-blog/src/lib/blog-details.tsx index 3ea0f29c15..6e19e9031d 100644 --- a/nx-dev/ui-blog/src/lib/blog-details.tsx +++ b/nx-dev/ui-blog/src/lib/blog-details.tsx @@ -46,6 +46,7 @@ export function BlogDetails({ post }: BlogDetailsProps) { Blog diff --git a/nx-dev/ui-blog/src/lib/blog-entry.tsx b/nx-dev/ui-blog/src/lib/blog-entry.tsx index e720b7b6fa..2960c6fc89 100644 --- a/nx-dev/ui-blog/src/lib/blog-entry.tsx +++ b/nx-dev/ui-blog/src/lib/blog-entry.tsx @@ -28,6 +28,7 @@ export function BlogEntry({ post }: BlogEntryProps) { href={`/blog/${post.slug}`} title={post.title} className="text-balance text-lg font-semibold text-slate-900 dark:text-white" + prefetch={false} >