neotoc
Version:
Neotoc is a smoothly animated, foldable table of contents generator.
29 lines (27 loc) • 976 B
text/typescript
type Breadcrumb = {
content: string | Node;
hash: string;
}[];
interface Options {
io: string;
to?: HTMLElement;
title?: string;
fillAnchor?: (heading: HTMLHeadingElement) => string | Node;
onBreadcrumbChange?: (data: Breadcrumb) => void;
ellipsis?: boolean;
classPrefix?: string;
initialFoldLevel?: number;
offsetTop?: number;
offsetBottom?: number;
autoFold?: boolean;
autoScroll?: boolean;
autoScrollOffset?: number;
toggleFoldIcon?: string;
unfoldableIcon?: string;
foldIcon?: string;
foldAllIcon?: string;
unfoldIcon?: string;
unfoldAllIcon?: string;
}
declare function neotoc({ io, to, title, fillAnchor, onBreadcrumbChange, ellipsis, classPrefix, initialFoldLevel, offsetTop, offsetBottom, autoFold, autoScroll, autoScrollOffset, toggleFoldIcon, unfoldableIcon, foldIcon, foldAllIcon, unfoldIcon, unfoldAllIcon, }: Options): () => void;
export { type Breadcrumb, neotoc as default };