fix(types): export duplicate type Sidebar (vuejs#2573)

jeremyriverain · Jul 3, 2023 · a99dcf9 · a99dcf9
1 parent 03d93da
commit a99dcf9
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/docs/reference/default-theme-sidebar.md b/docs/reference/default-theme-sidebar.md
@@ -186,7 +186,7 @@ export default {
 Returns sidebar-related data. The returned object has the following type:
 
 ```ts
-export interface Sidebar {
+export interface DocSidebar {
   isOpen: Ref<boolean>
   sidebar: ComputedRef<DefaultTheme.SidebarItem[]>
   sidebarGroups: ComputedRef<DefaultTheme.SidebarItem[]>

diff --git a/theme.d.ts b/theme.d.ts
@@ -20,4 +20,4 @@ declare const theme: {
 export default theme
 export type { DefaultTheme } from './types/default-theme.js'
 
-export const useSidebar: () => DefaultTheme.SideBar
+export const useSidebar: () => DefaultTheme.DocSideBar
diff --git a/types/default-theme.d.ts b/types/default-theme.d.ts
@@ -1,3 +1,4 @@
+import { type ComputedRef, type Ref } from 'vue'
 import type { DocSearchProps } from './docsearch.js'
 import type { LocalSearchTranslations } from './local-search.js'
 import type { PageData } from './shared.js'
@@ -222,7 +223,7 @@ export namespace DefaultTheme {
   /**
    * ReturnType of `useSidebar`
    */
-  export interface Sidebar {
+  export interface DocSidebar {
     isOpen: Ref<boolean>
     sidebar: ComputedRef<SidebarItem[]>
     sidebarGroups: ComputedRef<SidebarItem[]>