Getting Started

Installation

Get started with svelte-idb in your SvelteKit project.

Install the package

Install svelte-idb using your preferred package manager.

Terminal

Requirements

svelte-idb requires Svelte 5 (runes mode) and works with SvelteKit out of the box. It has zero runtime dependencies.

NameTypeDescription
Svelte *^5.0.0Svelte 5 with runes support
SvelteKit AnyOptional — SSR safety is built-in
TypeScript RecommendedFull type inference for schemas

Two entry points

The library provides two import paths for different use cases.

imports.ts

Use the reactive entry point for Svelte projects. The core entry point is useful for shared logic or non-Svelte contexts.