add _meta.json#theme.collapsed option for control state sidebar's f…

…olders (#890) * add `_meta.json#theme.collapsed` option for control state sidebar's folders * update snapshots
shuding · Oct 19, 2022 · 9f5af54 · 9f5af54
1 parent a8a89e9
commit 9f5af54
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 3 deletions.
diff --git a/.changeset/shy-horses-help.md b/.changeset/shy-horses-help.md
@@ -0,0 +1,5 @@
+---
+'nextra-theme-docs': patch
+---
+
+add `_meta.json#theme.collapsed` option for control state sidebar's folders
diff --git a/examples/swr-site/pages/docs/_meta.en-US.json b/examples/swr-site/pages/docs/_meta.en-US.json
@@ -26,7 +26,10 @@
   "suspense": "Suspense",
   "middleware": "Middleware",
   "advanced": {
-    "title": "Advanced"
+    "title": "Advanced",
+    "theme": {
+      "collapsed": false
+    }
   },
   "change-log": {
     "title": "Change Log",

diff --git a/packages/nextra-theme-docs/__test__/__snapshots__/normalize-page.spec.ts.snap b/packages/nextra-theme-docs/__test__/__snapshots__/normalize-page.spec.ts.snap
@@ -6,6 +6,7 @@ exports[`normalize-page > /404 page 1`] = `
   "activePath": [],
   "activeThemeContext": {
     "breadcrumb": true,
+    "collapsed": false,
     "footer": true,
     "layout": "default",
     "navbar": true,
@@ -101,6 +102,7 @@ exports[`normalize-page > /500 page 1`] = `
   ],
   "activeThemeContext": {
     "breadcrumb": true,
+    "collapsed": false,
     "footer": true,
     "layout": "raw",
     "navbar": true,
@@ -364,6 +366,7 @@ exports[`normalize-page > en-US getting-started 1`] = `
   ],
   "activeThemeContext": {
     "breadcrumb": true,
+    "collapsed": false,
     "footer": true,
     "layout": "default",
     "navbar": true,
@@ -1112,6 +1115,7 @@ exports[`normalize-page > en-US home 1`] = `
   ],
   "activeThemeContext": {
     "breadcrumb": true,
+    "collapsed": false,
     "footer": true,
     "layout": "default",
     "navbar": true,
@@ -2026,6 +2030,7 @@ exports[`normalize-page > zh-CN getting-started 1`] = `
   ],
   "activeThemeContext": {
     "breadcrumb": true,
+    "collapsed": false,
     "footer": true,
     "layout": "default",
     "navbar": true,
@@ -2774,6 +2779,7 @@ exports[`normalize-page > zh-CN home 1`] = `
   ],
   "activeThemeContext": {
     "breadcrumb": true,
+    "collapsed": false,
     "footer": true,
     "layout": "default",
     "navbar": true,

diff --git a/packages/nextra-theme-docs/src/components/sidebar.tsx b/packages/nextra-theme-docs/src/components/sidebar.tsx
@@ -70,10 +70,15 @@ function FolderImpl({
 
   const { setMenu } = useMenu()
   const config = useConfig()
+  const { theme } = item as Item
   const open =
     TreeState[item.route] !== undefined
       ? TreeState[item.route]
-      : active || activeRouteInside || !config.sidebar.defaultMenuCollapsed
+      : active ||
+        activeRouteInside ||
+        (theme && 'collapsed' in theme
+          ? !theme.collapsed
+          : !config.sidebar.defaultMenuCollapsed)
 
   const rerender = useState({})[1]
 
@@ -357,7 +362,7 @@ export function Sidebar({
       >
         <div
           className={cn(
-            'z-[1]',  // for bottom box shadow
+            'z-[1]', // for bottom box shadow
             'md:hidden p-4',
             'shadow-[0_2px_14px_6px_#fff] dark:shadow-[0_2px_14px_6px_#111]',
             'contrast-more:shadow-none dark:contrast-more:shadow-none'

diff --git a/packages/nextra-theme-docs/src/constants.tsx b/packages/nextra-theme-docs/src/constants.tsx
@@ -198,6 +198,7 @@ export const LEGACY_CONFIG_OPTIONS: Record<string, string> = {
 
 export const DEFAULT_PAGE_THEME: PageTheme = {
   breadcrumb: true,
+  collapsed: false,
   footer: true,
   layout: 'default',
   navbar: true,

diff --git a/packages/nextra-theme-docs/src/types.ts b/packages/nextra-theme-docs/src/types.ts
@@ -110,6 +110,7 @@ export interface DocsThemeConfig {
 
 export type PageTheme = {
   breadcrumb: boolean
+  collapsed: boolean
   footer: boolean
   layout: 'default' | 'full' | 'raw'
   navbar: boolean

diff --git a/packages/nextra-theme-docs/src/utils/normalize-pages.ts b/packages/nextra-theme-docs/src/utils/normalize-pages.ts
@@ -20,6 +20,7 @@ export interface Item extends MdxFile {
   children?: Item[]
   hidden?: boolean
   withIndexPage?: boolean
+  theme?: PageTheme
 }
 
 export interface PageItem extends MdxFile {

diff --git a/packages/nextra/__test__/__snapshots__/context.test.ts.snap b/packages/nextra/__test__/__snapshots__/context.test.ts.snap
@@ -1124,6 +1124,9 @@ exports[`context > getAllPages() > should work 1`] = `
         ],
         "kind": "Folder",
         "meta": {
+          "theme": {
+            "collapsed": false,
+          },
           "title": "Advanced",
         },
         "name": "advanced",
@@ -1133,6 +1136,9 @@ exports[`context > getAllPages() > should work 1`] = `
         "kind": "MdxPage",
         "locale": "en-US",
         "meta": {
+          "theme": {
+            "collapsed": false,
+          },
           "title": "Advanced",
         },
         "name": "advanced",
@@ -2901,6 +2907,9 @@ exports[`context > getCurrentLevelPages() > should work 1`] = `
     ],
     "kind": "Folder",
     "meta": {
+      "theme": {
+        "collapsed": false,
+      },
       "title": "Advanced",
     },
     "name": "advanced",
@@ -2910,6 +2919,9 @@ exports[`context > getCurrentLevelPages() > should work 1`] = `
     "kind": "MdxPage",
     "locale": "en-US",
     "meta": {
+      "theme": {
+        "collapsed": false,
+      },
       "title": "Advanced",
     },
     "name": "advanced",

diff --git a/packages/nextra/__test__/__snapshots__/page-map.test.ts.snap b/packages/nextra/__test__/__snapshots__/page-map.test.ts.snap
@@ -188,6 +188,9 @@ exports[`Page Process > pageMap en-US 1`] = `
             },
             "404-500": "404/500 Custom Error Pages",
             "advanced": {
+              "theme": {
+                "collapsed": false,
+              },
               "title": "Advanced",
             },
             "arguments": "Arguments",