svelte-toc

What's Changed

• When opening ToC on mobile, ensure active ToC item is scrolled into view by @Comefled in https://github.com/janosh/svelte-toc/pull/54
• Add reactToKeys prop to Toc component and on_keydown handler to enable navigating ToC with keyboard by @janosh in https://github.com/janosh/svelte-toc/pull/55

New Contributors

• @Comefled made their first contribution in https://github.com/janosh/svelte-toc/pull/54

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.5.7...v0.5.8

What's Changed

• package.json add "types": "./dist/index.d.ts" and default --toc-overflow to auto by @pre-commit-ci in https://github.com/janosh/svelte-toc/pull/49
• Replace hacky window.setTimeout(50) callback with scrollend event to keepActiveTocItemInView by @janosh in https://github.com/janosh/svelte-toc/pull/53
• expose Toc aside and nav HTMLElements for external access fc8806d

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.5.6...v0.5.7

What's Changed

• Copy buttons by @janosh in https://github.com/janosh/svelte-toc/pull/43
• Add prop blurParams: BlurParams | null = { duration: 200 } by @janosh in https://github.com/janosh/svelte-toc/pull/47

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.5.5...v0.5.6

For https://github.com/janosh/svelte-toc/issues/46#issuecomment-1714412178.

What's Changed

• DRY GitHub Actions #40
• fix svelte a11y warning about <li> tabindex and role aa1cd50

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.5.4...v0.5.5

What's Changed

• Fix new timeout callback for keepActiveTocItemInView=true breaking page scrolling by @janosh in https://github.com/janosh/svelte-toc/pull/39

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.5.3...v0.5.4

What's Changed

• 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

New Contributors

• @roualdes made their first contribution in https://github.com/janosh/svelte-toc/pull/34

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.5.2...v0.5.3

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

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.5.1...v0.5.2

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

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.5.0...v0.5.1

What's Changed

• Deploy docs to GitHub Pages by @janosh in https://github.com/janosh/svelte-toc/pull/29
• Breaking: hide ToC if empty by @janosh in https://github.com/janosh/svelte-toc/pull/30

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.4.1...v0.5.0

What's Changed

• d08eb59 test that readme documents no non-existent props
• ecf994b test CSS variables in readme are in sync with actual component
• b7f6f49 improve readme docs on props, types and defaults
• yarn to pnpm by @janosh in https://github.com/janosh/svelte-toc/pull/27
• b18b003 add test 'ToC lists expected headings'
• Only trigger keyup event handler on enter/space keys by @janosh in https://github.com/janosh/svelte-toc/pull/28

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.4.0...v0.4.1

What's Changed

• Fix ToC preventing page scrolling beyond active heading when zoomed into page by @janosh in https://github.com/janosh/svelte-toc/pull/23 (fixes #22)
• Better readme test by @janosh in https://github.com/janosh/svelte-toc/pull/24

  • Toc.svelte remove unused windowHeight

  • breaking: rename slot tocItem to toc-item

  • add slot open-toc-icon

  • document new/renamed slots in readme

  • extend readme test to also check for correct type and default value of primitive-type props

  • fix lines in readme offending new test

  • simplify readme prop doc str format

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.3.2...v0.4.0

What's Changed

• Add prop titleTag allowing to change HTML tag used for ToC title by @oskar-gmerek in https://github.com/janosh/svelte-toc/pull/21
  • yarn add -D jsdom vitest and update existing deps
  • vite.config.ts set jsdom as test env
  • rename props page_body and title_tag to pageBody and titleTag
  • add missing doc string for pageBody to readme
  • add vitest unit tests for readme + src/lib/{index.ts,Svelte.toc}
  • remove CI matrix strategy, i.e. don't run tests on windows due to path issues

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.3.1...v0.3.2

What's Changed

• fix: exclude header of table itself by class toc-exclude by @oskar-gmerek in https://github.com/janosh/svelte-toc/pull/20

New Contributors

• @oskar-gmerek made their first contribution in https://github.com/janosh/svelte-toc/pull/20

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.3.0...v0.3.1

What's Changed

• Fix node.offsetTop returning 0 for headings in parents with position: relative by @Amerlander in https://github.com/janosh/svelte-toc/pull/16
• Playwright testing by @janosh in https://github.com/janosh/svelte-toc/pull/17
• Update deps and address SvelteKit breaking changes e023246
• Mutation observer by @janosh in https://github.com/janosh/svelte-toc/pull/19

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.2.12...v0.3.0

What's Changed

3466e0f replace scrollIntoViewIfNeeded() with scrollIntoView({ block: `nearest` })
dd64696 update deps

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.2.9...v0.2.10

f8ad29f fix page.subscribe(requery_headings) causing error 'Function called outside component initialization'

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.2.8...v0.2.9

What's Changed

• Fix afterNavigate() runtime error in https://github.com/janosh/svelte-toc/pull/10

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.2.7...v0.2.8

What's Changed

• Exclude headings with class .toc-exclude in https://github.com/janosh/svelte-toc/pull/9
  • tsconfig bump module + target to esnext
  • readme add live demo link
  • trigger publish CI on GH release
  • move ToC from left to right side on landing and long page
  • extract CSS vars from __layout to global.css
  • change default headingSelector to main :where(h1, h2, h3, h4):not(.toc-exclude)
  • add CSS var --toc-active-padding
  • add CSS var --toc-active-margin and use transform translateX instead of left margin to indent lower-level ToC items
• replace onClickOutside action with svelte:window click listener da0cd75

Full Changelog: https://github.com/janosh/svelte-toc/compare/v0.2.6...v0.2.7