test/node_modules/@vuepress/theme-default/lib/shared/sidebar.d.ts
2024-08-13 09:27:52 +08:00

27 lines
834 B
TypeScript

import type { AutoLinkOptions, NavItemOptions } from './nav.js';
export type SidebarLinkOptions = AutoLinkOptions;
export interface SidebarGroupOptions extends NavItemOptions {
/**
* Link prefix of current group
*/
prefix?: string;
/**
* Link of current group
*/
link?: string;
/**
* Whether current group is collapsible
*
* @default false
*/
collapsible?: boolean;
/**
* Children of current group
*/
children: SidebarItemOptions[];
}
export type SidebarItemOptions = SidebarLinkOptions | SidebarGroupOptions | string;
export type SidebarArrayOptions = SidebarItemOptions[];
export type SidebarObjectOptions = Record<string, SidebarArrayOptions | 'heading' | false>;
export type SidebarOptions = SidebarArrayOptions | SidebarObjectOptions | 'heading';