Fabric.js Document Engine

Search documentation

Find a page or section

中文

What changed in each version, and what 1.x promises.

These are the fabricjs-document-engine release notes. Every version is published to npm and follows semantic versioning. From 1.0, the document format is frozen and every 1.x release opens files saved by earlier ones.

Latest releases

This timeline is read from GitHub releases. It updates on its own when a new version is published.

  • v1.0Latest

    • Complete document lifecycle support
    • Production ready public API
    • Stable backward compatible schema
    • Full compatibility test coverage
    • Performance benchmarks documented
    • Complete developer documentation
  • v0.9

    • React hooks included
    • Framework independent state store
    • Document size limits added
    • Imported data safely cleaned
    • Cross-browser testing completed
  • v0.8

    • Create named document versions
    • Restore previous document versions
    • Support older document formats
    • Import normal Fabric JSON
    • Automatic schema migration support
  • v0.7

    • Export PNG and JPEG
    • Export WebP and SVG
    • Export editable document JSON
    • Custom export scale support
    • Validate assets before export
  • v0.6

    • Register custom Fabric objects
    • Preserve custom object properties
    • Validate custom object types
    • Safe custom object loading
    • Custom serialization rules supported
  • v0.5

    • Track document image assets
    • Track required document fonts
    • Detect missing assets early
    • Detect missing fonts early
    • Replace unavailable document assets
  • v0.4

    • Recover work after refresh
    • Recover work after crashes
    • IndexedDB backup while editing
    • Restore temporary local images
    • Detect available recovery sessions
  • v0.3

    • Automatic document autosave support
    • Prevent old save overwrites
    • Track unsaved document changes
    • Retry failed saves automatically
    • Custom storage adapters supported
  • v0.2

    • Reliable undo and redo
    • One action, one history step
    • Group changes using transactions
    • IDs survive history changes
    • History memory limits included
  • v0.1

    • Stable IDs for every object
    • Basic document save and load
    • Canvas metadata safely stored
    • Object ordering always preserved
    • Fabric 6 and 7 support

Version history

The full changelog is in the repository. In short:

VersionWhat it added
1.0.0Frozen document format with a JSON Schema, UNSAVED_CHANGES guards, verifyStorageAdapter and the compatibility policy
0.8.0Safety limits for imported documents, a memory budget for undo, faster undo on large drawings, tests in Firefox and WebKit
0.7.0React hooks, createDocumentStateStore and the document:change event
0.6.0Named and automatic versions, and opening plain Fabric.js 5, 6 and Fabric.js 7 JSON
0.5.0Export to PNG, JPEG, WebP, SVG and JSON with a preflight check
0.4.0Crash recovery with IndexedDB
0.3.0Image and font checks, uploads and replaceImage
0.2.0Autosave, one save at a time, revision checks and retries
0.1.0Undo and redo with transactions and keyboard shortcuts
0.0.0Stable ids, the versioned document format and safe loading

What 1.x promises

The full rules are in the compatibility policy on GitHub. The short version: within 1.x, no API name, option, event or error code is removed or renamed, and every saved document keeps opening. New features may be added. The fabricjs-document-engine release notes announce any deprecation at least one minor release ahead.

To stay notified about fabricjs-document-engine release notes, watch the repository on GitHub, or check the package on npm.