UNPKG

vuepress-theme-aurora

Version:

A vuepress-based animation blog theme, simple, beautiful, multi-color, multiple custom functions, providing article poster sharing, talk, photo album, comment and other features 一个基于vuepress的动漫类博客主题,简洁,漂亮,多色彩,多种自定义功能,提供文章海报分享,说说,相册,评论等特色功�?

33 lines (32 loc) 1.62 kB
import type { ComputedRef, InjectionKey } from 'vue'; import type { PageHeader } from '@vuepress/client'; import type { DefaultThemeData, DefaultThemeNormalPageFrontmatter, SidebarConfigArray, SidebarConfigObject, ResolvedSidebarItem } from '../../shared'; export declare type SidebarItemsRef = ComputedRef<ResolvedSidebarItem[]>; export declare const sidebarItemsSymbol: InjectionKey<SidebarItemsRef>; /** * Inject sidebar items global computed */ export declare const useSidebarItems: () => SidebarItemsRef; /** * Resolve sidebar items global computed * * It should only be resolved and provided once */ export declare const resolveSidebarItems: (frontmatter: DefaultThemeNormalPageFrontmatter, themeLocale: DefaultThemeData) => ResolvedSidebarItem[]; /** * Util to transform page header to sidebar item */ export declare const headerToSidebarItem: (header: PageHeader, sidebarDepth: number) => ResolvedSidebarItem; export declare const headersToSidebarItemChildren: (headers: PageHeader[], sidebarDepth: number) => ResolvedSidebarItem[]; /** * Resolve sidebar items if the config is `auto` */ export declare const resolveAutoSidebarItems: (sidebarDepth: number) => ResolvedSidebarItem[]; /** * Resolve sidebar items if the config is an array */ export declare const resolveArraySidebarItems: (sidebarConfig: SidebarConfigArray, sidebarDepth: number) => ResolvedSidebarItem[]; /** * Resolve sidebar items if the config is a key -> value (path-prefix -> array) object */ export declare const resolveMultiSidebarItems: (sidebarConfig: SidebarConfigObject, sidebarDepth: number) => ResolvedSidebarItem[];