Svelte ToC

Changelog

All notable changes to this project will be documented in this file. Dates are displayed in UTC.

v0.6.0

13 April 2025

Svelte 5 Migration #61

v0.5.9

12 June 2024

Ignore spurious scrollend events on page load before any actual scrolling in Chrome #58

v0.5.8

21 March 2024

Add reactToKeys prop to Toc component and on_keydown handler to enable navigating ToC with keyboard #55
When opening ToC on mobile, ensure active ToC item is scrolled into view #54

v0.5.7

22 January 2024

Replace hacky window.setTimeout(50) callback with scrollend event to keepActiveTocItemInView #53
package.json add "types": "./dist/index.d.ts" and default --toc-overflow to auto #49
expose Toc aside and nav HTMLElements for external access fc8806d

v0.5.6

12 September 2023

Add prop blurParams: BlurParams | null = { duration: 200 } #47
Copy buttons #43

v0.5.5

20 April 2023

DRY GitHub Actions #40
fix svelte a11y warning about
tabindex and role aa1cd50

v0.5.4

16 March 2023

Fix new timeout callback for keepActiveTocItemInView=true breaking page scrolling #39

v0.5.3

12 March 2023

Fix ToC scroll abort #37
Add var(—toc-overflow, auto scroll) #34
add src/routes/(demos)/left-border-active-li/+page.md powered by mdsvexamples 6be66f0
tweak readme prop docs 84c1854
document new CSS variables in readme 5df7767
add test ‘subheadings are indented’ 06da853
add var(—toc-ol-list-style, none) and var(—toc-ol-padding, 0) ade5425

v0.5.2

12 January 2023

add auto changelog d7eaeea
add contributing.md a313e7b
add many new CSS variables in Toc.svelte badbe2f
add coverage badges to readme 8a24e2b
add vite alias $root to clean up package.json, readme|contributing|changelog.md imports 76427ee

v0.5.1

20 December 2022

use margin instead transform: translateX for indented ToC items 49d43d7
pnpm add -D @vitest/coverage-c8 bab57dc

v0.5.0

3 December 2022

Breaking: hide ToC if empty #30
Deploy docs to GitHub Pages #29

v0.4.1

6 November 2022

Only trigger keyup event handler on enter/space keys #28
yarn to pnpm #27
use code fences in readme to document prop, types and defaults b7f6f49
test CSS variables in readme are in sync with actual component ecf994b
test that readme documents no non-existent props d08eb59
add test ‘ToC lists expected headings’ b18b003
improve readme doc on CSS class toc-exclude in default heading selector 9e1476a

v0.4.0

13 September 2022

Better readme test #24
Fix ToC preventing page scrolling beyond active heading when zoomed into page #23

v0.3.2

11 September 2022

Add prop titleTag allowing to change HTML tag used for ToC title #21

v0.3.1

10 September 2022

fix: exclude header of table itself by class toc-exclude #20

v0.3.0

10 September 2022

Mutation observer #19
Fix cases where node.offsetTop is returning 0 #16
add playwright testing in tests/toc.test.ts a52aa29
mv .github/workflows/{publish,test}.yml and have it run yarn test in CI 42a232d
update deps and address sveltekit breaking changes e023246

v0.2.12

23 August 2022

Export headings and desktop and add hide prop #14

v0.2.11

18 August 2022

sveltekit auto migration ce8e4a8

v0.2.10

17 July 2022

[pre-commit.ci] pre-commit autoupdate #13
[pre-commit.ci] pre-commit autoupdate #11
update deps dd64696
replace scrollIntoViewIfNeeded() with scrollIntoView({ block: `nearest` }) 3466e0f

v0.2.9

2 April 2022

fix page.subscribe(requery_headings) causing ‘Function called outside component initialization’ f8ad29f

v0.2.8

23 March 2022

Fix afterNavigate() runtime error #10

v0.2.7

13 March 2022

Exclude headings with class .toc-exclude #9
replace onClickOutside action with svelte:window click listener da0cd75

v0.2.6

19 February 2022

fix scroll heading into view on ToC click f0b6f5f

v0.2.5

14 February 2022

add css vars —toc-active-bg and —toc-active-font-weight a2ad8ef
fix scroll heading into view on ToC click 983596b

v0.2.4

13 February 2022

much simpler active heading logic inspired by sveltekit docs ToC 1bab517
add .github/workflows/publish.yml, update readme mention afterNavigate lifecycle hook, use mdsvex v0.10.5 TS globals b3feb92

v0.2.3

22 January 2022

replace page.subscribe() + onMount() with new afterNavigate() lifecycle hook https://github.com/sveltejs/kit/pull/3293 4d39a87

v0.2.2

10 January 2022

add bool prop keepActiveTocItemInView f3e1dea

v0.2.1

7 January 2022

change default ToC title: Contents -> On this page, rename heading, bump node 16.1 to 17.3, add types of error + layout pages d52329f
drop custom Heading type, use HTMLHeadingElement directly (-15 LoC), add package default export d012ab7
[pre-commit.ci] pre-commit autoupdate bf6fa1a