Merge pull request #393 from shuding/shu/4747

Options for hiding/adding a link
shuding · Mar 6, 2022 · c21010b · c21010b
2 parents 7a7ba2a + 2923570
commit c21010b
Show file tree

Hide file tree

Showing 6 changed files with 190 additions and 140 deletions.
diff --git a/examples/swr-site/pages/docs/meta.en-US.json b/examples/swr-site/pages/docs/meta.en-US.json
@@ -3,7 +3,16 @@
   "options": "Options",
   "global-configuration": "Global Configuration",
   "data-fetching": "Data Fetching",
-  "error-handling": "Error Handling",
+  "error-handling": {
+    "title": "Error Handling",
+    "hidden": true
+  },
+  "github_link": {
+    "title": "GitHub 🐙 →",
+    "href": "https://github.com/shuding/nextra",
+    "type": "page",
+    "newWindow": true
+  },
   "revalidation": "Auto Revalidation",
   "conditional-fetching": "Conditional Data Fetching",
   "arguments": "Arguments",

diff --git a/examples/swr-site/pages/meta.en-US.json b/examples/swr-site/pages/meta.en-US.json
@@ -13,6 +13,12 @@
       "sidebar": true
     }
   },
+  "nextra_link": {
+    "title": "Nextra ↗",
+    "href": "https://github.com/shuding/nextra",
+    "type": "page",
+    "newWindow": true
+  },
   "examples": {
     "title": "Examples",
     "type": "page",

diff --git a/packages/nextra-theme-docs/src/index.tsx b/packages/nextra-theme-docs/src/index.tsx
@@ -95,7 +95,7 @@ const Layout: React.FC<LayoutProps> = ({
     activeIndex,
     activeThemeContext,
     // pageDirectories,
-    flatPageDirectories,
+    topLevelPageItems,
     docsDirectories,
     flatDirectories,
     flatDocsDirectories,
@@ -133,7 +133,7 @@ const Layout: React.FC<LayoutProps> = ({
             <Navbar
               isRTL={isRTL}
               flatDirectories={flatDirectories}
-              flatPageDirectories={flatPageDirectories}
+              items={topLevelPageItems}
             />
           ) : null}
           <ActiveAnchor>

diff --git a/packages/nextra-theme-docs/src/navbar.tsx b/packages/nextra-theme-docs/src/navbar.tsx
@@ -17,13 +17,10 @@ import { Item, PageItem } from './utils/normalize-pages'
 interface NavBarProps {
   isRTL?: boolean | null
   flatDirectories: Item[]
-  flatPageDirectories: PageItem[]
+  items: PageItem[]
 }
 
-export default function Navbar({
-  flatDirectories,
-  flatPageDirectories
-}: NavBarProps) {
+export default function Navbar({ flatDirectories, items }: NavBarProps) {
   const config = useConfig()
   const { locale, asPath } = useRouter()
   const activeRoute = getFSRoute(asPath, locale)
@@ -41,11 +38,11 @@ export default function Navbar({
           </Link>
         </div>
 
-        {flatPageDirectories
-          ? flatPageDirectories.map(page => {
+        {items
+          ? items.map(page => {
               if (page.hidden) return null
 
-              let href = page.route
+              let href = page.href || page.route || '#'
 
               // If it's a directory
               if (page.children) {
@@ -64,6 +61,9 @@ export default function Navbar({
                       isActive ? 'text-current' : 'text-gray-500'
                     )}
                     aria-selected={isActive}
+                    {...(page.newWindow
+                      ? { target: '_blank', rel: 'noopener noreferrer' }
+                      : {})}
                   >
                     {page.title}
                   </a>

diff --git a/packages/nextra-theme-docs/src/sidebar.tsx b/packages/nextra-theme-docs/src/sidebar.tsx
@@ -100,8 +100,14 @@ function File({ item, anchors }: FileProps) {
       })
       return (
         <li className={active ? 'active' : ''}>
-          <Link href={item.route}>
-            <a>{title}</a>
+          <Link href={(item as PageItem).href || item.route}>
+            <a
+              {...((item as PageItem).newWindow
+                ? { target: '_blank', rel: 'noopener noreferrer' }
+                : {})}
+            >
+              {title}
+            </a>
           </Link>
           <ul>
             {anchors.map((_, i) => {
@@ -132,8 +138,15 @@ function File({ item, anchors }: FileProps) {
 
   return (
     <li className={active ? 'active' : ''}>
-      <Link href={item.route}>
-        <a onClick={() => setMenu(false)}>{title}</a>
+      <Link href={(item as PageItem).href || item.route}>
+        <a
+          onClick={() => setMenu(false)}
+          {...((item as PageItem).newWindow
+            ? { target: '_blank', rel: 'noopener noreferrer' }
+            : {})}
+        >
+          {title}
+        </a>
       </Link>
     </li>
   )
@@ -143,7 +156,6 @@ interface MenuProps {
   anchors: string[]
   base?: string
 }
-const emptyItem: any[] = []
 function Menu({ directories, anchors }: MenuProps) {
   return (
     <ul>