feat(theme): fix typos in collapsible

fix a typo in configuration BREAKING CHANGE: fix typos in config, changing collapsable to collapsible
vuepress-theme-hope · Nov 7, 2022 · 7d3144c · 7d3144c
1 parent 18137eb
commit 7d3144c
Show file tree

Hide file tree

Showing 25 changed files with 88 additions and 89 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -6,7 +6,6 @@
     "blockquotes",
     "changefreq",
     "chtml",
-    "collapsable",
     "composables",
     "darkmode",
     "descendingly",

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2010,7 +2010,7 @@ Since `vuepress` drop support for the `babel` way, `search` and `docsearch` opti
 - **theme:** add icons ([12bcab9](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/12bcab961c52d82a009747d70bcd9bfc7b2c66da))
 - **theme:** append class on html element ([a56659d](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/a56659d148889c9307dfb191c2409aa7a85532bc))
 - **theme:** handle deprecated key in extendsPage ([90585e1](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/90585e1ed2b93e17b12a3d2f7fcff4428c0ee397))
-- **theme:** improve collapsable sidebar group with link ([fdd304a](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/fdd304a5cbc6cb5453901352d610e50c259202c1))
+- **theme:** improve collapsible sidebar group with link ([fdd304a](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/fdd304a5cbc6cb5453901352d610e50c259202c1))
 - **theme:** improve scrollbar ([2a4a481](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/2a4a48193f4e1f2f2740617c222da5b6ac1899bb))
 - **theme:** optimize encrypt on webpack ([3ca45c3](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/3ca45c3187490e6b6538217674de5e589d33f9ef))
 - **theme:** rebuild existing blog feature ([291b46c](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/291b46ce494f53a2181bc0a3652d7df692bd66e9))
@@ -2078,7 +2078,7 @@ Since `vuepress` drop support for the `babel` way, `search` and `docsearch` opti
 - **shared:** not requiring client on shared ([e5116de](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/e5116def84328cf5e7006b866adcfc5ea50f8d6c))
 - **theme:** fix 404 layout ([d8c0ba9](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/d8c0ba9030232eadf491378a8741b4d24e379d70))
 - **theme:** fix code block on mobile ([390cc39](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/390cc3965385dbef8603df7494bc3e1508c2775a))
-- **theme:** fix collapsable sidebar ([415ba7d](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/415ba7d1e724efecc4ba6a6b5ced2fb9e494fddb))
+- **theme:** fix collapsible sidebar ([415ba7d](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/415ba7d1e724efecc4ba6a6b5ced2fb9e494fddb))
 - **theme:** fix darkLogo layout ([797f2fa](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/797f2fa248224cbfc711006c8ff6a0c893edcbe6))
 - **theme:** fix DropdownLink ([a19da97](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/a19da977206a1822094c41ad695967b2dcc80a68))
 - **theme:** fix home layout ([423f3db](https://github.com/vuepress-theme-hope/vuepress-theme-hope/commit/423f3db95fbbe15eecbd6f3377248d7e566ead6e))

diff --git a/docs/feed2/src/.vuepress/theme.ts b/docs/feed2/src/.vuepress/theme.ts
@@ -34,7 +34,7 @@ export default theme("feed2", {
             text: "Config",
             icon: "config",
             prefix: "config/",
-            collapsable: false,
+            collapsible: false,
             children: ["", "channel", "getter", "item"],
           },
           "migration",
@@ -70,7 +70,7 @@ export default theme("feed2", {
             text: "配置",
             icon: "config",
             prefix: "config/",
-            collapsable: false,
+            collapsible: false,
             children: ["", "channel", "getter", "item"],
           },
           "migration",

diff --git a/docs/md-enhance/src/.vuepress/sidebar.ts b/docs/md-enhance/src/.vuepress/sidebar.ts
@@ -31,14 +31,14 @@ export const enSidebarConfig = sidebar({
           text: "Code Demo",
           icon: "discover",
           prefix: "demo/",
-          collapsable: true,
+          collapsible: true,
           children: ["", "normal", "vue", "react"],
         },
         {
           text: "Presentation",
           icon: "slides",
           prefix: "presentation/",
-          collapsable: true,
+          collapsible: true,
           children: ["", "demo", "themes"],
         },
         "stylize",
@@ -74,14 +74,14 @@ export const enSidebarConfig = sidebar({
       text: "Code Demo",
       icon: "discover",
       prefix: "demo/",
-      collapsable: true,
+      collapsible: true,
       children: ["", "normal", "vue", "react"],
     },
     {
       text: "Presentation",
       icon: "slides",
       prefix: "presentation/",
-      collapsable: true,
+      collapsible: true,
       children: ["", "demo", "themes"],
     },
     "stylize",
@@ -120,14 +120,14 @@ export const zhSidebarConfig = sidebar({
           text: "代码演示",
           icon: "discover",
           prefix: "demo/",
-          collapsable: true,
+          collapsible: true,
           children: ["", "normal", "vue", "react"],
         },
         {
           text: "幻灯片",
           icon: "slides",
           prefix: "presentation/",
-          collapsable: true,
+          collapsible: true,
           children: ["", "demo", "themes"],
         },
         "stylize",
@@ -163,14 +163,14 @@ export const zhSidebarConfig = sidebar({
       text: "代码演示",
       icon: "discover",
       prefix: "demo/",
-      collapsable: true,
+      collapsible: true,
       children: ["", "normal", "vue", "react"],
     },
     {
       text: "幻灯片",
       icon: "slides",
       prefix: "presentation/",
-      collapsable: true,
+      collapsible: true,
       children: ["", "demo", "themes"],
     },
     "stylize",

diff --git a/docs/theme/src/.vuepress/sidebar/en.ts b/docs/theme/src/.vuepress/sidebar/en.ts
@@ -76,7 +76,7 @@ export const enSidebarConfig = sidebar({
       text: "Markdown",
       icon: "markdown",
       prefix: "markdown/",
-      collapsable: true,
+      collapsible: true,
       children: [
         "",
         "demo",
@@ -85,7 +85,7 @@ export const enSidebarConfig = sidebar({
           icon: "emoji",
           link: "emoji/",
           prefix: "emoji/",
-          collapsable: true,
+          collapsible: true,
           children: "structure",
         },
       ],
@@ -94,14 +94,14 @@ export const enSidebarConfig = sidebar({
       text: "VuePress",
       icon: "vue",
       prefix: "vuepress/",
-      collapsable: true,
+      collapsible: true,
       children: ["", "page", "markdown", "file", "config", "plugin", "theme"],
     },
     {
       text: "Advanced",
       icon: "advance",
       prefix: "advanced/",
-      collapsable: true,
+      collapsible: true,
       children: ["component", "style", "replace", "extend"],
     },
   ],

diff --git a/docs/theme/src/.vuepress/sidebar/ru.ts b/docs/theme/src/.vuepress/sidebar/ru.ts
@@ -76,7 +76,7 @@ export const ruSidebarConfig = sidebar({
       text: "Markdown",
       icon: "markdown",
       prefix: "markdown/",
-      collapsable: true,
+      collapsible: true,
       children: [
         "",
         "demo",
@@ -85,7 +85,7 @@ export const ruSidebarConfig = sidebar({
           icon: "emoji",
           link: "emoji/",
           prefix: "emoji/",
-          collapsable: true,
+          collapsible: true,
           children: "structure",
         },
       ],
@@ -94,14 +94,14 @@ export const ruSidebarConfig = sidebar({
       text: "VuePress",
       icon: "vue",
       prefix: "vuepress/",
-      collapsable: true,
+      collapsible: true,
       children: ["", "page", "markdown", "file", "config", "plugin", "theme"],
     },
     {
       text: "Продвинутый",
       icon: "advance",
       prefix: "advanced/",
-      collapsable: true,
+      collapsible: true,
       children: ["component", "style", "replace", "extend"],
     },
   ],

diff --git a/docs/theme/src/.vuepress/sidebar/zh.ts b/docs/theme/src/.vuepress/sidebar/zh.ts
@@ -76,7 +76,7 @@ export const zhSidebarConfig = sidebar({
       text: "Markdown",
       icon: "markdown",
       prefix: "markdown/",
-      collapsable: true,
+      collapsible: true,
       children: [
         "",
         "demo",
@@ -85,7 +85,7 @@ export const zhSidebarConfig = sidebar({
           icon: "emoji",
           link: "emoji/",
           prefix: "emoji/",
-          collapsable: true,
+          collapsible: true,
           children: "structure",
         },
       ],
@@ -94,14 +94,14 @@ export const zhSidebarConfig = sidebar({
       text: "VuePress",
       icon: "vue",
       prefix: "vuepress/",
-      collapsable: true,
+      collapsible: true,
       children: ["", "file", "markdown", "config", "plugin", "theme"],
     },
     {
       text: "高级",
       icon: "advance",
       prefix: "advanced/",
-      collapsable: true,
+      collapsible: true,
       children: ["component", "style", "replace", "extend"],
     },
   ],

diff --git a/docs/theme/src/config/frontmatter/layout.md b/docs/theme/src/config/frontmatter/layout.md
@@ -108,12 +108,12 @@ Group title.
 
 Group icon.
 
-### dir.collapsable
+### dir.collapsible
 
 - Type: `boolean`
 - Default: `true`
 
-Whether group is collapsable
+Whether group is collapsible
 
 ### dir.link
 

diff --git a/docs/theme/src/config/theme/basic.md b/docs/theme/src/config/theme/basic.md
@@ -106,7 +106,7 @@ Navbar config
   interface HopeThemeSidebarGroupItem extends TextItem {
     prefix?: string;
     link?: string;
-    collapsable?: boolean;
+    collapsible?: boolean;
     children: (
       | HopeThemeSidebarPageItem
       | HopeThemeSidebarGroupItem
@@ -118,7 +118,7 @@ Navbar config
   interface HopeThemeSidebarStructureItem extends TextItem {
     prefix: string;
     link?: string;
-    collapsable?: boolean;
+    collapsible?: boolean;
     children: "structure";
   }
 

diff --git a/docs/theme/src/config/theme/layout.md b/docs/theme/src/config/theme/layout.md
@@ -156,7 +156,7 @@ Whether show icons in the sidebar
       prefix: string;
       text: string;
       icon?: string;
-      collapsable?: boolean;
+      collapsible?: boolean;
       link?: string;
     };
     children: HopeThemeSidebarInfo[];

diff --git a/docs/theme/src/guide/layout/sidebar.md b/docs/theme/src/guide/layout/sidebar.md
@@ -150,7 +150,7 @@ But you may have multiple folders with files under `/path/`. To avoid multiple d
 
 If you need a sidebar that displays a nested structure, you can group similar links.
 
-You should use [object format](#object-format) and provide an additional `children` option to set the list of links. Like navbar, you can use `prefix` in the sidebar to add a default path prefix to each link in the group, and the sidebar additionally supports setting `collapsable: true` to make the menu group collapsible.
+You should use [object format](#object-format) and provide an additional `children` option to set the list of links. Like navbar, you can use `prefix` in the sidebar to add a default path prefix to each link in the group, and the sidebar additionally supports setting `collapsible: true` to make the menu group collapsible.
 
 ::: code-tabs#language
 
@@ -174,7 +174,7 @@ export default defineUserConfig({
         // optional, will be appended to each item link
         prefix: "/foo/",
         // optional, defaults to false
-        collapsable: false,
+        collapsible: false,
         // required, items of group
         children: [
           "README.md" /* /foo/index.html */,
@@ -214,7 +214,7 @@ export default {
         // optional, will be appended to each item link
         prefix: "/foo/",
         // optional, defaults to false
-        collapsable: false,
+        collapsible: false,
         // required, items of group
         children: [
           "README.md" /* /foo/index.html */,
@@ -689,7 +689,7 @@ interface SidebarDirInfo {
    * @default true
    */
 
-  collapsable?: boolean;
+  collapsible?: boolean;
 
   /**
    * Whether the directory is clickable
@@ -1012,7 +1012,7 @@ export default sidebar({
       text: "Markdown",
       icon: "markdown",
       prefix: "markdown/",
-      collapsable: true,
+      collapsible: true,
       children: [
         "",
         "demo",
@@ -1021,7 +1021,7 @@ export default sidebar({
           icon: "emoji",
           link: "emoji/",
           prefix: "emoji/",
-          collapsable: true,
+          collapsible: true,
           children: "structure",
         },
       ],
@@ -1030,14 +1030,14 @@ export default sidebar({
       text: "VuePress",
       icon: "vue",
       prefix: "vuepress/",
-      collapsable: true,
+      collapsible: true,
       children: ["", "page", "markdown", "file", "config", "plugin", "theme"],
     },
     {
       text: "Advanced",
       icon: "advance",
       prefix: "advanced/",
-      collapsable: true,
+      collapsible: true,
       children: ["component", "style", "replace", "extend"],
     },
   ],

diff --git a/docs/theme/src/ru/config/theme/basic.md b/docs/theme/src/ru/config/theme/basic.md
@@ -106,7 +106,7 @@ tag:
   interface HopeThemeSidebarGroupItem extends TextItem {
     prefix?: string;
     link?: string;
-    collapsable?: boolean;
+    collapsible?: boolean;
     children: (
       | HopeThemeSidebarPageItem
       | HopeThemeSidebarGroupItem
@@ -118,7 +118,7 @@ tag:
   interface HopeThemeSidebarStructureItem extends TextItem {
     prefix: string;
     link?: string;
-    collapsable?: boolean;
+    collapsible?: boolean;
     children: "structure";
   }
 

diff --git a/docs/theme/src/ru/config/theme/layout.md b/docs/theme/src/ru/config/theme/layout.md
@@ -150,7 +150,7 @@ tag:
       prefix: string;
       text: string;
       icon?: string;
-      collapsable?: boolean;
+      collapsible?: boolean;
       link?: string;
     };
     children: HopeThemeSidebarInfo[];