feat(theme): rename navTitle to navbarTitle

vuepress-theme-hope · Apr 17, 2024 · 416395e · 416395e
1 parent 9426e66
commit 416395e
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/docs/theme/src/.vuepress/theme.ts b/docs/theme/src/.vuepress/theme.ts
@@ -21,7 +21,7 @@ export default theme(
 
     fullscreen: true,
 
-    navTitle: false,
+    navbarTitle: "",
 
     extraLocales: {
       Русский: "https://theme-hope-ru.vuejs.press/:route",

diff --git a/docs/theme/src/config/theme/layout.md b/docs/theme/src/config/theme/layout.md
@@ -75,12 +75,12 @@ Navbar logo, should be absolute path relative to `.vuepress/public` folder.
 
 Navbar logo in darkmode, should be absolute path relative to `.vuepress/public` folder.
 
-### navTitle
+### navbarTitle
 
-- Type: `string | false`
+- Type: `string`
 - Default: `$siteLocale.title`
 
-Navbar title
+Navbar title, you can set it to an empty string to hide it.
 
 ### repo
 

diff --git a/docs/theme/src/zh/config/theme/layout.md b/docs/theme/src/zh/config/theme/layout.md
@@ -75,12 +75,12 @@ tag:
 
 夜间模式下导航栏图标，应为基于 `.vuepress/public` 文件夹的绝对路径。
 
-### navTitle
+### navbarTitle
 
-- 类型: `string | false`
+- 类型: `string`
 - 默认值: `$siteLocale.title`
 
-导航栏标题
+导航栏标题，你可以设置为 `''` 来隐藏它。
 
 ### repo
 

diff --git a/packages/theme/src/client/modules/navbar/components/NavbarBrand.ts b/packages/theme/src/client/modules/navbar/components/NavbarBrand.ts
@@ -25,7 +25,7 @@ export default defineComponent({
 
     const siteTitle = computed(() => siteLocale.value.title);
     const siteBrandTitle = computed(
-      () => themeLocale.value.navTitle ?? siteTitle.value,
+      () => themeLocale.value.navbarTitle ?? siteTitle.value,
     );
 
     const siteBrandLogo = computed(() =>

diff --git a/packages/theme/src/shared/options/layout/navbar.ts b/packages/theme/src/shared/options/layout/navbar.ts
@@ -85,7 +85,7 @@ export interface NavbarLocaleOptions {
    *
    * @default $siteLocale.title
    */
-  navTitle?: string | false;
+  navbarTitle?: string;
 
   /**
    * Repository link