feat!: release version 11.0.0 with breaking changes

CHANGELOG_DATA.json

@@ -1,4 +1,5 @@
 {
+    "11.0.0-dev.1": "This release is identical to [11.0.0-dev.0](https://github.com/singerdmx/flutter-quill/releases/tag/v11.0.0-dev.0), mainly published to update the min published version (from pub.dev) of `flutter_quill` in `flutter_quill_test` and `flutter_quill_extensions`.\n\nSee the [migration guide](https://github.com/singerdmx/flutter-quill/blob/release/v11/doc/migration/10_to_11.md).\n\n**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v11.0.0-dev.0...v11.0.0-dev.1",
     "10.8.5": "* fix: allow all correct URLs to be formatted by @orevial in https://github.com/singerdmx/flutter-quill/pull/2328\r\n* fix(macos): Implement actions for ExpandSelectionToDocumentBoundaryIntent and ExpandSelectionToLineBreakIntent to use keyboard shortcuts, unrelated cleanup to the bug fix. by @EchoEllet in https://github.com/singerdmx/flutter-quill/pull/2279\r\n\r\n## New Contributors\r\n* @orevial made their first contribution at https://github.com/singerdmx/flutter-quill/pull/2328\r\n\r\n**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.8.4...v10.8.5",
     "10.8.4": "- [Fixes an unhandled exception](https://github.com/singerdmx/flutter-quill/commit/8dd559b825030d29b30b32b353a08dcc13dc42b7) in case `getClipboardFiles()` wasn't supported\r\n- [Updates min version](https://github.com/singerdmx/flutter-quill/commit/49569e47b038c5f61b7521571c102cf5ad5a0e3f) of internal dependency `quill_native_bridge`\r\n\r\n**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.8.3...v10.8.4",
     "10.8.3": "This release is identical to [v10.8.3-dev.0](https://github.com/singerdmx/flutter-quill/releases/tag/v10.8.3-dev.0), mainly published to bump the minimum version of [flutter_quill](https://pub.dev/packages/flutter_quill) in [flutter_quill_extensions](https://pub.dev/packages/flutter_quill_extensions) and to publish [quill-super-clipboard](https://github.com/FlutterQuill/quill-super-clipboard/).\r\n\r\nA new identical release `10.9.0` will be published soon with a release description.\r\n\r\n**Full Changelog**: https://github.com/singerdmx/flutter-quill/compare/v10.8.2...v10.8.3",

README.md

@@ -51,7 +51,7 @@ You can join our [Slack Group] for discussion.
 
 - [📸 Screenshots](#-screenshots)
 - [📦 Installation](#-installation)
-- [🛠 Platform Specific Configurations](#-platform-specific-configurations)
+- [🛠 Platform Setup](#-platform-setup)
 - [🚀 Usage](#-usage)
 - [💥 Breaking Changes](#-breaking-changes)
 - [🔤 Input / Output](#-input--output)
@@ -83,9 +83,8 @@ You can join our [Slack Group] for discussion.
 
 ## 📦 Installation
 
-```yaml
-dependencies:
-  flutter_quill: ^<latest-version-here>
+```shell
+flutter pub add flutter_quill
 ```
 
 <p align="center">OR</p>
@@ -99,13 +98,9 @@ dependencies:
 ```
 
 > [!TIP]
-> Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement
-> of the library.
-> Your input and insights are valuable in shaping a stable and reliable version for all the developers. Thank you for
-> being part of the open-source community!
->
+> If you're using version `10.0.0`, see [the migration guide to migrate to `11.0.0`](https://github.com/singerdmx/flutter-quill/blob/master/doc/migration/10_to_11.md).
 
-## 🛠 Platform Specific Configurations
+## 🛠 Platform Setup
 
 The `flutter_quill` package uses the following plugins:
 
@@ -158,29 +153,45 @@ Create the file `your_project/android/app/src/main/res/xml/file_paths.xml` with
 
 > [!NOTE]
 > Starting with Flutter Quill `10.8.4`, [super_clipboard](https://pub.dev/packages/super_clipboard) is no longer required in `flutter_quill` or `flutter_quill_extensions`.
-> The new default is an internal plugin, [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge).
+> The new default is an internal plugin [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge).
 > If you want to continue using `super_clipboard`, you can use the [quill_super_clipboard](https://pub.dev/packages/quill_super_clipboard) package (support may be discontinued).
 
 ## 🚀 Usage
 
+Add the localization delegate to your app widget:
+
+```dart
+import 'package:flutter_quill/flutter_quill.dart';
+import 'package:flutter_localizations/flutter_localizations.dart';
+
+MaterialApp(
+  localizationsDelegates: const [
+    GlobalMaterialLocalizations.delegate,
+    GlobalCupertinoLocalizations.delegate,
+    GlobalWidgetsLocalizations.delegate,
+    FlutterQuillLocalizations.delegate,
+  ]，
+);
+```
+
 Instantiate a controller:
 
 ```dart
 QuillController _controller = QuillController.basic();
 ```
 
-Use the `QuillEditor`, and `QuillSimpleToolbar` widgets,
+Use the `QuillEditor` and `QuillSimpleToolbar` widgets,
 and attach the `QuillController` to them:
 
 ```dart
 QuillSimpleToolbar(
   controller: _controller,
-  configurations: const QuillSimpleToolbarConfigurations(),
+  config: const QuillSimpleToolbarConfig(),
 ),
 Expanded(
   child: QuillEditor.basic(
     controller: _controller,
-    configurations: const QuillEditorConfigurations(),
+    config: const QuillEditorConfig(),
   ),
 )
 ```
@@ -207,7 +218,7 @@ as they may be altered even in minor versions.
 and [`@visibleForTesting`](https://api.flutter.dev/flutter/meta/visibleForTesting-constant.html) are not intended for
 public use and should be avoided entirely.
 
-- The `package:flutter_quill/flutter_quill_internal.dart` expose internal APIs
+- The `package:flutter_quill/internal.dart` expose internal APIs
 to be used by other related packages and should be avoided when possible.
 
 We make every effort to ensure internal APIs are not exported by default. Use experimental features at your own discretion.
@@ -216,16 +227,8 @@ We recommend checking the `CHANGELOG.md` or release notes for each update to sta
 
 ## 🔤 Input / Output
 
-This library uses [Quill Delta](https://quilljs.com/docs/delta/)
-to represent the document content.
-The Delta format is a compact and versatile way to describe document changes.
-It consists of a series of operations, each representing an insertion, deletion,
-or formatting change within the document.
-
-> [!NOTE]
-> Don’t be confused by its name Delta—Deltas represents both documents and changes to documents.
-> If you think of Deltas as the instructions for going from one document to another,
-> the way Deltas represents a document is by expressing the instructions starting from an empty document.
+This library utilizes [Quill Delta](https://quilljs.com/docs/delta/) to represent document content.
+The Delta format is a compact and versatile method for describing document changes through a series of operations that denote insertions, deletions, or formatting changes.
 
 * Use `_controller.document.toDelta()` to extract the deltas.
 * Use `_controller.document.toPlainText()` to extract plain text.
@@ -248,10 +251,6 @@ _controller.document = Document.fromJson(json);
 
 - [Quill Delta](https://quilljs.com/docs/delta/)
 - [Quill Delta Formats](https://quilljs.com/docs/formats)
-- [Why Quill](https://quilljs.com/guides/why-quill/)
-- [Quill JS Configurations](https://quilljs.com/docs/configuration/)
-- [Quill JS Interactive Playground](https://quilljs.com/playground/)
-- [Quill JS GitHub repo](https://github.com/quilljs/quill)
 
 ## ⚙️ Configurations
 
@@ -296,42 +295,16 @@ of [FlutterQuill Extensions]
 ## 🔄 Conversion to HTML
 
 > [!CAUTION]
-> **Converting HTML or Markdown to Delta is highly experimental and shouldn't be used for production applications**,
-> while the current implementation we have internally is far from perfect, it could improved however **it will likely
-not
-work as expected**, due to differences between **HTML** and **Delta**, see
-> this [Quill JS Comment #311458570](https://github.com/slab/quill/issues/1551#issuecomment-311458570) for more
-> info.<br>
-> We only use it **internally** as it is more suitable for our specific use case, copying content from external websites
-> and pasting it into the editor
-> previously breaks the styles, while the current implementation is not designed for converting a **full Document** from
-> other formats to **Delta**, it provides a better user experience and doesn't have many downsides.
+> Converting **HTML** to **Delta** is generally not recommended due to structural and functional differences between HTML and Delta ([see this comment](https://github.com/slab/quill/issues/1551#issuecomment-311458570)).
+> We highly recommend storing the **Document** as **Delta JSON**
+> in the database instead of other formats (e.g., HTML, Markdown, PDF, Microsoft Word, Google Docs, Apple Pages, XML, CSV, etc...)
 >
-> The support for converting HTML to **Quill Delta** is quite experimental and used internally when
-> pasting HTML content from the clipboard to the Quill Document.
+> The support for converting HTML (from external websites and apps) to **Quill Delta** is used internally when
+> pasting HTML content from the clipboard to the document.
 >
 > Converting **Delta** from/to **HTML** is not a standard feature in [Quill JS](https://github.com/slab/quill)
 > or [FlutterQuill].
 
-> [!IMPORTANT]
-> Converting **HTML** to **Delta** usually won't work as expected, we highly recommend storing the **Document** as *
-*Delta JSON**
-> in the database instead of other formats (e.g., HTML, Markdown, PDF, Microsoft Word, Google Docs, Apple Pages, XML,
-> CSV,
-> etc...)
->
-> Converting between **HTML** and **Delta** JSON is generally not recommended due to their structural and functional
-> differences.
->
-> Sometimes you might want to convert between **HTML** and **Delta** for specific use cases:
->
-> 1. **Migration**: If you're using an existing system that stores the data in HTML and want to convert the document
-     data to **Delta**.
-> 2. **Sharing**: For example, if you want to share the Document **Delta** somewhere or send it as an email.
-> 3. **Save as**: If your app has a feature that allows converting Documents to other formats.
-> 4. **Rich text pasting**: If you copy some content from websites or apps, and want to paste it into the app.
-> 5. **SEO**: In case you want to use HTML for SEO support.
-
 The following packages can be used:
 
 1. [`vsc_quill_delta_to_html`](https://pub.dev/packages/vsc_quill_delta_to_html): To convert **Delta**
@@ -340,6 +313,16 @@ The following packages can be used:
 3. [`flutter_quill_to_pdf`](https://pub.dev/packages/flutter_quill_to_pdf): To convert **Delta** To **PDF**.
 4. [`markdown_quill`](https://pub.dev/packages/markdown_quill): To convert **Markdown** To **Delta** and vice versa.
 
+> [!TIP]
+> You might want to convert between **HTML** and **Delta** for some use cases:
+>
+> 1. **Migration**: If you're using an existing system that stores the data in HTML and want to convert the document
+     data to **Delta**.
+> 2. **Sharing**: For example, if you want to share the Document **Delta** somewhere or send it as an email.
+> 3. **Save as**: If your app has a feature that allows converting Documents to other formats.
+> 4. **Rich text pasting**: If you copy some content from websites or apps, and want to paste it into the app.
+> 5. **SEO**: In case you want to use HTML for SEO support.
+
 ## 📝 Spelling checker
 
 This feature is currently not implemented and is being planned. Refer to [#2246](https://github.com/singerdmx/flutter-quill/issues/2246)
@@ -357,7 +340,7 @@ The plugin [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge)
 
 ## ✂️ Shortcut events
 
-We can customize some Shorcut events, using the parameters `characterShortcutEvents` or `spaceShortcutEvents` from `QuillEditorConfigurations` to add more functionality to our editor. 
+We can customize some Shorcut events, using the parameters `characterShortcutEvents` or `spaceShortcutEvents` from `QuillEditorConfig` to add more functionality to the editor. 
 
 > [!NOTE]
 >
@@ -367,16 +350,16 @@ To see an example of this, you can check [customizing_shortcuts](./doc/customizi
 
 ## 🌐 Translation
 
-The package offers translations for the quill toolbar and editor, it will follow the system locale unless you set your
+The package offers translations for the toolbar and editor widgets, it will follow the system locale unless you set your
 own locale.
 
-Open this [page](./doc/translation.md) for more info
+See the [translation](./doc/translation.md) page for more info
 
 ## 🧪 Testing
 
 Take a look at [flutter_quill_test](https://pub.dev/packages/flutter_quill_test) for testing.
 
-Notice that currently, the support for testing is limited.
+Currently, the support for testing is limited.
 
 ## 🤝 Contributing
 

doc/attribute_introduction.md

@@ -91,16 +91,16 @@ class HighlightAttr extends Attribute<bool?> {
 
 ##### Where should we add this `HighlightAttr`?
 
-On `QuillEditor` or `QuillEditorConfigurations` **doesn't exist** a param that let us pass our `Attribute`
-implementations. To make this more easy, we can use just `customStyleBuilder` param from `QuillEditorConfigurations`,
+On `QuillEditor` or `QuillEditorConfig` **doesn't exist** a param that let us pass our `Attribute`
+implementations. To make this more easy, we can use just `customStyleBuilder` param from `QuillEditorConfig`,
 that let us define a function to return a `TextStyle`. With this, we can define now our `HighlightAttr`
 
 ##### The editor
 
 ```dart
 QuillEditor.basic(
       controller: controller,
-      configurations: QuillEditorConfigurations(
+      config: QuillEditorConfig(
         customStyleBuilder: (Attribute<dynamic> attribute) {
           if (attribute.key.equals(highlightKey)) {
             return TextStyle(color: Colors.black, backgroundColor: Colors.yellow);

doc/configurations/custom_buttons.md

@@ -1,18 +1,17 @@
-# Custom `QuillToolbar` Buttons ✨
+# Custom `QuillSimpleToolbar` Buttons ✨
 
 You may add custom buttons to the _end_ of the toolbar, via the `customButtons` option, which is a `List`
 of `QuillToolbarCustomButtonOptions`.
 
 ## Adding an Icon 🖌️
 
-To add an Icon, we should use a new `QuillToolbarCustomButtonOptions` class
+To add an Icon:
 
 ```dart
     QuillToolbarCustomButtonOptions(
         icon: const Icon(Icons.ac_unit),
-        tooltip: '',
+        tooltip: 'Tooltip',
         onPressed: () {},
-        afterButtonPressed: () {},
       ),
 ```
 
@@ -21,9 +20,9 @@ To add an Icon, we should use a new `QuillToolbarCustomButtonOptions` class
 Each `QuillCustomButton` is used as part of the `customButtons` option as follows:
 
 ```dart
-QuillToolbar.simple(
+QuillSimpleToolbar(
   controller: _controller,
-  configurations: QuillSimpleToolbarConfigurations(
+  config: QuillSimpleToolbarConfig(
     customButtons: [
       QuillToolbarCustomButtonOptions(
         icon: const Icon(Icons.ac_unit),

doc/configurations/font_size.md

@@ -1,19 +1,34 @@
 # 🔠 Font Size
 
 Within the editor toolbar, a drop-down with font-sizing capabilities is available.
-This can be enabled or disabled
-with `showFontSize`.
+This can be enabled or disabled with `showFontSize`.
 
-When enabled, the default font-size values can be modified via _optional_ `fontSizeValues`.
+When enabled, the default font-size values can be modified via _optional_ `rawItemsMap`.
 Accepts a `Map<String, String>` consisting of a `String` title for the font size and a `String` value for the font size.
 Example:
 
 ```dart
-fontSizeValues: const {'Small': '8', 'Medium': '24.5', 'Large': '46'}
+QuillSimpleToolbar(
+    config: const QuillSimpleToolbarConfig(
+      buttonOptions: QuillSimpleToolbarButtonOptions(
+        fontSize: QuillToolbarFontSizeButtonOptions(
+          items: {'Small': '8', 'Medium': '24.5', 'Large': '46'},
+        ),
+      ),
+    ),
+  );
 ```
 
 Font size can be cleared with a value of `0`, for example:
 
 ```dart
-fontSizeValues: const {'Small': '8', 'Medium': '24.5', 'Large': '46', 'Clear': '0'}
+QuillSimpleToolbar(
+    config: const QuillSimpleToolbarConfig(
+      buttonOptions: QuillSimpleToolbarButtonOptions(
+        fontSize: QuillToolbarFontSizeButtonOptions(
+          items: {'Small': '8', 'Medium': '24.5', 'Large': '46', 'Clear': '0'},
+        ),
+      ),
+    ),
+  );
 ```

doc/configurations/localizations_setup.md

@@ -1,31 +1,14 @@
 # 🌍 Localizations Setup
 
-In addition to the required delegates mentioned above in [Using custom app widget](./using_custom_app_widget.md),
-which are:
+The required localization delegates:
 
 ```dart
 localizationsDelegates: const [
     DefaultCupertinoLocalizations.delegate,
     DefaultMaterialLocalizations.delegate,
     DefaultWidgetsLocalizations.delegate,
-],
+    FlutterQuillLocalizations.delegate,
+]
 ```
 
-Which are used by Flutter widgets.
-
-📌 Note: The library also needs the `FlutterQuillLocalizations.delegate`:
-
-```dart
-// Required localizations delegates ...
-FlutterQuillLocalizations.delegate
-```
-
-**You don't have to add this explicitly** because we have wrapped the `QuillEditor` and `QuillToolbar` with
-`FlutterQuillLocalizationsWidget`.
-This widget will check if the necessary localizations are set; if not, it will
-provide them only for these widgets.
-Therefore, it's not strictly required.
-However, if you are overriding the
-`localizationsDelegates`, you can also add the `FlutterQuillLocalizations.delegate`.
-
 📄 For additional notes, refer to the [Translation](../translation.md) section.

doc/configurations/search.md

@@ -7,13 +7,13 @@ Use the 3 vertical dots icon to turn on case-sensitivity or whole word constrain
 ## Search configuration options
 
 By default, the content of Embed objects are not searched.
-You can enable search by setting the [searchEmbedMode] in searchConfigurations:
+You can enable search by setting the [searchEmbedMode] in `searchConfig`:
 
 ```dart
-    MyQuillEditor(
+    QuillEditor.basic(
       controller: _controller,
-      configurations: QuillEditorConfigurations(
-        searchConfigurations: const QuillSearchConfigurations(
+      config: QuillEditorConfig(
+        searchConfig: const QuillSearchConfig(
           searchEmbedMode: SearchEmbedMode.plainText,
         ),
       ),

doc/configurations/using_custom_app_widget.md

@@ -16,19 +16,5 @@ localizationsDelegates: const [
 ],
 ```
 
+📄 For additional notes, see the [localizations setup](./localizations_setup.md) page.
 
-You might need more depending on your use case. For example, if you are using custom localizations for your app with a custom app widget like `FluentApp` from [FluentUI], you will also need:
-
-```dart
-localizationsDelegates: const [
-    // Required localizations delegates ...
-    FluentLocalizations.delegate,
-    AppLocalizations.delegate,
-],
-```
-
-📌 Note: In recent versions of `FluentApp`, you no longer need to add the `localizationsDelegates`. This is just an example. For more information, refer to the [#946](https://github.com/bdlukaa/fluent_ui/pull/946).
-
-📄 For additional notes, see the [Localizations](./localizations_setup.md) page.
-
-[FluentUI]: https://pub.dev/packages/fluent_ui