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

Inconsistency in parameters between QuillController, QuillControllerConfigurations, QuillEditor, QuillEditorConfigurations #2298

Open
EchoEllet opened this issue Sep 29, 2024 · 0 comments
Labels
enhancement New feature or request major Significant impact on the user experience or performance. This issue should be addressed in the next

Comments

@EchoEllet
Copy link
Collaborator

EchoEllet commented Sep 29, 2024

I tried updating an old app (for testing purposes) that uses flutter_quill, and while updating from version 9.0.0 to 9.5.10 and then to 10.0.0 I can see why the question in #2094 is asked.

We're developing the project without getting any feedback from users.

There are inconsistency issues and breaking change issues made in minor versions, see comment in #2097 for more details.

For this issue, those two PRs #1843 and #1843 have changes that are inconsistent with each other since we didn't take much time to review those PRs

https://github.com/singerdmx/flutter-quill/blob/master/lib/src/controller/quill_controller.dart#L26-L39

https://github.com/singerdmx/flutter-quill/blob/master/lib/src/controller/quill_controller_configurations.dart#L4-L25

https://github.com/singerdmx/flutter-quill/blob/master/lib/src/editor/editor.dart#L184-L192

https://github.com/singerdmx/flutter-quill/blob/master/lib/src/editor/config/editor_configurations.dart#L42

I haven't taken the time to discover all potential issues though noticed:

  • checkBoxReadOnly exists in QuillRawEditorConfigurations and QuillEditorConfigurations while readOnly in QuillController
  • readOnly exists directly in QuillController but not when using QuillController.basic and QuillControllerConfigurations seems to exist to hold some parameters but not others, which is very random
  • readOnly was already possible when using QuillController.basic by passing it into the editor in 9.3.0 though it was decided to remove however we should have made a discussion before we made different changes which are against each other
  • Some other issues that I couldn't keep track of, I can see why users are often having headaches when using the project even without upgrading it (pub will always use the latest minor version) and we're not documenting much clearly. I didn't see those issues previously because I didn't use the package for about a year or at least 10 months. Users are not reporting those kinds of issues. We have all made mistakes and we will be responsible for them.
@EchoEllet EchoEllet added enhancement New feature or request major Significant impact on the user experience or performance. This issue should be addressed in the next labels Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request major Significant impact on the user experience or performance. This issue should be addressed in the next
Projects
None yet
Development

No branches or pull requests

1 participant