Skip to content

Commit c026990

Browse files
authored
Version 9.0.0 (singerdmx#1566)
* Prepare for Version 9.0.0
1 parent 363437d commit c026990

File tree

196 files changed

+9714
-3359
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

196 files changed

+9714
-3359
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
- [ ] I titled the PR using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0).
2929
- [ ] I did not modify the `CHANGELOG.md` nor the plugin version in `pubspec.yaml` files.
3030
- [ ] All existing and new tests are passing.
31-
- [ ] I have run the commands in `./scripts/before-push.sh` and it all passed successfully
31+
- [ ] I have run the commands in `./scripts/before_push.sh` and it all passed successfully
3232

3333
## Breaking Change
3434

.github/workflows/build.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ jobs:
1717

1818
- name: Check flutter version
1919
run: flutter --version
20+
21+
- name: Enable Local Dev
22+
run: ./scripts/enable_local_dev.sh
2023

2124
- name: Install dependencies
2225
run: flutter pub get

.github/workflows/main.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ jobs:
2020
- name: Check flutter version
2121
run: flutter --version
2222

23+
- name: Enable Local Dev
24+
run: ./scripts/enable_local_dev.sh
25+
2326
- name: Install dependencies
2427
run: flutter pub get
2528

.github/workflows/publish.yml

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,39 @@ jobs:
1616
- uses: subosito/flutter-action@v2
1717
with:
1818
channel: 'stable'
19+
cache: true
1920

2021
- name: Check flutter version
2122
run: flutter --version
23+
24+
- name: Enable Local Dev
25+
run: ./scripts/enable_local_dev.sh
2226

2327
- name: Install dependencies
2428
run: flutter pub get
2529

2630
# Here you can insert custom steps you need
2731
# - run: dart tool/generate-code.dart
28-
29-
- name: Re-generate the translations
30-
run: ./scripts/regenerate-translations.sh
31-
3232

3333
# This is needed in order for the authentication to success
3434
# dart pub token add https://pub.dev --env-var PUB_TOKEN
3535
# Requests to "https://pub.dev" will now be authenticated using the secret token stored in the environment variable "PUB_TOKEN".
3636
- uses: dart-lang/setup-dart@v1
37+
## dart-lang/setup-dart/.github/workflows/publish.yml@v1
3738
# - name: Update the authorization requests to "https://pub.dev" to use the environment variable "PUB_TOKEN".
3839
# run: dart pub token add https://pub.dev --env-var PUB_TOKEN
3940

40-
- name: Publish
41+
- name: Publish flutter_quill
42+
run: flutter pub publish --force
43+
44+
- name: Publish flutter_quill_extensions
45+
run: flutter pub publish --force
46+
working-directory: ./flutter_quill_extensions/
47+
48+
- name: Publish flutter_quill_test
49+
run: flutter pub publish --force
50+
working-directory: ./flutter_quill_test/
51+
52+
- name: Publish quill_html_converter
4153
run: flutter pub publish --force
54+
working-directory: ./packages/quill_html_converter/

.pubignore

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,4 @@ example/.fvm/
1010
example/build/
1111
example/.dart_tool/
1212

13-
scripts/
14-
<!-- flutter_quill_extensions/
15-
flutter_quill_test/
16-
packages/ -->
13+
scripts/

CHANGELOG.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,58 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## 9.0.0-dev-8
6+
* Better support for pasting HTML contents from external websites to the editor
7+
* The experimental support of converting the HTML from `quill_html_converter` is now built-in in the `flutter_quill` and removed from there (Breaking change for `quill_html_converter`)
8+
9+
## 9.0.0-dev-7
10+
* Fix a bug in chaning the background/font color of ol/ul list
11+
* Flutter Quill Extensions:
12+
* Fix link bug in the video url
13+
* Fix patterns
14+
15+
## 9.0.0-dev-6
16+
* Move the `child` from `QuillToolbarConfigurations` into `QuillToolbar` directly
17+
* Bug fixes
18+
* Add the ability to change the background and font color of the ol/ul elements dots and numbers
19+
* Flutter Quill Extensions:
20+
* **Breaking Change**: The `imageProviderBuilder`is now providing the context and image url
21+
22+
## 9.0.0-dev-5
23+
* The `QuillToolbar` is now accepting only `child` with no configurations so you can customize everything you wants, the `QuillToolbar.simple()` or `QuillSimpleToolbar` implements a simple toolbar that is based on `QuillToolbar`, you are free to use it but it just an example and not standard
24+
* Flutter Quill Extensions:
25+
* Improve the camera button
26+
27+
## 9.0.0-dev-4
28+
* The options parameter in all of the buttons is no longer required which can be useful to create custom toolbar with minimal efforts
29+
* Toolbar buttons fixes in both `flutter_quill` and `flutter_quill_extensions`
30+
* The `QuillProvider` has been dropped and no longer used, the providers will be used only internally from now on and we will not using them as much as possible
31+
32+
## 9.0.0-dev-3
33+
* Breaking Changes:
34+
* Rename `QuillToolbar` to `QuillSimpleToolbar`
35+
* Rename `QuillBaseToolbar` to `QuillToolbar`
36+
* Replace `pasteboard` with `rich_cliboard`
37+
* Fix a bug in the example when inserting an image from url
38+
* Flutter Quill Extensions:
39+
* Add support for copying the image to the system cliboard
40+
41+
## 9.0.0-dev-2
42+
* An attemp to fix CI automated publishing
43+
44+
## 9.0.0-dev-1
45+
* An attemp to fix CI automated publishing
46+
47+
## 9.0.0-dev
48+
* **Major Breaking change**: The `QuillProvider` is now optional, the `controller` parameter has been moved to the `QuillEditor` and `QuillToolbar` once again.
49+
* Flutter Quill Extensions;
50+
* **Breaking Change**: Completly change the way how the source code structured to more basic and simple way, organize folders and file names, if you use the library
51+
from `flutter_quill_extensions.dart` then there is nothing you need to do, but if you are using any other import then you need to re-imports
52+
embed, this won't affect how quill js work
53+
* Improvemenets to the image embed
54+
* Add support for `margin` for web
55+
* Add untranslated strings to the `quill_en.arb`
56+
557
## 8.6.4
658
* The default value of `keyboardAppearance` for the iOS will be the one from the App/System theme mode instead of always using the `Brightness.light`
759
* Fix typos in `README.md`

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ to `pubspec_overrides.yaml` which will be ignored by `.gitignore` and will be us
3939
9. Mention the new changes in the [CHANGELOG.md](../CHANGELOG.md) in the next block
4040
10. Run the following script if possible
4141
```
42-
./scripts/before-push.sh
42+
./scripts/before_push.sh
4343
```
4444
11. When you are done sending your pull request, run:
4545
```

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,17 +94,27 @@ dependencies:
9494
> Your input and insights are valuable in shaping a stable and reliable version for all our users. Thank you for being part of the open-source community!
9595
>
9696
97-
Compatible versions:
97+
<!-- Compatible versions:
9898
9999
| flutter_quill | flutter_quill_extensions | flutter_quill_test |
100100
|-------------------------|--------------------------|-------------------------|
101101
| 8.6.x | 0.7.x | 0.0.5 |
102102
| 8.5.x | 0.6.x | 0.0.5 |
103103
104-
These versions are tested and well-supported, you shouldn't get a build failure
104+
These versions are tested and well-supported, you shouldn't get a build failure -->
105105
106106
## Usage
107107
108+
Before using the package, we must inform you the package use the following plugins:
109+
```
110+
url_launcher
111+
flutter_keyboard_visibility
112+
device_info_plus
113+
super_clipboard
114+
```
115+
116+
All of them doesn't require any platform spesefic setup, except [super_clipboard](https://pub.dev/packages/super_clipboard) which needs some setup on Android only, it's optional but to support copying images and pasting them into editor then you must setup it, open the page in pub.dev and read the `README.md` to get the instructions.
117+
108118
First, you need to instantiate a controller
109119

110120
```dart
@@ -228,11 +238,13 @@ To see how to use the extension package, please take a look at the [README](./fl
228238
Having your document stored in Quill Delta format is sometimes not enough. Often you'll need to convert
229239
it to other formats such as HTML to publish it, or send an email.
230240

241+
**Note**: This package support converting from HTML back to Quill delta but it's experimental and used internally when pasting Html content from the cliboard to the Quill Editor
242+
231243
You have two options:
232244

233-
1. Using [quill_html_converter](./packages/quill_html_converter/) to convert to/from HTML, the package can convert the Quill delta to HTML well
234-
(it uses [vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html)) but the converting from HTML back to Quill delta is experimental
235-
2. Another option is to use
245+
1. Using [quill_html_converter](./packages/quill_html_converter/) to convert to HTML, the package can convert the Quill delta to HTML well
246+
(it uses [vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html)), it just a handy extension to do it more quickly
247+
1. Another option is to use
236248
[vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html) to convert your document
237249
to HTML.
238250
This package has full support for all Quill operations—including images, videos, formulas,

doc/development_notes.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# Development notes
22

33
- When updating the translations or localizations in the app, please take a look at the [Translation](./translation.md) page as it has important notes in order to work, if you also add a feature that adds new localizations then you need to the instructions of it in order for the translations to take effect
4+
- Only update the `version.dart` and `CHANGELOG.md` at the root folder of the repo, then run the script:
5+
6+
```console
7+
dart ./scripts/regenerate_versions.dart
8+
```
9+
You must mention the changes of the other packages in the repo in the root `CHANGELOG.md` only and the script will replace the `CHANGELOG.md` in the other packages with the root one, and change the version in `pubspec.yaml` with the one in `version.dart` in the root folder

0 commit comments

Comments
 (0)