Search packages, repositories and app categories

Package detailsv2.0.0

quill_delta

Simple and expressive format for describing rich-text content created for Quill.js editor. This package is unofficial port to Dart from JavaScript.

30-day downloads
6.2K
Likes
34
Pub points
40

Install package

flutter pub add quill_delta

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A Dart implementation of the Quill.js delta format, designed to represent rich-text content in a simple and expressive way. This unofficial port enables developers to work with structured text changes, such as inserts, deletes, and formatting, across Flutter applications. It supports seamless integration with rich-text editors and facilitates efficient synchronization of text content between clients and servers. The package is lightweight and focused on core delta operations, making it ideal for real-time collaboration or document editing features.

Use cases

  • Real-time collaborative editing
  • Document versioning and history
  • Rich-text serialization and deserialization
  • Syncing text changes between client and server
  • Building custom rich-text editors

Key features

  • Lightweight delta representation
  • Supports text formatting and embeds
  • Efficient diff and patch operations
  • JSON-compatible data structure
  • Unofficial but well-maintained port from JavaScript

Suitable for

  • Developers building rich-text editors
  • Applications requiring text change tracking
  • Projects using Quill.js backend compatibility
  • Teams implementing collaborative features

Considerations

  • Not officially maintained by Quill.js team
  • Limited documentation compared to official libraries
  • Requires manual handling of complex formatting scenarios
  • No built-in UI components for rendering deltas

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

Build Status codecov Pub

Implementation of Quill editor Delta format in Dart. Refer to official documentation for more details.

Usage

import 'package:quill_delta/quill_delta.dart';

void main() {
  var doc = new Delta()..insert('Hello world', {'h': '1'});
  var change = new Delta()
    ..retain(6)
    ..delete(5)
    ..insert('Earth');
  var result = doc.compose(change);
  print('Original document:\n$doc\n');
  print('Change:\n$change\n');
  print('Updated document:\n$result\n');

  /// Prints:
  ///
  ///     Original document:
  ///     ins⟨Hello world⟩ + {h: 1}
  ///
  ///     Change:
  ///     ret⟨6⟩
  ///     ins⟨Earth⟩
  ///     del⟨5⟩
  ///
  ///     Updated document:
  ///     ins⟨Hello ⟩ + {h: 1}
  ///     ins⟨Earth⟩
}

Features and bugs

Please file feature requests and bugs at the issue tracker.

Categories

Dependencies

Dependency list 2 items

Source repository

Projects using this package

No data available yet.