Export test utilites

README.md

@@ -391,6 +391,22 @@ tables, and mentions. Conversion can be performed in vanilla Dart (i.e., server-
 It is a complete Dart part of the popular and mature [quill-delta-to-html](https://www.npmjs.com/package/quill-delta-to-html)
 Typescript/Javascript package.
 
+## Testing
+
+To aid in testing applications using the editor an extension to the flutter `WidgetTester` is provided which includes methods to simplify interacting with the editor in test cases.
+
+Import the test utilities in your test file:
+
+```dart
+import 'package:flutter_quill/flutter_quill_test.dart';
+```
+
+and then enter text using `quillEnterText`:
+
+```dart
+await tester.quillEnterText(find.byType(QuillEditor), 'test\n');
+```
+
 ## Sponsors
 
 <a href="https://bulletjournal.us/home/index.html">

lib/flutter_quill_test.dart

@@ -0,0 +1,3 @@
+library flutter_quill_test;
+
+export 'src/test/widget_tester_extension.dart';

lib/src/test/widget_tester_extension.dart

@@ -1,8 +1,10 @@
 import 'package:flutter/material.dart';
-import 'package:flutter_quill/src/widgets/editor.dart';
-import 'package:flutter_quill/src/widgets/raw_editor.dart';
 import 'package:flutter_test/flutter_test.dart';
 
+import '../widgets/editor.dart';
+import '../widgets/raw_editor.dart';
+
+/// Extends
 extension QuillEnterText on WidgetTester {
   /// Give the QuillEditor widget specified by [finder] the focus.
   Future<void> quillGiveFocus(Finder finder) {
@@ -29,12 +31,18 @@ extension QuillEnterText on WidgetTester {
   Future<void> quillEnterText(Finder finder, String text) async {
     return TestAsyncUtils.guard(() async {
       await quillGiveFocus(finder);
-      await updateEditingValue(finder, text);
+      await quillUpdateEditingValue(finder, text);
       await idle();
     });
   }
 
-  Future<void> updateEditingValue(Finder finder, String text) async {
+  /// Update the text editing value of the QuillEditor widget specified by
+  /// [finder] with [text], as if it had been provided by the onscreen keyboard.
+  ///
+  /// The widget specified by [finder] must already have focus and be a
+  /// [QuillEditor] or have a [QuillEditor] descendant. For example
+  /// `find.byType(QuillEditor)`.
+  Future<void> quillUpdateEditingValue(Finder finder, String text) async {
     return TestAsyncUtils.guard(() async {
       final editor = state<RawEditorState>(
         find.descendant(

test/bug_fix_test.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart';
-import 'package:flutter_quill/flutter_quill.dart' hide Text;
+import 'package:flutter_quill/flutter_quill.dart';
+import 'package:flutter_quill/flutter_quill_test.dart';
 import 'package:flutter_test/flutter_test.dart';
-import 'widget_tester_extension.dart';
 
 void main() {
   group('Bug fix', () {

test/widgets/editor_test.dart

@@ -2,12 +2,10 @@ import 'dart:convert' show jsonDecode;
 
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
-import 'package:flutter_quill/src/widgets/controller.dart';
+import 'package:flutter_quill/flutter_quill.dart';
-import 'package:flutter_quill/src/widgets/editor.dart';
+import 'package:flutter_quill/flutter_quill_test.dart';
 import 'package:flutter_test/flutter_test.dart';
 
-import '../widget_tester_extension.dart';
-
 void main() {
   late QuillController controller;