fuc-new/doc/node_modules/@vuepress/helper/lib/client/utils/getHeaders.d.ts
hellcat 6adbc04d4b 1
2025-10-03 17:17:08 +08:00

19 lines
754 B
TypeScript

import type { PageHeader } from 'vuepress/shared';
import type { GetHeadersOptions, HeaderLevels } from '../../shared/index.js';
export type HeaderItem = Omit<PageHeader, 'children'> & {
element: HTMLHeadingElement;
children: HeaderItem[];
};
export declare const resolveHeaders: (headers: HeaderItem[], levels?: HeaderLevels) => HeaderItem[];
export declare const getHeadersFromDom: (selector?: string, ignore?: string[]) => HeaderItem[];
/**
* Get headers of current page.
*
* 获取当前页面的标题
*
* @param options - Options for getting headers / 获取标题的选项
*
* @returns Array of header items / 标题项数组
*/
export declare const getHeaders: ({ selector, levels, ignore, }?: GetHeadersOptions) => HeaderItem[];