chore: tweaks

vuepress · Jan 16, 2025 · 7d935d0 · 7d935d0
1 parent 6143a5c
commit 7d935d0
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 21 deletions.
diff --git a/docs/tools/helper/client.md b/docs/tools/helper/client.md
@@ -71,7 +71,7 @@ locale.value // '标题'
 Get headers from current page.
 
 ```ts
-export const getHeaders: (options: GetHeadersOptions) => MenuItem[]
+export const getHeaders: (options: GetHeadersOptions) => HeaderItem[]
 ```
 
 **Params:**
@@ -112,7 +112,7 @@ export interface GetHeadersOptions {
 **Result:**
 
 ```ts
-export interface Header {
+interface PageHeader {
   /**
    * The level of the header
    *
@@ -138,14 +138,14 @@ export interface Header {
   /**
    * The children of the header
    */
-  children: Header[]
+  children: MarkdownItHeader[]
 }
 
 export type HeaderLevels = number | 'deep' | false | [number, number]
 
-export type MenuItem = Omit<Header, 'children' | 'slug'> & {
-  element: HTMLHeadElement
-  children?: MenuItem[]
+export type HeaderItem = Omit<PageHeader, 'children'> & {
+  element: HTMLHeadingElement
+  children?: HeaderItem[]
 }
 ```
 

diff --git a/docs/zh/tools/helper/client.md b/docs/zh/tools/helper/client.md
@@ -71,7 +71,7 @@ locale.value // '标题'
 获取当前页面指定的 标题列表。
 
 ```ts
-export const getHeaders: (options: GetHeadersOptions) => MenuItem[]
+export const getHeaders: (options: GetHeadersOptions) => HeaderItem[]
 ```
 
 **参数:**
@@ -112,7 +112,7 @@ export interface GetHeadersOptions {
 **返回结果:**
 
 ```ts
-export interface Header {
+interface PageHeader {
   /**
    * 当前标题的层级
    *
@@ -143,9 +143,9 @@ export interface Header {
 
 export type HeaderLevels = number | 'deep' | false | [number, number]
 
-export type MenuItem = Omit<Header, 'children' | 'slug'> & {
-  element: HTMLHeadElement
-  children?: MenuItem[]
+export type HeaderItem = Omit<PageHeader, 'children'> & {
+  element: HTMLHeadingElement
+  children?: HeaderItem[]
 }
 ```
 

diff --git a/themes/theme-default/src/client/composables/useHeaders.ts b/themes/theme-default/src/client/composables/useHeaders.ts
@@ -1,13 +1,13 @@
 import { useThemeLocaleData } from '@theme/useThemeData'
-import type { MenuItem } from '@vuepress/helper/client'
+import type { HeaderItem } from '@vuepress/helper/client'
 import { getHeaders } from '@vuepress/helper/client'
 import { injectLocal, provideLocal, watchImmediate } from '@vueuse/core'
 import type { InjectionKey, Ref } from 'vue'
 import { computed, onMounted, ref } from 'vue'
 import { usePageFrontmatter, useRoutePath } from 'vuepress/client'
 import type { DefaultThemeNormalPageFrontmatter } from '../../shared/index.js'
 
-export type HeadersRef = Ref<MenuItem[]>
+export type HeadersRef = Ref<HeaderItem[]>
 
 export const headersSymbol: InjectionKey<HeadersRef> = Symbol('headers')
 

diff --git a/themes/theme-default/src/client/composables/useSidebarItems.ts b/themes/theme-default/src/client/composables/useSidebarItems.ts
@@ -2,7 +2,7 @@ import { resolveAutoLink } from '@theme/resolveAutoLink'
 import { resolvePrefix } from '@theme/resolvePrefix'
 import { useHeaders } from '@theme/useHeaders'
 import { useThemeLocaleData } from '@theme/useThemeData'
-import type { MenuItem } from '@vuepress/helper/client'
+import type { HeaderItem } from '@vuepress/helper/client'
 import { isLinkRelative, keys, startsWith } from '@vuepress/helper/client'
 import type { ComputedRef, InjectionKey } from 'vue'
 import { computed, inject, provide } from 'vue'
@@ -28,7 +28,7 @@ import type { SidebarHeaderItem, SidebarItem } from '../typings.js'
  * Util to transform page header to sidebar item
  */
 export const resolveSidebarHeaderItem = (
-  header: MenuItem,
+  header: HeaderItem,
 ): SidebarHeaderItem => ({
   text: header.title,
   link: header.link,
@@ -37,7 +37,7 @@ export const resolveSidebarHeaderItem = (
 })
 
 export const resolveSidebarHeaderItems = (
-  headers?: MenuItem[],
+  headers?: HeaderItem[],
 ): SidebarHeaderItem[] =>
   headers ? headers.map((header) => resolveSidebarHeaderItem(header)) : []
 
@@ -46,7 +46,7 @@ export const resolveSidebarHeaderItems = (
  */
 export const resolveSidebarHeadingItem = (
   page: PageData,
-  headers: MenuItem[],
+  headers: HeaderItem[],
 ): SidebarItem[] => [
   {
     text: page.title,
@@ -59,7 +59,7 @@ export const resolveSidebarHeadingItem = (
  */
 export const resolveArraySidebarItems = (
   sidebarConfig: SidebarArrayOptions,
-  headers: MenuItem[],
+  headers: HeaderItem[],
   path: string,
   prefix = '',
 ): SidebarItem[] => {
@@ -112,7 +112,7 @@ export const resolveArraySidebarItems = (
 export const resolveMultiSidebarItems = (
   sidebarConfig: SidebarObjectOptions,
   page: PageData,
-  headers: MenuItem[],
+  headers: HeaderItem[],
   path: string,
 ): SidebarItem[] => {
   const sidebarRoutes = keys(sidebarConfig).sort((x, y) => y.length - x.length)
@@ -161,7 +161,7 @@ export const resolveSidebarItems = (
   page: PageData,
   path: string,
   routeLocale: string,
-  headers: MenuItem[],
+  headers: HeaderItem[],
 ): SidebarItem[] => {
   // resolve sidebar items according to the config
   if (sidebarConfig === false) {

diff --git a/tools/helper/src/client/utils/getHeaders.ts b/tools/helper/src/client/utils/getHeaders.ts
@@ -3,7 +3,7 @@ import type { PageHeader } from 'vuepress/shared'
 export type HeaderLevels = number | 'deep' | false | [number, number]
 
 export type HeaderItem = Omit<PageHeader, 'children'> & {
-  element: HTMLHeadElement
+  element: HTMLHeadingElement
   children?: HeaderItem[]
 }