forked from tscanlin/tocbot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
152 lines (114 loc) · 5.24 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
export = tocbot;
export as namespace tocbot;
declare namespace tocbot {
/**
* @see https://github.com/tscanlin/tocbot#options
*/
interface IStaticOptions {
// Where to render the table of contents.
tocSelector?: string;
// Where to grab the headings to build the table of contents.
contentSelector?: string;
// Which headings to grab inside of the contentSelector element.
headingSelector?: string;
// Headings that match the ignoreSelector will be skipped.
ignoreSelector?: string;
// For headings inside relative or absolute positioned containers within content.
hasInnerContainers?: boolean;
// Main class to add to links.
linkClass?: string;
// Extra classes to add to links.
extraLinkClasses?: string;
// Class to add to active links;
// the link corresponding to the top most heading on the page.
activeLinkClass?: string;
// Main class to add to lists.
listClass?: string;
// Extra classes to add to lists.
extraListClasses?: string;
// Class that gets added when a list should be collapsed.
isCollapsedClass?: string;
// Class that gets added when a list should be able
// to be collapsed but isn't necessarily collapsed.
collapsibleClass?: string;
// Class to add to list items.
listItemClass?: string;
// How many heading levels should not be collapsed.
// For example; number 6 will show everything since
// there are only 6 heading levels and number 0 will collapse them all.
// The sections that are hidden will open
// and close as you scroll to headings within them.
collapseDepth?: number;
// Smooth scrolling enabled.
scrollSmooth?: boolean;
// Smooth scroll duration.
scrollSmoothDuration?: number;
// Smooth scroll offset.
scrollSmoothOffset?: number;
// Callback for scroll end.
scrollEndCallback?(e: WheelEvent): void;
// Headings offset between the headings and the top of the document (this is meant for minor adjustments).
headingsOffset?: number;
// Timeout between events firing to make sure it's
// not too rapid (for performance reasons).
throttleTimeout?: number;
// Element to add the positionFixedClass to.
positionFixedSelector?: string | null;
// Fixed position class to add to make sidebar fixed after scrolling
// down past the fixedSidebarOffset.
positionFixedClass?: string;
// fixedSidebarOffset can be any number but by default is set
// to auto which sets the fixedSidebarOffset to the sidebar
// element's offsetTop from the top of the document on init.
fixedSidebarOffset?: 'auto' | number;
// includeHtml can be set to true to include the HTML markup from the
// heading node instead of just including the textContent.
includeHtml?: boolean;
// includeTitleTags automatically sets the html title tag of the link
// to match the title. This can be useful for SEO purposes or
// when truncating titles.
includeTitleTags?: boolean;
// onclick function to apply to all links in toc. will be called with
// the event as the first parameter; and this can be used to stop;
// propagation; prevent default or perform action
onClick?: (e: MouseEvent) => void;
// orderedList can be set to false to generate unordered lists (ul)
// instead of ordered lists (ol)
orderedList?: boolean;
// If there is a fixed article scroll container; set to calculate titles' offset
scrollContainer?: string | null;
// prevent ToC DOM rendering if it's already rendered by an external system
skipRendering?: boolean;
// Optional callback to change heading labels.
// For example it can be used to cut down and put ellipses on multiline headings you deem too long.
// Called each time a heading is parsed. Expects a string in return, the modified label to display.
headingLabelCallback?: (headingLabel: string) => string;
// ignore headings that are hidden in DOM
ignoreHiddenElements?: boolean;
// Optional callback to modify properties of parsed headings.
// The heading element is passed in node parameter and information parsed by default parser is provided in obj parameter.
// Function has to return the same or modified obj.
// The heading will be excluded from TOC if nothing is returned.
headingObjectCallback?: (obj: object, node: HTMLElement) => object | void;
// Set the base path, useful if you use a `base` tag in `head`.
basePath?: string,
// Only takes affect when `tocSelector` is scrolling,
// keep the toc scroll position in sync with the content.
disableTocScrollSync?: boolean
}
/**
* Initialize tocbot with an options object.
* @see https://github.com/tscanlin/tocbot#init
*/
function init(options?: IStaticOptions): void;
/**
* Destroy tocbot and remove event listeners.
* @see https://github.com/tscanlin/tocbot#destroy
*/
function destroy(): void;
/**
* Refresh tocbot if the document changes and it needs to be rebuilt.
* @see https://github.com/tscanlin/tocbot#refresh
*/
function refresh(options?: IStaticOptions): void;
}