flutter-quill/flutter_quill_test/README.md

# Flutter Quill Test

Test utilities for [flutter_quill](https://pub.dev/packages/flutter_quill)
which include methods to simplify interacting with the editor in test cases.

## Table of Contents
- [Flutter Quill Test](#flutter-quill-test)
  - [Table of Contents](#table-of-contents)
  - [Installation](#installation)
  - [Testing](#testing)
  - [Contributing](#contributing)

## Installation

Run the command in your project root folder:
```
dart pub add dev:flutter_quill_test
```

Example of how it will look like:

```yaml
dev_dependencies:
  flutter_quill_test: any # Use latest Version
  flutter_lints: any
  flutter_test:
    sdk: flutter
```

## 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_test/flutter_quill_test.dart';
```

and then enter text using `quillEnterText`:

```dart
await tester.quillEnterText(find.byType(QuillEditor), 'test\n');
```

## Contributing

We welcome contributions!

Please follow these guidelines when contributing to our project. See [CONTRIBUTING.md](../CONTRIBUTING.md) for more details.