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

feat!: release version 11.0.0 with breaking changes #2338

Merged
merged 99 commits into from
Nov 9, 2024
Merged

Conversation

EchoEllet
Copy link
Collaborator

@EchoEllet EchoEllet commented Oct 27, 2024

Description

Prepare version 11.0.0 and introduce breaking changes, and cleanup with no new features.

To try the new version before it is released:

dependency_overrides:
  flutter_quill:
    git:
      url: https://github.com/singerdmx/flutter-quill.git
      ref: release/v11
  flutter_quill_extensions:
    git:
      url: https://github.com/singerdmx/flutter-quill.git
      ref: release/v11
      path: flutter_quill_extensions

See the migration guide to migrate from 10.0.0 to 11.0.0.

Related Issues

Type of Change

  • New feature: Adds new functionality without breaking existing features.
  • 🛠️ Bug fix: Resolves an issue without altering current behavior.
  • 🧹 Code refactor: Code restructuring that does not affect behavior.
  • Breaking change: Alters existing functionality and requires updates.
  • 🧪 Tests: Adds new tests or modifies existing tests.
  • 📝 Documentation: Updates or additions to documentation.
  • 🗑️ Chore: Routine tasks, or maintenance.
  • Build configuration change: Changes to build or deploy processes.

…oolbar and editor provider widgets, other minor breaking changes
…recated support for YouTube in flutter_quill_extensions and other minor breaking changes
…tate even if dirty is already true (revert to old behavior)
…pdates in editor config, rename isOnTapOutsideEnabled to onTapOutsideEnabled
…ctory models to config in flutter_quill_extensions
@EchoEllet
Copy link
Collaborator Author

It's time to review and merge this PR into master, but not yet publish it as stable. I want more user feedback and I'm considering changes like disabling rich text paste by default (can be enabled with one line, see #2350) and reintroducing spell check as experimental (removed in v11).

To summary our discussion:

QuillToolbar class no longer exists

The QuillToolbar was used to create a custom toolbar while being able to use the buttons of flutter_quill, now it's no longer required and users can use the buttons directly, it has been removed. The docs has been updated to clarify this.

Quill Toolbar no longer works

It work as before, no changes were introduced, the only minor breaking change that introduced is not requesting the keyboard focus by default, and that has been already documented before, the migration guide has been updated to provide code snippets to revert on both custom and simple toolbar.

I used the original class in my app to create a custom toolbar specifically for desktop.
I do not use the QuillSimpleToolbar as it is not suitable for my desktop application.
The loss of the base implementation means I have to resurrect the old flutter quill code and create my own class.
This is a major inconvenience!

It has been restored to make the migration smoother and it supports the custom button embed too (integrate with flutter_quill_extensions's buttons).

The pre-release has been published again on pub.dev

@EchoEllet
Copy link
Collaborator Author

EchoEllet commented Nov 9, 2024

This PR focuses on breaking changes and prioritizes issues needed in a major release.

Other changes will be addressed separately before publishing the stable release of v11.

Most changes are minor, primarily removals (e.g., CHANGELOG.md files, examples). It's not final though I don't expect new bugs.

Two minor questions:

@EchoEllet EchoEllet merged commit 2999c0d into master Nov 9, 2024
3 checks passed
@EchoEllet EchoEllet deleted the release/v11 branch November 9, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change This change introduces an incompatibility that requires adjustments in dependent code or packages, a
Projects
None yet
4 participants