Installation

Install the package

The main osdlabel package includes the complete SolidJS UI and re-exports all core logic. For most projects, this is the only package you need to install.

npm

npm i osdlabel

pnpm

pnpm add osdlabel

yarn

yarn add osdlabel

bun

bun add osdlabel

deno

deno add osdlabel

Note: osdlabel is built as a modular monorepo. If you are building a custom UI or using a different framework, you can install the underlying packages individually (e.g., @osdlabel/annotation, @osdlabel/fabric-osd). See Packages & Architecture for details.

Bundler setup

osdlabel is an ESM-only package. It comes pre-compiled with SolidJS optimized JavaScript, so your bundler does not need to handle its JSX.

TypeScript

osdlabel ships with full TypeScript declarations. No @types packages needed.

Next steps

See the Quick Start guide to create your first annotator.