quill_delta 1.0.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 95

Build Status 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.

1.0.1 #

  • Fixed assertion error for sequences of insert-delete-insert operations.

1.0.0 #

  • Added Delta.invert(), Delta.slice() and Delta.invertAttributes().

1.0.0-dev.4.0 #

  • Internal clean-up replacing hardcoded strings with constants.

1.0.0-dev.3.0 #

  • Updated dependency on quiver_hashcode.

1.0.0-dev.2.0 #

  • Prepare for Dart 2 stable.

1.0.0-dev.1.0 #

  • Initial release.

example/main.dart

// Copyright (c) 2018, Anatoly Pulyaevskiy. All rights reserved. Use of this source code
// is governed by a BSD-style license that can be found in the LICENSE file.

import 'package:quill_delta/quill_delta.dart';

void main() {
  var doc = Delta()..insert('Hello world', {'h': '1'});
  var change = 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⟩
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  quill_delta: ^1.0.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:quill_delta/quill_delta.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
90
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
95
Learn more about scoring.

We analyzed this package on Apr 7, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.7

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
collection ^1.14.5 1.14.12
quiver_hashcode ^2.0.0 2.0.0
Dev dependencies
pedantic ^1.9.0
test ^1.0.0
test_coverage ^0.4.1