GitHub - hm21/pro_image_editor: The pro_image_editor is a Flutter widget designed for image editing within your application. It provides a flexible and convenient way to integrate image editing capabilities into your Flutter project.

The ProImageEditor is a Flutter widget designed for image editing within your application. It provides a flexible and convenient way to integrate image editing capabilities into your Flutter project.

Demo Website

Preview

Grounded-Design	Frosted-Glass-Design

WhatsApp-Design	Paint-Editor

Text-Editor	Crop-Rotate-Editor

Filter-Editor	Emoji-Editor

Sticker/ Widget Editor	Blur-Editor

Features

✅ Multiple-Editors
- ✅ Paint-Editor
  - ✅ Color picker
  - ✅ Multiple forms like arrow, rectangle, circle and freestyle
- ✅ Text-Editor
  - ✅ Color picker
  - ✅ Align-Text => left, right and center
  - ✅ Change Text Scale
  - ✅ Multiple background modes like in whatsapp
- ✅ Crop-Rotate-Editor
  - ✅ Rotate
  - ✅ Flip
  - ✅ Multiple aspect ratios
  - ✅ Reset
  - ✅ Double-Tap
  - ✅ Round cropper
- ✅ Filter-Editor
- ✅ Blur-Editor
- ✅ Emoji-Picker
- ✅ Sticker-Editor
✅ Multi-Threading
- ✅ Use isolates for background tasks on Dart native devices
- ✅ Use web-workers for background tasks on Dart web devices
- ✅ Automatically set the number of active background processors based on the device
- ✅ Manually set the number of active background processors
✅ Undo and redo function
✅ Use your image directly from memory, asset, file or network
✅ Each icon can be changed
✅ Any text can be translated "i18n"
✅ Many custom configurations for each subeditor
✅ Custom theme for each editor
✅ Selectable design mode between Material and Cupertino
✅ Reorder layer level
✅ Movable background image
✅ WhatsApp Theme
✅ Frosted-Glass Theme
✅ Interactive layers
✅ Helper lines for better positioning
✅ Hit detection for painted layers
✅ Zoomable paint and main editor
✅ Improved layer movement and scaling functionality for desktop devices

Planned features

✨ Paint-Editor
- New mode which pixelates the background
- Freestyle-Painter with improved performance and hitbox
✨ Text-Editor
- Text-layer with an improved hit-box and ensure it's vertically centered on all devices
✨ Emoji-Editor
- Preload emojis in web platforms
✨ AI Futures => Perhaps integrating Adobe Firefly

Getting started

Android

To enable smooth hit vibrations from a helper line, you need to add the VIBRATE permission to your AndroidManifest.xml file.

<uses-permission android:name="android.permission.VIBRATE"/>

OpenHarmony

To enable smooth hit vibrations from a helper line, you need to add the VIBRATE permission to your project's module.json5 file.

"requestPermissions": [
    {"name" :  "ohos.permission.VIBRATE"},                
]

Web

If you're displaying emoji on the web and want them to be colored by default (especially if you're not using a custom font like Noto Emoji), you can achieve this by adding the useColorEmoji: true parameter to your flutter_bootstrap.js file, as shown in the code snippet below:

Show code example

{{flutter_js}}
{{flutter_build_config}}

_flutter.loader.load({
    serviceWorkerSettings: {
        serviceWorkerVersion: {{flutter_service_worker_version}},
    },
    onEntrypointLoaded: function (engineInitializer) {
      engineInitializer.initializeEngine({
        useColorEmoji: true, // add this parameter
        renderer: 'canvaskit'
      }).then(function (appRunner) {
        appRunner.runApp();
      });
    }
});

The HTML renderer can cause problems on some devices, especially mobile devices. If you don't know the exact type of phone your customers will be using, it is recommended to use the Canvas renderer.

To enable the Canvaskit renderer by default for better compatibility with mobile web devices, you can do the following in your flutter_bootstrap.js file.

Show code example

{{flutter_js}}
{{flutter_build_config}}

_flutter.loader.load({
    serviceWorkerSettings: {
        serviceWorkerVersion: {{flutter_service_worker_version}},
    },
    onEntrypointLoaded: function (engineInitializer) {
      engineInitializer.initializeEngine({
        useColorEmoji: true,
        renderer: 'canvaskit' // add this parameter
      }).then(function (appRunner) {
        appRunner.runApp();
      });
    }
});

By making this change, you can enhance filter compatibility and ensure a smoother experience on older Android phones and various mobile web devices.
You can view the full web example here.

iOS, macOS, Linux, Windows

No further action is required.

Usage

Import first the image editor like below:

import 'package:pro_image_editor/pro_image_editor.dart';

Open the editor in a new page

void _openEditor() {
  Navigator.push(
    context,
    MaterialPageRoute(
      builder: (context) => ProImageEditor.network(
        'https://picsum.photos/id/237/2000',
        callbacks: ProImageEditorCallbacks(
          onImageEditingComplete: (Uint8List bytes) async {
            /*
              Your code to handle the edited image. Upload it to your server as an example.
              You can choose to use await, so that the loading-dialog remains visible until your code is ready, or no async, so that the loading-dialog closes immediately.
              By default, the bytes are in `jpg` format.
            */
            Navigator.pop(context);
          },
        ),
      ),
    ),
  );
}

Show the editor inside of a widget

@override
Widget build(BuildContext context) {
    return Scaffold(
        body: ProImageEditor.network(
          'https://picsum.photos/id/237/2000',
           callbacks: ProImageEditorCallbacks(
             onImageEditingComplete: (Uint8List bytes) async {
               /*
                 Your code to handle the edited image. Upload it to your server as an example.
                 You can choose to use await, so that the loading-dialog remains visible until your code is ready, or no async, so that the loading-dialog closes immediately.
                 By default, the bytes are in `jpg` format.
                */
               Navigator.pop(context);
             },
          ),
        ),
    );
}

Own stickers or widgets

To display stickers or widgets in the ProImageEditor, you have the flexibility to customize and load your own content. The buildStickers method allows you to define your own logic for loading stickers, whether from a backend, assets, or local storage, and then push them into the editor. The example here demonstrates how to load images that can serve as stickers and then add them to the editor.

Frosted-Glass design

To use the "Frosted-Glass-Design" you can follow the example here

WhatsApp design

The image editor offers a WhatsApp-themed option that mirrors the popular messaging app's design. The editor also follows the small changes that exist in the Material (Android) and Cupertino (iOS) version.

You can see the complete example here

Highly configurable

Customize the image editor to suit your preferences. Of course, each class like I18nTextEditor includes more configuration options.

Show code example

return Scaffold(
    appBar: AppBar(
      title: const Text('Pro-Image-Editor')
    ),
    body: ProImageEditor.network(
        'https://picsum.photos/id/237/2000',
            key: _editor,
            callbacks: ProImageEditorCallbacks(
              onImageEditingComplete: (Uint8List bytes) async {
                /*
                  Your code to handle the edited image. Upload it to your server as an example.
                  You can choose to use await, so that the loading-dialog remains visible until your code is ready, or no async, so that the loading-dialog closes immediately.
                  By default, the bytes are in `jpg` format.
                */
                Navigator.pop(context);
              },
            ),
            configs: ProImageEditorConfigs(
              activePreferredOrientations: [
                  DeviceOrientation.portraitUp,
                  DeviceOrientation.portraitDown,
                  DeviceOrientation.landscapeLeft,
                  DeviceOrientation.landscapeRight,
              ],
              i18n: const I18n(
                  various: I18nVarious(),
                  paintEditor: I18nPaintEditor(),
                  textEditor: I18nTextEditor(),
                  cropRotateEditor: I18nCropRotateEditor(),
                  filterEditor: I18nFilterEditor(filters: I18nFilters()),
                  emojiEditor: I18nEmojiEditor(),
                  stickerEditor: I18nStickerEditor(),
                  // More translations...
              ),
              helperLines: const HelperLines(
                  showVerticalLine: true,
                  showHorizontalLine: true,
                  showRotateLine: true,
                  hitVibration: true,
              ),
              customWidgets: const ProImageEditorCustomWidgets(),
              imageEditorTheme: const ImageEditorTheme(
                  layerHoverCursor: SystemMouseCursors.move,
                  helperLine: HelperLineTheme(
                      horizontalColor: Color(0xFF1565C0),
                      verticalColor: Color(0xFF1565C0),
                      rotateColor: Color(0xFFE91E63),
                  ),
                  paintEditor: PaintEditorTheme(),
                  textEditor: TextEditorTheme(),
                  cropRotateEditor: CropRotateEditorTheme(),
                  filterEditor: FilterEditorTheme(),
                  emojiEditor: EmojiEditorTheme(),
                  stickerEditor: StickerEditorTheme(),
                  background: Color.fromARGB(255, 22, 22, 22),
                  loadingDialogTextColor: Color(0xFFE1E1E1),
                  uiOverlayStyle: SystemUiOverlayStyle(
                  statusBarColor: Color(0x42000000),
                  statusBarIconBrightness: Brightness.light,
                  systemNavigationBarIconBrightness: Brightness.light,
                  statusBarBrightness: Brightness.dark,
                  systemNavigationBarColor: Color(0xFF000000),
                  ),
              ),
              icons: const ImageEditorIcons(
                  paintEditor: IconsPaintEditor(),
                  textEditor: IconsTextEditor(),
                  cropRotateEditor: IconsCropRotateEditor(),
                  filterEditor: IconsFilterEditor(),
                  emojiEditor: IconsEmojiEditor(),
                  stickerEditor: IconsStickerEditor(),
                  closeEditor: Icons.clear,
                  doneIcon: Icons.done,
                  applyChanges: Icons.done,
                  backButton: Icons.arrow_back,
                  undoAction: Icons.undo,
                  redoAction: Icons.redo,
                  removeElementZone: Icons.delete_outline_rounded,
              ),
              paintEditorConfigs: const PaintEditorConfigs(),
              textEditorConfigs: const TextEditorConfigs(),
              cropRotateEditorConfigs: const CropRotateEditorConfigs(),
              filterEditorConfigs: FilterEditorConfigs(),
              emojiEditorConfigs: const EmojiEditorConfigs(),
              stickerEditorConfigs: StickerEditorConfigs(
                enabled: true,
                buildStickers: (setLayer) {
                  return ClipRRect(
                    borderRadius: const BorderRadius.vertical(top: Radius.circular(20)),
                    child: Container(
                      color: const Color.fromARGB(255, 224, 239, 251),
                      child: GridView.builder(
                        padding: const EdgeInsets.all(16),
                        gridDelegate: const SliverGridDelegateWithMaxCrossAxisExtent(
                          maxCrossAxisExtent: 150,
                          mainAxisSpacing: 10,
                          crossAxisSpacing: 10,
                        ),
                        itemCount: 21,
                        shrinkWrap: true,
                        itemBuilder: (context, index) {
                          Widget widget = ClipRRect(
                            borderRadius: BorderRadius.circular(7),
                            child: Image.network(
                              'https://picsum.photos/id/${(index + 3) * 3}/2000',
                              width: 120,
                              height: 120,
                              fit: BoxFit.cover,
                            ),
                          );
                          return GestureDetector(
                            onTap: () => setLayer(widget),
                            child: MouseRegion(
                              cursor: SystemMouseCursors.click,
                              child: widget,
                            ),
                          );
                        },
                      ),
                    ),
                  );
                },
              ),
              designMode: ImageEditorDesignModeE.material,
              heroTag: 'hero',
              theme: ThemeData(
                  useMaterial3: true,
                  colorScheme: ColorScheme.fromSeed(
                  seedColor: Colors.blue.shade800,
                  brightness: Brightness.dark,
                  ),
              ),
        ),
    )
);

Custom AppBar

Customize the AppBar with your own widgets. The same is also possible with the BottomBar.

Show code example

import 'dart:async';

import 'package:flutter/material.dart';
import 'package:pro_image_editor/pro_image_editor.dart';

class Demo extends StatefulWidget {
  const Demo({super.key});

  @override
  State<Demo> createState() => DemoState();
}

class DemoState extends State<Demo> {
  final _editorKey = GlobalKey<ProImageEditorState>();
  late StreamController _updateAppBarStream;

  @override
  void initState() {
    _updateAppBarStream = StreamController.broadcast();
    super.initState();
  }

  @override
  void dispose() {
    _updateAppBarStream.close();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return ProImageEditor.network(
      'https://picsum.photos/id/237/2000',
      key: _editorKey,
      callbacks: ProImageEditorCallbacks(
        onImageEditingComplete: (Uint8List bytes) async {
          /*
            Your code to handle the edited image. Upload it to your server as an example.
            You can choose to use await, so that the loading-dialog remains visible until your code is ready, or no async, so that the loading-dialog closes immediately.
            By default, the bytes are in `jpg` format.
          */
          Navigator.pop(context);
        },
        onUpdateUI: () {
          _updateAppBarStream.add(null);
        },
      ),
      configs: ProImageEditorConfigs(
        customWidgets: ImageEditorCustomWidgets(
          appBar: AppBar(
            automaticallyImplyLeading: false,
            foregroundColor: Colors.white,
            backgroundColor: Colors.black,
            actions: [
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      tooltip: 'Cancel',
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: const Icon(Icons.close),
                      onPressed: _editorKey.currentState?.closeEditor,
                    );
                  }),
              const Spacer(),
              IconButton(
                tooltip: 'Custom Icon',
                padding: const EdgeInsets.symmetric(horizontal: 8),
                icon: const Icon(
                  Icons.bug_report,
                  color: Colors.white,
                ),
                onPressed: () {},
              ),
              StreamBuilder(
                stream: _updateAppBarStream.stream,
                builder: (_, __) {
                  return IconButton(
                    tooltip: 'Undo',
                    padding: const EdgeInsets.symmetric(horizontal: 8),
                    icon: Icon(
                      Icons.undo,
                      color: _editorKey.currentState?.canUndo == true ? Colors.white : Colors.white.withAlpha(80),
                    ),
                    onPressed: _editorKey.currentState?.undoAction,
                  );
                },
              ),
              StreamBuilder(
                stream: _updateAppBarStream.stream,
                builder: (_, __) {
                  return IconButton(
                    tooltip: 'Redo',
                    padding: const EdgeInsets.symmetric(horizontal: 8),
                    icon: Icon(
                      Icons.redo,
                      color: _editorKey.currentState?.canRedo == true ? Colors.white : Colors.white.withAlpha(80),
                    ),
                    onPressed: _editorKey.currentState?.redoAction,
                  );
                },
              ),
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      tooltip: 'Done',
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: const Icon(Icons.done),
                      iconSize: 28,
                      onPressed: _editorKey.currentState?.doneEditing,
                    );
                  }),
            ],
          ),
          appBarPaintEditor: AppBar(
            automaticallyImplyLeading: false,
            foregroundColor: Colors.white,
            backgroundColor: Colors.black,
            actions: [
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: const Icon(Icons.arrow_back),
                      onPressed: _editorKey.currentState?.paintEditor.currentState?.close,
                    );
                  }),
              const SizedBox(width: 80),
              const Spacer(),
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: const Icon(
                        Icons.line_weight_rounded,
                        color: Colors.white,
                      ),
                      onPressed: _editorKey.currentState?.paintEditor.currentState?.openLineWeightBottomSheet,
                    );
                  }),
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                        padding: const EdgeInsets.symmetric(horizontal: 8),
                        icon: Icon(
                          _editorKey.currentState?.paintEditor.currentState?.fillBackground == true
                              ? Icons.format_color_reset
                              : Icons.format_color_fill,
                          color: Colors.white,
                        ),
                        onPressed: _editorKey.currentState?.paintEditor.currentState?.toggleFill);
                  }),
              const Spacer(),
              IconButton(
                tooltip: 'Custom Icon',
                padding: const EdgeInsets.symmetric(horizontal: 8),
                icon: const Icon(
                  Icons.bug_report,
                  color: Colors.white,
                ),
                onPressed: () {},
              ),
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      tooltip: 'Undo',
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: Icon(
                        Icons.undo,
                        color: _editorKey.currentState?.paintEditor.currentState?.canUndo == true ? Colors.white : Colors.white.withAlpha(80),
                      ),
                      onPressed: _editorKey.currentState?.paintEditor.currentState?.undoAction,
                    );
                  }),
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      tooltip: 'Redo',
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: Icon(
                        Icons.redo,
                        color: _editorKey.currentState?.paintEditor.currentState?.canRedo == true ? Colors.white : Colors.white.withAlpha(80),
                      ),
                      onPressed: _editorKey.currentState?.paintEditor.currentState?.redoAction,
                    );
                  }),
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      tooltip: 'Done',
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: const Icon(Icons.done),
                      iconSize: 28,
                      onPressed: _editorKey.currentState?.paintEditor.currentState?.done,
                    );
                  }),
            ],
          ),
          appBarTextEditor: AppBar(
            automaticallyImplyLeading: false,
            backgroundColor: Colors.black,
            foregroundColor: Colors.white,
            actions: [
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: const Icon(Icons.arrow_back),
                      onPressed: _editorKey.currentState?.textEditor.currentState?.close,
                    );
                  }),
              const Spacer(),
              IconButton(
                tooltip: 'Custom Icon',
                padding: const EdgeInsets.symmetric(horizontal: 8),
                icon: const Icon(
                  Icons.bug_report,
                  color: Colors.white,
                ),
                onPressed: () {},
              ),
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      onPressed: _editorKey.currentState?.textEditor.currentState?.toggleTextAlign,
                      icon: Icon(
                        _editorKey.currentState?.textEditor.currentState?.align == TextAlign.left
                            ? Icons.align_horizontal_left_rounded
                            : _editorKey.currentState?.textEditor.currentState?.align == TextAlign.right
                                ? Icons.align_horizontal_right_rounded
                                : Icons.align_horizontal_center_rounded,
                      ),
                    );
                  }),
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      onPressed: _editorKey.currentState?.textEditor.currentState?.toggleBackgroundMode,
                      icon: const Icon(Icons.layers_rounded),
                    );
                  }),
              const Spacer(),
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: const Icon(Icons.done),
                      iconSize: 28,
                      onPressed: _editorKey.currentState?.textEditor.currentState?.done,
                    );
                  }),
            ],
          ),
          appBarCropRotateEditor: AppBar(
            automaticallyImplyLeading: false,
            backgroundColor: Colors.black,
            foregroundColor: Colors.white,
            actions: [
                StreamBuilder(
                stream: _updateUIStream.stream,
                builder: (_, __) {
                  return IconButton(
                    padding: const EdgeInsets.symmetric(horizontal: 8),
                    icon: const Icon(Icons.arrow_back),
                    onPressed: editorKey.currentState?.cropRotateEditor.currentState?.close,
                  );
                }),
                const Spacer(),
                IconButton(
                  tooltip: 'My Button',
                  color: Colors.amber,
                  padding: const EdgeInsets.symmetric(horizontal: 8),
                  icon: const Icon(
                    Icons.bug_report,
                    color: Colors.amber,
                  ),
                  onPressed: () {},
                ),
                StreamBuilder(
                    stream: _updateUIStream.stream,
                    builder: (_, __) {
                      return IconButton(
                        tooltip: 'Undo',
                        padding: const EdgeInsets.symmetric(horizontal: 8),
                        icon: Icon(
                          Icons.undo,
                          color: editorKey.currentState!.cropRotateEditor.currentState!.canUndo ? Colors.white : Colors.white.withAlpha(80),
                        ),
                        onPressed: editorKey.currentState!.cropRotateEditor.currentState!.undoAction,
                      );
                    }),
                StreamBuilder(
                    stream: _updateUIStream.stream,
                    builder: (_, __) {
                      return IconButton(
                        tooltip: 'Redo',
                        padding: const EdgeInsets.symmetric(horizontal: 8),
                        icon: Icon(
                          Icons.redo,
                          color: editorKey.currentState!.cropRotateEditor.currentState!.canRedo ? Colors.white : Colors.white.withAlpha(80),
                        ),
                        onPressed: editorKey.currentState!.cropRotateEditor.currentState!.redoAction,
                      );
                    }),
                StreamBuilder(
                    stream: _updateUIStream.stream,
                    builder: (_, __) {
                      return IconButton(
                        padding: const EdgeInsets.symmetric(horizontal: 8),
                        icon: const Icon(Icons.done),
                        iconSize: 28,
                        onPressed: editorKey.currentState!.cropRotateEditor.currentState!.done,
                      );
                    }),
            ],
          ),
          appBarFilterEditor: AppBar(
            automaticallyImplyLeading: false,
            backgroundColor: Colors.black,
            foregroundColor: Colors.white,
            actions: [
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: const Icon(Icons.arrow_back),
                      onPressed: _editorKey.currentState?.filterEditor.currentState?.close,
                    );
                  }),
              const Spacer(),
              IconButton(
                tooltip: 'Custom Icon',
                padding: const EdgeInsets.symmetric(horizontal: 8),
                icon: const Icon(
                  Icons.bug_report,
                  color: Colors.white,
                ),
                onPressed: () {},
              ),
              StreamBuilder(
                  stream: _updateAppBarStream.stream,
                  builder: (_, __) {
                    return IconButton(
                      padding: const EdgeInsets.symmetric(horizontal: 8),
                      icon: const Icon(Icons.done),
                      iconSize: 28,
                      onPressed: _editorKey.currentState?.filterEditor.currentState?.done,
                    );
                  }),
            ],
          ),
        ),
      ),
    );
  }
}

Upload to Firebase or Supabase

Firebase example

ProImageEditor.asset(
  'assets/demo.png',
  callbacks: ProImageEditorCallbacks(
    onImageEditingComplete: (bytes) async {
      try {
        String path = 'your-storage-path/my-image-name.jpg';
        Reference ref = FirebaseStorage.instance.ref(path);

        /// In some special cases detect firebase the contentType wrong,
        /// so we make sure the contentType is set to jpg.
        await ref.putData(bytes, SettableMetadata(contentType: 'image/jpg'));
      } on FirebaseException catch (e) {
        debugPrint(e.message);
      }
      if (mounted) Navigator.pop(context);
    },
  ),
);

Supabase example

final _supabase = Supabase.instance.client;

ProImageEditor.asset(
  'assets/demo.png',
  callbacks: ProImageEditorCallbacks(
    onImageEditingComplete: (bytes) async {
      try {
        String path = 'your-storage-path/my-image-name.jpg';
        await _supabase.storage.from('my_bucket').uploadBinary(
              path,
              bytes,
              retryAttempts: 3,
            );
      } catch (e) {
        debugPrint(e.toString());
      }
      if (mounted) Navigator.pop(context);
    },
  ),
);

Import-Export state history

The state history from the image editor can be exported and imported. However, it's important to note that the crop and rotate feature currently only allows exporting the final cropped image and not individual states. Additionally, all sticker widgets are converted into images and saved in that format during the export process.

Export example

 await _editor.currentState?.exportStateHistory(
    // All configurations are optional
    configs: const ExportEditorConfigs(
      exportPaint: true,
      exportText: true,
      exportCropRotate: false,
      exportFilter: true,
      exportEmoji: true,
      exportSticker: true,
      serializeSticker: true,
      historySpan: ExportHistorySpan.all,
    ),
  ).toJson(); // or => toMap(), toFile()

Import example

 _editor.currentState?.importStateHistory(
    // or => fromMap(), fromJsonFile()
    ImportStateHistory.fromJson( 
      /* Json-String from your exported state history */,
      configs: const ImportEditorConfigs(
        mergeMode: ImportEditorMergeMode.replace,
        recalculateSizeAndPosition: true,
      ),
    ),
  );

Initial import example

If you wish to open the editor directly with your exported state history, you can do so by utilizing the import feature. Simply load the exported state history into the editor, and it will recreate the previous editing session, allowing you to continue where you left off.

ProImageEditor.memory(
  bytes,
  key: _editor,
  callbacks: ProImageEditorCallbacks(
    onImageEditingComplete: (Uint8List bytes) async {
      /*
        Your code to handle the edited image. Upload it to your server as an example.
        You can choose to use await, so that the loading-dialog remains visible until your code is ready, or no async, so that the loading-dialog closes immediately.
        By default, the bytes are in `jpg` format.
      */
      Navigator.pop(context);
    },
  ),
  configs: ProImageEditorConfigs(
    stateHistoryConfigs: StateHistoryConfigs(
      initStateHistory: ImportStateHistory.fromJson( 
        /* Json-String from your exported state history */,
        configs: const ImportEditorConfigs(
          mergeMode: ImportEditorMergeMode.replace,
          recalculateSizeAndPosition: true,
        ),
      ),
    ),
  ),
);

Documentation

Interactive layers

Each layer, whether it's an emoji, text, or painting, is interactive, allowing you to manipulate them in various ways. You can move and scale layers using intuitive gestures. Holding a layer with one finger enables you to move it across the canvas. Holding a layer with one finger and using another to pinch or spread allows you to scale and rotate the layer.

On desktop devices, you can click and hold a layer with the mouse to move it. Additionally, using the mouse wheel lets you scale the layer. To rotate a layer, simply press the 'Shift' or 'Ctrl' key while interacting with it.

Editor Widget

Property	Description
`byteArray`	Image data as a `Uint8List` from memory.
`file`	File object representing the image file.
`assetPath`	Path to the image asset.
`networkUrl`	URL of the image to be loaded from the network.
`configs`	Configuration options for the image editor.
`callbacks`	Callbacks for the image editor.

Constructors

`ProImageEditor.memory`

Creates a ProImageEditor widget for editing an image from memory.

`ProImageEditor.file`

Creates a ProImageEditor widget for editing an image from a file.

`ProImageEditor.asset`

Creates a ProImageEditor widget for editing an image from an asset.

`ProImageEditor.network`

Creates a ProImageEditor widget for editing an image from a network URL.

ProImageEditorConfigs

Property Name	Description	Default Value
`blurEditor`	Configuration options for the Blur Editor.	`BlurEditorConfigs()`
`cropRotateEditor`	Configuration options for the Crop and Rotate Editor.	`CropRotateEditorConfigs()`
`designMode`	The design mode for the Image Editor.	`ImageEditorDesignModeE.material`
`dialogConfigs`	Configuration for the loading dialog used in the editor.	`DialogConfigs()`
`emojiEditor`	Configuration options for the Emoji Editor.	`EmojiEditorConfigs()`
`filterEditor`	Configuration options for the Filter Editor.	`FilterEditorConfigs()`
`helperLines`	Configuration options for helper lines in the Image Editor.	`HelperLineConfigs()`
`heroTag`	A unique hero tag for the Image Editor widget.	`'Pro-Image-Editor-Hero'`
`i18n`	Internationalization settings for the Image Editor.	`I18n()`
`imageGeneration`	Holds the configurations related to image generation.	`ImageGenerationConfigs()`
`layerInteraction`	Configuration options for the layer interaction behavior.	`LayerInteractionConfigs()`
`mainEditor`	Configuration options for the Main Editor.	`MainEditorConfigs()`
`paintEditor`	Configuration options for the Paint Editor.	`PaintEditorConfigs()`
`progressIndicatorConfigs`	Configuration for customizing progress indicators.	`ProgressIndicatorConfigs()`
`stateHistory`	Holds the configurations related to state history management.	`StateHistoryConfigs()`
`stickerEditor`	Configuration options for the Sticker Editor.	`StickerEditorConfigs()`
`textEditor`	Configuration options for the Text Editor.	`TextEditorConfigs()`
`theme`	The theme to be used for the Image Editor.	`null`
`tuneEditor`	Configuration options for the Tune Editor.	`TuneEditorConfigs()`

ProImageEditorCallbacks

Property Name	Description	Default Value
`onImageEditingStarted`	A callback function that is triggered when the image generation is started.	`null`
`onImageEditingComplete`	A callback function that will be called when the editing is done, returning the edited image as `Uint8List` with the format `jpg`.	`null`
`onThumbnailGenerated`	A callback function that is called when the editing is complete and the thumbnail image is generated, along with capturing the original image as a raw `ui.Image`. If used, it will disable the `onImageEditingComplete` callback.	`null`
`onCloseEditor`	A callback function that will be called before the image editor closes.	`null`
`mainEditorCallbacks`	Callbacks from the main editor.	`null`
`paintEditorCallbacks`	Callbacks from the paint editor.	`null`
`textEditorCallbacks`	Callbacks from the text editor.	`null`
`cropRotateEditorCallbacks`	Callbacks from the crop-rotate editor.	`null`
`filterEditorCallbacks`	Callbacks from the filter editor.	`null`
`blurEditorCallbacks`	Callbacks from the blur editor.	`null`

i18n

Property Name	Description	Default Value
`paintEditor`	Translations and messages specific to the painting editor.	`I18nPaintingEditor()`
`various`	Translations and messages for various parts of the editor.	`I18nVarious()`
`layerInteraction`	Translations and messages for layer interactions.	`I18nLayerInteraction()`
`textEditor`	Translations and messages specific to the text editor.	`I18nTextEditor()`
`filterEditor`	Translations and messages specific to the filter editor.	`I18nFilterEditor()`
`blurEditor`	Translations and messages specific to the blur editor.	`I18nBlurEditor()`
`emojiEditor`	Translations and messages specific to the emoji editor.	`I18nEmojiEditor()`
`stickerEditor`	Translations and messages specific to the sticker editor.	`I18nStickerEditor()`
`cropRotateEditor`	Translations and messages specific to the crop and rotate editor.	`I18nCropRotateEditor()`
`doneLoadingMsg`	Message displayed while changes are being applied.	`Changes are being applied`
`importStateHistoryMsg`	Message displayed during the import of state history. If the text is empty, no loading dialog will be shown.	`Initialize Editor`
`cancel`	Text for the "Cancel" action.	`Cancel`
`undo`	Text for the "Undo" action.	`Undo`
`redo`	Text for the "Redo" action.	`Redo`
`done`	Text for the "Done" action.	`Done`
`remove`	Text for the "Remove" action.	`Remove`

`i18n paintEditor`

Property Name	Description	Default Value
`bottomNavigationBarText`	Text for the bottom navigation bar item that opens the Painting Editor.	`Paint`
`freestyle`	Text for the "Freestyle" painting mode.	`Freestyle`
`arrow`	Text for the "Arrow" painting mode.	`Arrow`
`line`	Text for the "Line" painting mode.	`Line`
`rectangle`	Text for the "Rectangle" painting mode.	`Rectangle`
`circle`	Text for the "Circle" painting mode.	`Circle`
`dashLine`	Text for the "Dash line" painting mode.	`Dash line`
`lineWidth`	Text for the "Line width" tooltip.	`Line width`
`toggleFill`	Text for the "Toggle fill" tooltip.	`Toggle fill`
`undo`	Text for the "Undo" button.	`Undo`
`redo`	Text for the "Redo" button.	`Redo`
`done`	Text for the "Done" button.	`Done`
`back`	Text for the "Back" button.	`Back`
`smallScreenMoreTooltip`	The tooltip text displayed for the "More" option on small screens.	`More`

`i18n textEditor`

Property	Description	Default Value
`bottomNavigationBarText`	Text for the bottom navigation bar item	`'Text'`
`inputHintText`	Placeholder text displayed in the text input field	`'Enter text'`
`done`	Text for the "Done" button	`'Done'`
`back`	Text for the "Back" button	`'Back'`
`textAlign`	Text for the "Align text" setting	`'Align text'`
`fontScale`	Text for the "Font Scale" setting	`'Font Scale'`
`backgroundMode`	Text for the "Background mode" setting	`'Background mode'`
`smallScreenMoreTooltip`	Tooltip text for the "More" option on small screens	`'More'`

`i18n cropRotateEditor`

Property Name	Description	Default Value
`bottomNavigationBarText`	Text for the bottom navigation bar item that opens the Crop and Rotate Editor.	`Crop/ Rotate`
`rotate`	Text for the "Rotate" tooltip.	`Rotate`
`flip`	Text for the "Flip" tooltip.	`Flip`
`ratio`	Text for the "Ratio" tooltip.	`Ratio`
`back`	Text for the "Back" button.	`Back`
`cancel`	Text for the "Cancel" button.	`Cancel`
`done`	Text for the "Done" button.	`Done`
`reset`	Text for the "Reset" button.	`Reset`
`undo`	Text for the "Undo" button.	`Undo`
`redo`	Text for the "Redo" button.	`Redo`
`smallScreenMoreTooltip`	The tooltip text displayed for the "More" option on small screens.	`More`

`i18n filterEditor`

Property	Description	Default Value
`applyFilterDialogMsg`	Text displayed when a filter is being applied	`'Filter is being applied.'`
`bottomNavigationBarText`	Text for the bottom navigation bar item	`'Filter'`
`back`	Text for the "Back" button in the Filter Editor	`'Back'`
`done`	Text for the "Done" button in the Filter Editor	`'Done'`
`filters`	Internationalization settings for individual filters	`I18nFilters()`

`i18n blurEditor`

Property	Description	Default Value
`applyBlurDialogMsg`	Text displayed when a filter is being applied	`'Blur is being applied.'`
`bottomNavigationBarText`	Text for the bottom navigation bar item	`'Blur'`
`back`	Text for the "Back" button in the Blur Editor	`'Back'`
`done`	Text for the "Done" button in the Blur Editor	`'Done'`

`i18n emojiEditor`

Property Name	Description	Default Value
`bottomNavigationBarText`	Text for the bottom navigation bar item that opens the Emoji Editor.	`Emoji`
`noRecents`	Text which shows there are no recent selected emojis.	`No Recents`
`search`	Hint text in the search field.	`Search`

`i18n stickerEditor`

Property	Description	Default Value
`bottomNavigationBarText`	Text for the bottom navigation bar item that opens the Sticker Editor.	'Stickers'

`i18n various`

Property	Description	Default Value
`loadingDialogMsg`	Text for the loading dialog message.	`'Please wait...'`
`closeEditorWarningTitle`	Title for the warning message when closing the Image Editor.	`'Close Image Editor?'`
`closeEditorWarningMessage`	Warning message when closing the Image Editor.	`'Are you sure you want to close the Image Editor? Your changes will not be saved.'`
`closeEditorWarningConfirmBtn`	Text for the confirmation button in the close editor warning dialog.	`'OK'`
`closeEditorWarningCancelBtn`	Text for the cancel button in the close editor warning dialog.	`'Cancel'`

Contributing

I welcome contributions from the open-source community to make this project even better. Whether you want to report a bug, suggest a new feature, or contribute code, I appreciate your help.

Bug Reports and Feature Requests

If you encounter a bug or have an idea for a new feature, please open an issue on my GitHub Issues page. I will review it and discuss the best approach to address it.

Code Contributions

If you'd like to contribute code to this project, please follow these steps:

Fork the repository to your GitHub account.
Clone your forked repository to your local machine.

git clone https://github.com/hm21/pro_image_editor.git

Contributors

Made with contrib.rocks.

Included Packages

This package uses several Flutter packages to provide a seamless editing experience. A big thanks to the authors of these amazing packages. Here’s a list of the packages we used in this project:

From these packages, only a small part of the code is used, with some code changes that better fit to the image editor.

Name		Name	Last commit message	Last commit date
Latest commit History 443 Commits
.github		.github
.vscode		.vscode
assets		assets
example		example
lib		lib
test		test
.gitignore		.gitignore
.metadata		.metadata
.pubignore		.pubignore
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
NOTICES		NOTICES
README.md		README.md
analysis_options.yaml		analysis_options.yaml
pubspec.yaml		pubspec.yaml

License

hm21/pro_image_editor

Folders and files

Latest commit

History

Repository files navigation

Table of contents

Preview

Features

Planned features

Getting started

Android

OpenHarmony

Web

iOS, macOS, Linux, Windows

Usage

Open the editor in a new page

Show the editor inside of a widget

Own stickers or widgets

Frosted-Glass design

WhatsApp design

Highly configurable

Custom AppBar

Upload to Firebase or Supabase

Import-Export state history

Documentation

Interactive layers

Editor Widget

Constructors

ProImageEditor.memory

ProImageEditor.file

ProImageEditor.asset

ProImageEditor.network

ProImageEditorConfigs

ProImageEditorCallbacks

i18n paintEditor

i18n textEditor

i18n cropRotateEditor

i18n filterEditor

i18n blurEditor

i18n emojiEditor

i18n stickerEditor

i18n various

Contributing

Bug Reports and Feature Requests

Code Contributions

Contributors

Included Packages

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 6

Sponsor this project

Packages 0

Contributors 10

Languages

`ProImageEditor.memory`

`ProImageEditor.file`

`ProImageEditor.asset`

`ProImageEditor.network`

`i18n paintEditor`

`i18n textEditor`

`i18n cropRotateEditor`

`i18n filterEditor`

`i18n blurEditor`

`i18n emojiEditor`

`i18n stickerEditor`

`i18n various`

Packages