feat(core): Add env var to control default prefetch behavior

bigcommerce · Feb 14, 2024 · 78e16c0 · 78e16c0
1 parent 57996e8
commit 78e16c0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/.env.example b/.env.example
@@ -25,3 +25,8 @@ AUTH_SECRET=
 # https://turbo.build/repo/docs/core-concepts/remote-caching#artifact-integrity-and-authenticity-verification
 # This can also be generated with `openssl rand -hex 32`, but do not re-use the value from AUTH_SECRET
 TURBO_REMOTE_CACHE_SIGNATURE_KEY=
+
+# Controls the default behavior of Link components when a `prefetch` prop is not provided.
+# If set to `true`, Link components will default to `prefetch=true`.
+# Otherwise, Link components will default to `prefetch=false`.
+DEFAULT_PREFETCH_BEHAVIOR=false
diff --git a/apps/core/components/link/index.tsx b/apps/core/components/link/index.tsx
@@ -9,8 +9,10 @@ type LinkType = Omit<React.AnchorHTMLAttributes<HTMLAnchorElement>, keyof LinkPr
     children?: React.ReactNode;
   } & React.RefAttributes<HTMLAnchorElement>;
 
+const prefetchDefault = process.env.DEFAULT_PREFETCH_BEHAVIOR === 'true';
+
 export const Link = forwardRef<ElementRef<'a'>, LinkType>(
-  ({ href, prefetch = false, children, className, ...rest }, ref) => {
+  ({ href, prefetch = prefetchDefault, children, className, ...rest }, ref) => {
     return (
       <NextLink
         className={cn(