Documentation

See the dedicated documentation page here.

Packages

@svelte-put includes several packages that have self-managed release cycles, listed below. Check out their corresponding README for more details.

Package	Short Description	Version	Changelog	Docs
@svelte-put/avatar	component & utilities for avatar		Changelog
@svelte-put/clickoutside	event for clicking outside node		Changelog
@svelte-put/copy	copy text to clipboard		Changelog
@svelte-put/dragscroll	add drag-to-scroll behavior		Changelog
@svelte-put/intersect	wrapper for IntersectionObserver		Changelog
@svelte-put/inline-svg	dynamically inline SVGs		Changelog
@svelte-put/lockscroll	lock scroll, hide scrollbar		Changelog
@svelte-put/modal	type-safe async modal builder		Changelog
@svelte-put/movable	move node on mousedown		Changelog
@svelte-put/noti	type-safe & headless async notification builder		Changelog
@svelte-put/preprocess-auto-slug	auto add id and anchor to selected nodes		Changelog
@svelte-put/preprocess-inline-svg	inline static SVGs at build time		Changelog
@svelte-put/resize	wrapper for ResizeObserver		Changelog
@svelte-put/shortcut	add keyboard shortcuts to node		Changelog
@svelte-put/toc	action & utilities for building table of contents		Changelog
@svelte-put/tooltip	type-safe headless tooltip builder		Changelog

In the Pipeline

These are some packages that will be added in the future (as soon as I find time, and the implementation has matured & become generic enough).

Names for those packages may change.

Contributing

Read Contribution Guide

This project is a monorepo using turborepo under the hood. Familiarity with turborepo is not required but encouraged.

For a quick start, run the script below at project root to see what commands are available.

pnpm turbo