flutter_quill_extensions 11.0.0-dev.2

Embed extensions for flutter_quill including image, video, formula and etc.

Flutter Quill Extensions

An extension for flutter_quill to support embedding widgets images, and videos.

📚 Table of Contents

• 📝 About
• 📦 Installation
• 🛠 Platform Setup
• 🚀 Usage
• ⚙️ Configurations
• 🤝 Contributing

📝 About

flutter_quill is a rich editor text. It has custom embed builders that allow you to render custom widgets in the editor

This is an extension to extend its functionalities by adding more features like images, videos, and more

📦 Installation

Follow the usage instructions of flutter_quill.

Add the flutter_quill_extensions dependency to your project:

dependencies:
  flutter_quill_extensions: ^<latest-version-here>

OR

dependencies:
  flutter_quill_extensions:
    git:
      url: https://github.com/singerdmx/flutter-quill.git
      ref: v<latest-version-here>
      path: flutter_quill_extensions

🛠 Platform Setup

The package uses the following plugins:

1. gal to save images. Ensure to follow the gal setup guide as it requires platform-specific setup.
2. image_picker for picking images. See the image_picker installation section.
3. video_player for playing videos. See the video_player setup section.

Loading Images from the Internet

Android

1. Add the necessary permissions to your AndroidManifest.xml. For detailed instructions, refer to the Android Guide or Flutter Networking. Note that internet permission is included by default only for debugging; you must explicitly add it for release versions.

2. To restrict image and video loading to HTTPS only, configure your app accordingly. If you need to support HTTP, you must adjust your app settings for release mode. Consult the Android Cleartext / Plaintext HTTP guide for more information.

macOS

Include a key in your Info.plist file to enable internet access. For detailed steps, follow the instructions in the Flutter macOS Networking documentation.

🚀 Usage

Once you follow the Installation section. Set the embedBuilders and embedToolbar params in configurations of QuillEditor and QuillSimpleToolbar.

Quill Toolbar:

QuillSimpleToolbar(
  config: QuillSimpleToolbarConfig(
    embedButtons: FlutterQuillEmbeds.toolbarButtons(),
  ),
),

Quill Editor:

Expanded(
  child: QuillEditor.basic(
    config: QuillEditorConfig(
      embedBuilders: kIsWeb ? FlutterQuillEmbeds.editorWebBuilders() : FlutterQuillEmbeds.editorBuilders(),
    ),
  ),
)

⚙️ Configurations

📦 Embed Blocks

The flutter_quill provides an interface for all the users to provide their implementations for embed blocks.

Implementations for image, video embed blocks are provided in this package.

The instructions for using the embed blocks are in the Usage section.

🔍 Element properties

Currently, the library has limited support for the image and video properties, and it supports only width, height, margin

{
  "insert": {
    "image": "https://user-images.githubusercontent.com/122956/72955931-ccc07900-3d52-11ea-89b1-d468a6e2aa2b.png"
  },
  "attributes": {
    "style": "width: 50px; height: 50px; margin: 10px;"
  }
}

🔧 Custom Element properties

Doesn't apply to official Quill JS

Define flutterAlignment` as follows:

{
  "insert": {
    "image": "https://user-images.githubusercontent.com/122956/72955931-ccc07900-3d52-11ea-89b1-d468a6e2aa2b.png"
  },
  "attributes": {
    "style": "flutterAlignment: topLeft"
  }
}

This works only for non-web platforms.

🖼️ Image Assets

To support loading image assets in the editor:

FlutterQuillEmbeds.editorBuilders(
    imageEmbedConfig:
        QuillEditorImageEmbedConfig(
      imageProviderBuilder: (context, imageUrl) {
        if (imageUrl.startsWith('assets/')) {
          return AssetImage(imageUrl);
        }
        return null;
      },
    ),  
)

Ensures to replace assets with your assets directory name or change the logic to fit your needs.

🤝 Contributing

We greatly appreciate your time and effort.

To keep the project consistent and maintainable, we have a few guidelines that we ask all contributors to follow. These guidelines help ensure that everyone can understand and work with the code easier.

See Contributing for more details.