doc_navigator_table_of_contents_with_smooth_scroll_quickstart.ts

1import { DocNavigator, DocNavigatorOptions } from 'doc-navigator';
2
3// Define configuration options
4const options: DocNavigatorOptions = {
5    container: '#content-body',      // The element containing your article/doc
6    tocContainer: '#sidebar-toc',    // Where the navigation will be injected
7    headingSelector: 'h2, h3, h4',   // Levels to include in the navigation
8    scrollOffset: 80,                // Offset for fixed headers
9    activeClass: 'is-active'         // Class applied to the current visible section link
10};
11
12// Initialize the navigator
13const navigator = new DocNavigator(options);
14
15// Start tracking the document scroll and build the UI
16navigator.init();
17
18// Optional: Destroy the navigator when the component unmounts (for SPA usage)
19// navigator.destroy();