generatoc/dist/index.d.ts

Automatically generate table of content from heading of HTML document

interface Params {
    content: string;
    heading?: string[];
    selector?: string;
    scrollHistory?: ScrollHistoryConfig | boolean | null;
    scrollOffset?: number;
    duration?: number;
    fold?: boolean;
}
interface Generatoc {
    init: ({ content, heading, selector }: Params) => void;
    destroy: () => void;
    refresh: () => void;
}
interface ScrollHistoryConfig {
    replacePattern?: RegExp | string;
    replacement?: string;
    readableSpace?: boolean;
    scrollToAfterMounted?: boolean;
}
declare const generatoc: Generatoc;
export default generatoc;