Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev #1576

Closed
wants to merge 54 commits into from
Closed

Dev #1576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
35a9502
1
Dec 5, 2023
7207dbf
2
Dec 5, 2023
798d907
2+
Dec 5, 2023
09fc229
2++
Dec 5, 2023
2c87552
2+++
Dec 5, 2023
d464443
2++++
Dec 5, 2023
2406cf0
Remove s.yaml file
Dec 5, 2023
309655e
2+++++
Dec 5, 2023
e3a706c
2++++++
Dec 5, 2023
8d6a180
2+++++++
Dec 5, 2023
086dcb7
2++++++++
Dec 5, 2023
4a6bc16
Update the version
Dec 5, 2023
6fa840b
2+++++++++
Dec 5, 2023
44d2d40
2++++++++++
Dec 5, 2023
c9ac8cc
2+++++++++++
Dec 5, 2023
331f9c7
An attemp to fix CI Failure
Dec 5, 2023
dc94460
An attemp to fix CI Failure
Dec 5, 2023
70d0fd2
An attemp to fix CI Failure
Dec 5, 2023
b513bf2
Add development notes
Dec 5, 2023
b074484
3
Dec 5, 2023
08e55ab
Rename button files
Dec 5, 2023
913c33c
Dropdown QuillToolbarSelectHeaderStyleButton
Dec 5, 2023
4b4c148
Organize files
Dec 5, 2023
0d39d9d
3
Dec 5, 2023
d67bd71
3+
Dec 5, 2023
ec38dee
3++
Dec 5, 2023
8d3215f
Fix tests
Dec 5, 2023
2cb886b
Fix analysis warrning
Dec 5, 2023
daa597f
Replace pasteboard with super_cliboard
Dec 5, 2023
026b58a
3+++
Dec 5, 2023
59ada7f
Update version
Dec 5, 2023
8792025
3++++
Dec 5, 2023
5afa35e
Regenerate versions
Dec 5, 2023
25435c9
3+++++
Dec 6, 2023
0c4c6cd
Prepare 9.0.0-dev-4
Dec 6, 2023
9727fea
4
Dec 6, 2023
8daccae
Fix analysis warrnings
Dec 6, 2023
90645f1
Fix tests
Dec 6, 2023
d7ef182
Fix import warrnings
Dec 6, 2023
c5c8083
4+
Dec 6, 2023
21a192f
4++
Dec 6, 2023
9be1a55
Prepare for release dev 6
Dec 6, 2023
1705bff
Prepare for release dev 5
Dec 6, 2023
ec2d28c
Bug fixes
Dec 6, 2023
5e6115d
Bug fixes
Dec 6, 2023
3be21fb
Prepare dev version 6
Dec 6, 2023
6066f2f
Link pattern bug fixes
Dec 7, 2023
64ea5ef
Prepare dev version 7
Dec 7, 2023
5fcda94
5
Dec 7, 2023
70d5fe0
Fix analysis issues
Dec 7, 2023
748c58c
Prepare dev version 8
Dec 7, 2023
1174f1e
Update CHANGELOG.md
Dec 7, 2023
f0fa2d1
Update CHANGELOG.md
Dec 7, 2023
1aab0c7
Update doc and README.md
Dec 7, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
- [ ] I titled the PR using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0).
- [ ] I did not modify the `CHANGELOG.md` nor the plugin version in `pubspec.yaml` files.
- [ ] All existing and new tests are passing.
- [ ] I have run the commands in `./scripts/before-push.sh` and it all passed successfully
- [ ] I have run the commands in `./scripts/before_push.sh` and it all passed successfully

## Breaking Change

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ jobs:

- name: Check flutter version
run: flutter --version

- name: Enable Local Dev
run: ./scripts/enable_local_dev.sh

- name: Install dependencies
run: flutter pub get
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ jobs:
- name: Check flutter version
run: flutter --version

- name: Enable Local Dev
run: ./scripts/enable_local_dev.sh

- name: Install dependencies
run: flutter pub get

Expand Down
23 changes: 18 additions & 5 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,39 @@ jobs:
- uses: subosito/flutter-action@v2
with:
channel: 'stable'
cache: true

- name: Check flutter version
run: flutter --version

- name: Enable Local Dev
run: ./scripts/enable_local_dev.sh

- name: Install dependencies
run: flutter pub get

# Here you can insert custom steps you need
# - run: dart tool/generate-code.dart

- name: Re-generate the translations
run: ./scripts/regenerate-translations.sh


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

- name: Publish
- name: Publish flutter_quill
run: flutter pub publish --force

- name: Publish flutter_quill_extensions
run: flutter pub publish --force
working-directory: ./flutter_quill_extensions/

- name: Publish flutter_quill_test
run: flutter pub publish --force
working-directory: ./flutter_quill_test/

- name: Publish quill_html_converter
run: flutter pub publish --force
working-directory: ./packages/quill_html_converter/
5 changes: 1 addition & 4 deletions .pubignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,4 @@ example/.fvm/
example/build/
example/.dart_tool/

scripts/
<!-- flutter_quill_extensions/
flutter_quill_test/
packages/ -->
scripts/
52 changes: 52 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,58 @@

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

## 9.0.0-dev-8
* Better support for pasting HTML contents from external websites to the editor
* 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`)

## 9.0.0-dev-7
* Fix a bug in chaning the background/font color of ol/ul list
* Flutter Quill Extensions:
* Fix link bug in the video url
* Fix patterns

## 9.0.0-dev-6
* Move the `child` from `QuillToolbarConfigurations` into `QuillToolbar` directly
* Bug fixes
* Add the ability to change the background and font color of the ol/ul elements dots and numbers
* Flutter Quill Extensions:
* **Breaking Change**: The `imageProviderBuilder`is now providing the context and image url

## 9.0.0-dev-5
* 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
* Flutter Quill Extensions:
* Improve the camera button

## 9.0.0-dev-4
* The options parameter in all of the buttons is no longer required which can be useful to create custom toolbar with minimal efforts
* Toolbar buttons fixes in both `flutter_quill` and `flutter_quill_extensions`
* 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

## 9.0.0-dev-3
* Breaking Changes:
* Rename `QuillToolbar` to `QuillSimpleToolbar`
* Rename `QuillBaseToolbar` to `QuillToolbar`
* Replace `pasteboard` with `rich_cliboard`
* Fix a bug in the example when inserting an image from url
* Flutter Quill Extensions:
* Add support for copying the image to the system cliboard

## 9.0.0-dev-2
* An attemp to fix CI automated publishing

## 9.0.0-dev-1
* An attemp to fix CI automated publishing

## 9.0.0-dev
* **Major Breaking change**: The `QuillProvider` is now optional, the `controller` parameter has been moved to the `QuillEditor` and `QuillToolbar` once again.
* Flutter Quill Extensions;
* **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
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
embed, this won't affect how quill js work
* Improvemenets to the image embed
* Add support for `margin` for web
* Add untranslated strings to the `quill_en.arb`

## 8.6.4
* 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`
* Fix typos in `README.md`
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ to `pubspec_overrides.yaml` which will be ignored by `.gitignore` and will be us
9. Mention the new changes in the [CHANGELOG.md](../CHANGELOG.md) in the next block
10. Run the following script if possible
```
./scripts/before-push.sh
./scripts/before_push.sh
```
11. When you are done sending your pull request, run:
```
Expand Down
54 changes: 32 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,17 +94,26 @@ dependencies:
> 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!
>

Compatible versions:
<!-- Compatible versions:

| flutter_quill | flutter_quill_extensions | flutter_quill_test |
|-------------------------|--------------------------|-------------------------|
| 8.6.x | 0.7.x | 0.0.5 |
| 8.5.x | 0.6.x | 0.0.5 |
| flutter_quill | Flutter | Dart |
|---------------|---------|-------|
| 9.0.x | 3.16.x | 3.2.x |

These versions are tested and well-supported, you shouldn't get a build failure
These versions are tested and well-supported, you shouldn't get a build failure -->

## Usage

Before using the package, we must inform you the package use the following plugins:
```
url_launcher
flutter_keyboard_visibility
device_info_plus
super_clipboard
```

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.

First, you need to instantiate a controller

```dart
Expand All @@ -116,24 +125,23 @@ connect the `QuillController` to them
using `QuillProvider` inherited widget

```dart
QuillProvider(
configurations: QuillConfigurations(
QuillToolbar.simple(
configurations: QuillSimpleToolbarConfigurations(
controller: _controller,
sharedConfigurations: const QuillSharedConfigurations(
locale: Locale('de'),
),
),
child: Column(
children: [
const QuillToolbar(),
Expanded(
child: QuillEditor.basic(
configurations: const QuillEditorConfigurations(
readOnly: false,
),
),
)
],
),
Expanded(
child: QuillEditor.basic(
configurations: QuillEditorConfigurations(
controller: _controller,
readOnly: false,
sharedConfigurations: const QuillSharedConfigurations(
locale: Locale('de'),
),
),
),
)
```
Expand Down Expand Up @@ -228,11 +236,13 @@ To see how to use the extension package, please take a look at the [README](./fl
Having your document stored in Quill Delta format is sometimes not enough. Often you'll need to convert
it to other formats such as HTML to publish it, or send an email.

**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

You have two options:

1. Using [quill_html_converter](./packages/quill_html_converter/) to convert to/from HTML, the package can convert the Quill delta to HTML well
(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
2. Another option is to use
1. Using [quill_html_converter](./packages/quill_html_converter/) to convert to HTML, the package can convert the Quill delta to HTML well
(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
1. Another option is to use
[vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html) to convert your document
to HTML.
This package has full support for all Quill operations—including images, videos, formulas,
Expand Down
8 changes: 2 additions & 6 deletions doc/custom_embed_blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,14 +88,10 @@ Future<void> _addEditNote(BuildContext context, {Document? document}) async {
)
],
),
content: QuillProvider(
configurations: QuillConfigurations(
controller: quillEditorController,
),
child: QuillEditor.basic(
content: QuillEditor.basic(
configurations: const QuillEditorConfigurations(
controller: quillEditorController,
readOnly: false,
),
),
),
),
Expand Down
Loading
Loading