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

refactor!: restructure project into modular architecture for flutter_quill_extensions #2106

Merged
merged 3 commits into from
Aug 14, 2024

Conversation

EchoEllet
Copy link
Collaborator

@EchoEllet EchoEllet commented Aug 13, 2024

Description

This PR is identical to #2032 for flutter_quill_extensions

This will be a breaking change for users who import files directly, import the extensions package using:

import 'package:flutter_quill_extensions/flutter_quill_extensions.dart';

Some files are not exported and are available as public API.

So to use them you have to import the file and ignore the warning manually:

// ignore: implementation_imports
import 'package:flutter_quill_extensions/src/editor/image/widgets/image.dart'
    show getImageProviderByImageSource, imageFileExtensions;

Keep in mind the APIs that are not exposed in public are not stable, and could be removed or changed at any time.

This PR has other minor breaking changes.

The following APIs have been removed:

  • QuillEditorUnknownEmbedBuilder: this embed/widget shows a text indicating this embed is unknown instead of showing an error. You can create your own and use unknownEmbedBuilder.
  • The deprecated parameter mediaButtonOptions in the static function FlutterQuillEmbeds.toolbarButtons: since the media button has been removed for a while.

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.

@EchoEllet EchoEllet changed the title refactor: restructure project into modular architecture for flutter_quill_extensions refactor!: restructure project into modular architecture for flutter_quill_extensions Aug 13, 2024
@EchoEllet EchoEllet marked this pull request as ready for review August 14, 2024 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants