chore: rename useNextLink to unstable_useNextLink

SukkaW · Jan 21, 2024 · a330193 · a330193
1 parent 2f7f325
commit a330193
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docs/src/pages/use-next-link.mdx b/docs/src/pages/use-next-link.mdx
@@ -20,7 +20,7 @@ The `useNextLink` hook is your last resort. You should always prefer `next/link`
 'use client';
 
 import { useRef } from 'react';
-import { useNextLink } from 'foxact/use-next-link';
+import { unstable_useNextLink as useNextLink } from 'foxact/use-next-link';
 
 export default function Page() {
   const ref = useRef<HTMLAnchorElement>(null);

diff --git a/src/use-next-link/index.ts b/src/use-next-link/index.ts
@@ -71,7 +71,8 @@ const prefetch = (
   });
 };
 
-export const useNextLink = (
+/** @see https://foxact.skk.moe/use-next-link */
+const useNextLink = (
   hrefProp: string | UrlObject,
   {
     prefetch: prefetchProp,
@@ -226,3 +227,5 @@ export const useNextLink = (
     childProps
   ] as const;
 };
+
+export const unstable_useNextLink = useNextLink;