pro_image_editor library

Classes

AdaptiveDialogTheme
A theme configuration for adaptive dialogs.
AspectRatioItem
The AspectRatioItem class represents an item with an aspect ratio value and an optional text description. It is commonly used to define aspect ratio options for widgets or components that require a specific aspect ratio.
BarColorPicker
A widget that allows users to pick colors from a gradient bar.
BlurEditor
The BlurEditor widget allows users to apply blur to images.
BlurEditorCallbacks
A class representing callbacks for the blur editor.
BlurEditorConfigs
Configuration options for a blur editor.
BlurEditorInitConfigs
Configuration class for initializing the blur editor.
BlurEditorState
The state class for the BlurEditor widget.
BlurEditorTheme
The BlurEditorTheme class defines the theme for the blur editor in the image editor. It includes properties such as colors for the app bar and background.
BottomActionBarConfig
Bottom Action Bar Config
CategoryEmoji
Container for Category and their emoji
CategoryIcons
Class used to define all the CategoryIcon shown for each Category
CategoryViewConfig
Category view Config
ColorFilterAddons
CropAspectRatioOptions
Provides a widget for selecting crop aspect ratio options within an image editor.
CropRotateEditor
The CropRotateEditor widget allows users to editing images with crop, flip and rotate tools.
CropRotateEditorCallbacks
A class representing callbacks for the crop-rotate editor.
CropRotateEditorConfigs
Configuration options for a crop and rotate editor.
CropRotateEditorInitConfigs
CropRotateEditorState
A state class for ImageCropRotateEditor widget.
CropRotateEditorTheme
The CropRotateEditorTheme class defines the theme for the crop and rotate editor in the image editor. It includes properties such as colors for the app bar, background, crop corners, and more.
CustomWidgetsBlurEditor
CustomWidgetsCropRotateEditor
CustomWidgetsFilterEditor
CustomWidgetsMainEditor
CustomWidgetsPaintEditor
CustomWidgetsTextEditor
DrawPainting
Handles the painting ongoing on the canvas.
EditorImage
Flutter EditorImage Class Documentation
Emoji
A class to store data for each individual emoji
EmojiEditor
The EmojiEditor class is responsible for creating a widget that allows users to select emojis.
EmojiEditorConfigs
Configuration options for an emoji editor.
EmojiEditorState
The state class for the EmojiEditor widget.
EmojiEditorTheme
The EmojiEditorTheme class defines the theme for the emoji editor in the image editor.
EmojiLayerData
A class representing a layer with emoji content.
EmojiViewConfig
Emoji View Config
ExportEditorConfigs
Configuration options for exporting editor contents.
FilterEditor
The FilterEditor widget allows users to editing images with painting tools.
FilterEditorCallbacks
A class representing callbacks for the filter editor.
FilterEditorConfigs
Configuration options for a filter editor.
FilterEditorInitConfigs
Configuration class for initializing the filter editor.
FilterEditorItemList
FilterEditorState
The state class for the FilterEditor widget.
FilterEditorTheme
The FilterEditorTheme class defines the theme for the filter editor in the image editor. It includes properties such as colors for the app bar, background, and preview text.
FilterModel
A model class that represents a filter with a name and associated filter matrix.
FlatIconTextButton
A custom TextButton widget with an icon placed above the label.
HelperLines
The HelperLines class defines the settings for displaying helper lines in the image editor. Helper lines are used to guide users in positioning and rotating layers.
HelperLineTheme
The HelperLineTheme class defines the theme for helper lines in the image editor. Helper lines are used to assist with alignment and positioning of elements in the editor.
I18n
The I18n class provides internationalization settings for the image editor and its components. It includes translations and messages for various parts of the editor.
I18nBlurEditor
Internationalization (i18n) settings for the Blur Editor component.
I18nCropRotateEditor
Internationalization (i18n) settings for the Crop and Rotate Editor component.
I18nEmojiEditor
Internationalization (i18n) settings for the Emoji Editor component.
I18nFilterEditor
Internationalization (i18n) settings for the Filter Editor component.
I18nFilters
I18nLayerInteraction
I18nPaintingEditor
Internationalization (i18n) settings for the Painting Editor component.
I18nStickerEditor
Internationalization (i18n) settings for the I18nStickerEditor Editor component.
I18nTextEditor
Internationalization (i18n) settings for the Text Editor component.
I18nVarious
Internationalization (i18n) settings for various components.
IconsBlurEditor
Customizable icons for the Blur Editor component.
IconsCropRotateEditor
Customizable icons for the Crop/Rotate Editor component.
IconsEmojiEditor
Customizable icons for the Emoji Editor component.
IconsFilterEditor
Customizable icons for the Filter Editor component.
IconsLayerInteraction
Represents the interaction icons for layers in the theme.
IconsPaintingEditor
Customizable icons for the Painting Editor component.
IconsStickerEditor
Customizable icons for the Sticker Editor component.
IconsTextEditor
Customizable icons for the Text Editor component.
ImageEditorCustomWidgets
The ImageEditorCustomWidgets class encapsulates custom widget components that can be used within various parts of the application's user interface. It provides flexibility for customizing the appearance and behavior of specific UI elements such as app bars, bottom navigation bars, and more.
ImageEditorIcons
Customizable icons for the Image Editor component.
ImageEditorTheme
The ImageEditorTheme class defines the overall theme for the image editor in your Flutter application. It includes themes for various editor components such as helper lines, painting editor, text editor, crop & rotate editor, filter editor, emoji editor, and more.
ImageGeneratioConfigs
Configuration settings for image generation.
ImageInfos
ImportEditorConfigs
This class represents configurations for importing editor data.
ImportStateHistory
This class represents the state history of an imported editor session.
Layer
Represents a layer with common properties for widgets.
LayerInteraction
Represents the interaction behavior for a layer.
LoadingDialog
LoadingDialogTheme
A theme configuration for loading dialogs.
MainEditorCallbacks
A class representing callbacks for the main editor.
PaintEditorCallbacks
A class representing callbacks for the paint editor.
PaintEditorConfigs
Configuration options for a paint editor.
PaintEditorInitConfigs
Configuration class for initializing the paint editor.
PaintingEditor
The PaintingEditor widget allows users to editing images with painting tools.
PaintingEditorState
PaintingEditorTheme
Flutter PaintingEditorTheme Class Documentation
PaintingLayerData
A class representing a layer with custom painting content.
PaintModeBottomBarItem
Represents a model for a painting mode, including an icon, a mode identifier, and a label.
PlatformCircularProgressIndicator
A circular progress indicator that adapts to the platform.
PresetFilters
Preset filters that can be used directly
ProcessorConfigs
Configuration class for managing processor settings.
ProImageEditor
A widget for image editing using ProImageEditor.
ProImageEditorCallbacks
A class representing callbacks for the Image Editor.
ProImageEditorConfigs
A class representing configuration options for the Image Editor.
ProImageEditorState
ReactiveCustomAppbar
ReactiveCustomWidget<T extends Widget>
SearchViewConfig
Search view Config
SkinToneConfig
Skin tone config Config
StateHistoryConfigs
StickerEditor
The StickerEditor class is responsible for creating a widget that allows users to select emojis.
StickerEditorCallbacks
A class representing callbacks for the sticker editor.
StickerEditorConfigs
Configuration options for a sticker editor.
StickerEditorState
The state class for the StickerEditor widget.
StickerEditorTheme
The StickerEditorTheme class defines the theme for the sticker editor in the image editor. It includes properties such as colors for the background, category indicator, category icons, and more.
StickerLayerData
A class representing a layer with custom sticker content.
SubEditorPageTheme
A class representing the theme configuration for a sub-editor page.
TextEditor
A StatefulWidget that provides a text editing interface for adding and editing text layers.
TextEditorCallbacks
A class representing callbacks for the text editor.
TextEditorConfigs
Configuration options for a text editor.
TextEditorState
The state class for the TextEditor widget.
TextEditorTheme
The TextEditorTheme class defines the theme for the text editor in the image editor. It includes properties such as colors for the app bar, background, text input, and more.
TextLayerData
Represents a text layer with customizable properties.
ThemeLayerInteraction
Represents the interaction settings for layers in the theme.

Enums

ButtonMode
Enum to alter the keyboard button style
Category
All the possible categories that Emoji can be put into
EditorImageType
Flutter EditorImageType Enum Documentation
ExportHistorySpan
Enum representing different spans of export history.
ImageEditorDesignModeE
Enum representing design modes for an image editor.
ImportEditorMergeMode
Enum representing different merge modes for importing editor data.
JpegChroma
JPEG Chroma (sub)sampling format.
LayerBackgroundMode
Enumeration for controlling the background color mode of the text layer.
LayerInteractionBorderStyle
LayerInteractionSelectable
Enumerates the different selectability states for a layer.
OutputFormat
Enumeration of image output formats.
PaintModeE
The PaintModeE enum represents different painting modes for a drawing application in Flutter.
PickMode
An enumeration representing different modes for color picking.
PngFilter
ProcessorMode
RecentTabBehavior
Behavior of Recent Tab
RotateDirection
SubEditor
An enumeration representing different types of sub-editors available in the image editor.

Constants

defaultEmojiSet → const List<CategoryEmoji>
List of categories of emojis
DefaultEmojiTextStyle → const TextStyle
Emoji text style providing commonly available fallback fonts
imageEditorAppBarColor → const Color
Color for the app bar in the image editor.
imageEditorBackgroundColor → const Color
Background color for the image editor.
imageEditorPrimaryColor → const Color
Primary color used in the image editor interface.
imageEditorTextColor → const Color
Text color used in the image editor interface.

Properties

isDesktop → bool
Checks if the app is running on a desktop platform.
final
isWebMobile → bool
final
platformDesignMode → ImageEditorDesignModeE
final
platformIsMaterialDesign → bool
final
presetFiltersList ↔ List<FilterModel>
List of filter presets
getter/setter pair

Functions

decodeImageInfos({required Uint8List bytes, required Size screenSize, TransformConfigs? configs}) → Future<ImageInfos>
Decode the image being edited.
fetchImageAsUint8List(String imageUrl) → Future<Uint8List>
Fetches an image from a network URL as a Uint8List.
generateHighQualityImage(Image image, {BuildContext? context, ImageGeneratioConfigs configs = const ImageGeneratioConfigs(outputFormat: OutputFormat.png, maxOutputSize: Size.infinite, processorConfigs: ProcessorConfigs(processorMode: ProcessorMode.minimum))}) → Future<Uint8List?>
Generates a high-quality image from the provided ui.Image.
loadAssetImageAsUint8List(String assetPath) → Future<Uint8List>
Loads an image asset as a Uint8List.
readFileAsUint8List(File file) → Future<Uint8List>
Reads a file as a Uint8List.

Typedefs

BuildStickers = Widget Function(dynamic setLayer(Widget), ScrollController scrollController)
CropRotateEditorDone = dynamic Function(TransformConfigs transformations, double fitToScreenFactor)
FlipCallback = dynamic Function(bool flipX, bool flipY)
A typedef representing a callback function invoked when a flip action is performed.
ImageEditingCompleteCallback = Future<void> Function(Uint8List bytes)
A typedef representing a callback function invoked when image editing is complete.
ImageEditingEmptyCallback = void Function()
A typedef representing a callback function invoked when no image editing is performed.
ThumbnailGeneratedCallback = Future<void> Function(Uint8List thumbnailBytes, Image rawImage)
A callback function type that is invoked when a thumbnail image is generated.
UpdateUiCallback = void Function()
A typedef representing a callback function invoked when the ui should update.