a774ac673a
Some checks failed
Deploy analytics worker / Deploy analytics worker to ${{ (github.ref == 'refs/heads/production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Failing after 1s
i18n upload strings / Upload latest strings (push) Failing after 1s
Deploy bemo / Deploy bemo to ${{ (github.ref == 'refs/heads/bemo-production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Failing after 1s
Deploy grafana resources / ${{ github.event_name == 'push' && 'Deploy grafana resources' || 'Validate grafana resources (dry run)' }} (push) Failing after 0s
End to end tests (dotcom) / Check for relevant changes (push) Failing after 0s
End to end tests (examples) / Check for relevant changes (push) Failing after 0s
End to end tests (mermaid readability) / Check for relevant changes (push) Failing after 1s
End to end tests (perf) / Check for relevant changes (push) Failing after 0s
Publish editor extensions / Publish editor extensions (push) Failing after 1s
Publish SDK packages / Remove the publish-packages label (push) Has been skipped
Checks / Tests & checks (push) Has been cancelled
Checks / Build all projects (push) Has been cancelled
Deploy templates / Deploy templates (push) Has been cancelled
End to end tests (dotcom) / End to end tests (dotcom) (push) Has been cancelled
End to end tests (mermaid readability) / End to end tests (mermaid readability) (push) Has been cancelled
End to end tests (perf) / End to end tests (perf) (push) Has been cancelled
Deploy .com / Deploy dotcom to ${{ (github.ref == 'refs/heads/production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Has been cancelled
End to end tests (examples) / End to end tests (examples) (push) Has been cancelled
Publish SDK packages / Publish SDK packages (push) Has been cancelled
Publish SDK packages / Tell user released version (push) Has been cancelled
Publish SDK packages / Publishes code templates to separate repositories (push) Has been cancelled
Publish SDK packages / Deploys the template demos with the new SDK version (push) Has been cancelled
77 lines
4.5 KiB
Plaintext
77 lines
4.5 KiB
Plaintext
---
|
|
title: Releases
|
|
status: published
|
|
author: steveruizok
|
|
order: 3
|
|
---
|
|
|
|
Release notes for all tldraw SDK versions. Each minor release has its own page documenting new features, breaking changes, API additions, improvements, and bug fixes. Patch releases are listed within their parent minor release.
|
|
|
|
For the original releases, see the [GitHub releases page](https://github.com/tldraw/tldraw/releases).
|
|
|
|
## How tldraw is versioned
|
|
|
|
Unlike many JavaScript packages distributed on [NPM](https://www.npmjs.com/), the tldraw SDK does not follow [semantic versioning](https://semver.org/) in its release versions. Instead:
|
|
|
|
- Major version bumps are rare. We reserve them for fundamental changes to how the SDK works.
|
|
- Minor version bumps are released on a regular cadence, approximately monthly. **They may contain breaking changes**. We aim to make breaking changes as minimally disruptive as possible, but tldraw is actively evolving as we add new features. We recommend updating at a similar pace and checking the release notes.
|
|
- Patch version bumps are for bugfixes and hotfixes that can't wait for the next cadence release.
|
|
|
|
## Latest tldraw versions
|
|
|
|
- Run `npm install tldraw` to get the latest minor version of tldraw
|
|
- Use `npm install tldraw@next` to get the latest version of tldraw that is used on [tldraw.com](https://www.tldraw.com)
|
|
- The latest changes to the `main` branch of tldraw are available to test through our [pre-release canary builds](https://www.npmjs.com/package/tldraw?activeTab=versions).
|
|
|
|
## Migration skill
|
|
|
|
We ship an experimental `tldraw-migrate` agent skill that helps a coding agent update your project to the latest version of the SDK. It detects your current version, fetches the relevant release notes, upgrades packages, and works through any type errors using the migration guides in our release notes. See our [migration skill guide](/releases/migration-skill) for details on how to install and use the skill.
|
|
|
|
## Next
|
|
|
|
- [next](/releases/next) - Changes for the upcoming release.
|
|
|
|
## v5.x
|
|
|
|
- [v5.4](/releases/v5.4.0) - A center align operation, a tleditors registry of mounted editors, faster signals and store layers, and a broad reliability pass across the SDK
|
|
- [v5.3](/releases/v5.3.0) - Commenting with anchored threads on the canvas, new collaboration packages, geo shape flipping, crop snapping, and faster viewport culling
|
|
- [v5.2](/releases/v5.2.0) - Faster freehand ink, a frame selection action, SDK-wide performance improvements, and breaking changes to the collaborator user-id types and Node support
|
|
- [v5.1](/releases/v5.1.0) - Page menu redesign, copy-styles shortcut, selectable locked shapes, public translation APIs, and performance improvements
|
|
- [v5.0](/releases/v5.0.0) - Custom themes, overlays, performance, extensiblity, and attribution
|
|
|
|
## v4.x
|
|
|
|
- [v4.5](/releases/v4.5.0) - Click-through on transparent pixels, SVG sanitization, configurable embed definitions
|
|
- [v4.4](/releases/v4.4.0) - Image pipeline starter kit, performance improvements, quick zoom, canvas indicators
|
|
- [v4.3](/releases/v4.3.0) - SQLite sync storage, improved custom shape types, reactive inputs, draw shape encoding
|
|
- [v4.2](/releases/v4.2.0) - TipTap v3, dynamic tools, custom socket implementations
|
|
- [v4.1](/releases/v4.1.0) - Shader starter kit, localStorage atoms, minimap filtering
|
|
- [v4.0](/releases/v4.0.0) - Starter kits, WCAG 2.2 AA compliance, licensing updates
|
|
|
|
## v3.x
|
|
|
|
- [v3.15](/releases/v3.15.0) - `npm create tldraw` CLI, accessibility improvements
|
|
- [v3.14](/releases/v3.14.0) - Contextual toolbars, PathBuilder API
|
|
- [v3.13](/releases/v3.13.0) - Elbow arrows for technical diagrams
|
|
- [v3.12](/releases/v3.12.0) - Accessibility focus, keyboard navigation
|
|
- [v3.11](/releases/v3.11.0) - Rich text fixes, zoom improvements
|
|
- [v3.10](/releases/v3.10.0) - Rich text as first-class primitive
|
|
- [v3.9](/releases/v3.9.0) - Layout improvements, AtomMap class
|
|
- [v3.8](/releases/v3.8.0) - React 19 compatibility, i18n expansion
|
|
- [v3.7](/releases/v3.7.0) - Presence sync customization
|
|
- [v3.6](/releases/v3.6.0) - Expanded action helpers
|
|
- [v3.5](/releases/v3.5.0) - Grid snapping, layer improvements
|
|
- [v3.4](/releases/v3.4.0) - Excalidraw compatibility
|
|
- [v3.3](/releases/v3.3.0) - Readonly mode, sync improvements
|
|
- [v3.2](/releases/v3.2.0) - Version alignment release
|
|
- [v3.1](/releases/v3.1.0) - Shape visibility, server-side updates
|
|
- [v3.0](/releases/v3.0.0) - New licensing, deep links, custom embeds
|
|
|
|
## v2.x
|
|
|
|
- [v2.4](/releases/v2.4.0)
|
|
- [v2.3](/releases/v2.3.0)
|
|
- [v2.2](/releases/v2.2.0)
|
|
- [v2.1](/releases/v2.1.0)
|
|
- [v2.0](/releases/v2.0.0) - Initial public release
|