pro_image_editor library

Classes

AdaptiveDialogStyle
A style 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.
BlurEditorIcons
Customizable icons for the Blur Editor component.
BlurEditorInitConfigs
TODO: Remove deprecated callbacks Configuration class for initializing the blur editor.
BlurEditorState
The state class for the BlurEditor widget.
BlurEditorStyle
The BlurEditorStyle class defines the style for the blur editor in the image editor. It includes properties such as colors for the app bar and background.
BlurEditorWidgets
A custom widget for editing blur effects in an image editor.
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
CensorConfigs
A configuration class for defining blur settings for censoring content.
ColorFilterAddons
A utility class providing various color filter transformations.
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.
CropRotateEditorIcons
Customizable icons for the Crop/Rotate Editor component.
CropRotateEditorInitConfigs
Configuration settings for initializing the Crop and Rotate Editor.
CropRotateEditorState
A state class for ImageCropRotateEditor widget.
CropRotateEditorStyle
The CropRotateEditorStyle class defines the styles 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.
CropRotateEditorWidgets
A custom widget for editing crop and rotate effects in an image editor.
Debounce
A utility class for debouncing function calls.
DialogConfigs
Configuration class for customizing the dialog in the editor.
DialogStyle
Style configuration class for dialogs used in the editor.
DialogWidgets
Defines customizable widgets for the dialog in the editor.
DrawPaintItem
Handles the paint ongoing on the canvas.
EditorImage
Flutter EditorImage Class Documentation
EditorStateHistory
The EditorStateHistory class represents changes made to an image in the image editor. It contains information about the changes applied to the image and a list of layers.
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.
EmojiEditorIcons
Customizable icons for the Emoji Editor component.
EmojiEditorState
The state class for the EmojiEditor widget.
EmojiEditorStyle
The EmojiEditorStyle class defines the styles for the emoji editor in the image editor.
EmojiLayer
A class representing a layer with emoji content.
EmojiViewConfig
Emoji View Config
ExportEditorConfigs
Configuration options for exporting editor contents.
ExtendedPopScope<T>
A widget that provides a custom pop behavior when a pop action is invoked and optionally returns a result.
FadeInUp
A widget that applies a fade-in animation combined with a slide-from-bottom effect to its child.
FilterEditor
The FilterEditor widget allows users to editing images with filters
FilterEditorCallbacks
A class representing callbacks for the filter editor.
FilterEditorConfigs
Configuration options for a filter editor.
FilterEditorIcons
Customizable icons for the Filter Editor component.
FilterEditorInitConfigs
TODO: Remove deprecated callbacks Configuration class for initializing the filter editor.
FilterEditorItemList
A widget for displaying a list of filter editor items, allowing users to select and apply filters to an image.
FilterEditorState
The state class for the FilterEditor widget.
FilterEditorStyle
The FilterEditorStyle class defines the style for the filter editor in the image editor. It includes properties such as colors for the app bar, background, and preview text.
FilterEditorWidgets
A custom widget for editing filter effects in an image editor.
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.
HelperLineConfigs
The HelperLineConfigs class defines the settings for displaying helper lines in the image editor. Helper lines are used to guide users in positioning and rotating layers.
HelperLinesCallbacks
A class that defines callback functions for handling different types of helper line hits.
HelperLineStyle
The HelperLineStyle class defines the style 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
A class representing internationalized strings for filter-related UI text.
I18nLayerInteraction
Internationalization (i18n) settings for layer interaction components.
I18nPaintEditor
Internationalization (i18n) settings for the Paint Editor component.
I18nStickerEditor
Internationalization (i18n) settings for the I18nStickerEditor Editor component.
I18nTextEditor
Internationalization (i18n) settings for the Text Editor component.
I18nTuneEditor
Internationalization (i18n) settings for the Tune Editor component.
I18nVarious
Internationalization (i18n) settings for various components.
ImageGenerationConfigs
Configuration settings for image generation.
ImageInfos
Contains information about an image's size and rotation status.
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.
LayerInteractionConfigs
Represents the interaction behavior for a layer.
LayerInteractionIcons
Represents the interaction icons for layers in the theme.
LayerInteractionStyle
Represents the interaction settings for layers in the style.
LayerInteractionWidgets
A class that defines a layer of interaction for custom widgets, allowing editing, removing, and rotating/scaling actions.
LoadingDialog
A singleton class that manages the display of loading dialogs.
LoadingDialogStyle
A style configuration for loading dialogs.
MainEditorCallbacks
A class representing callbacks for the main editor.
MainEditorConfigs
Configuration options for a main editor.
MainEditorIcons
Customizable icons for Main-Editor component.
MainEditorStyle
Represents the styling configuration for the main editor interface.
MainEditorTransformSetup
A class that encapsulates the configuration and image information required to set up the main editor's transform settings.
MainEditorWidgets
A custom widget for the main editor interface in an image editor.
PaintEditor
The PaintEditor widget allows users to editing images with paint tools.
PaintEditorCallbacks
A class representing callbacks for the paint editor.
PaintEditorConfigs
Configuration options for a paint editor.
PaintEditorIcons
Customizable icons for the Paint Editor component.
PaintEditorInitConfigs
TODO: Remove deprecated callbacks Configuration class for initializing the paint editor.
PaintEditorState
State class for managing the paint editor, handling user interactions and paint operations.
PaintEditorStyle
Flutter PaintEditorStyle Class Documentation
PaintEditorWidgets
A list of custom widgets for the paint editor.
PaintLayer
A class representing a layer with custom paint content.
PaintModeBottomBarItem
Represents a model for a paint-mode item, 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.
ProgressIndicatorConfigs
Configuration class for customizing progress indicators.
ProgressIndicatorWidgets
Configuration class for customizing progress indicators.
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
State class for the ProImageEditor widget, handling configurations and user interactions for image editing.
ProVideoController
Controls video playback and trimming for the video editor.
ReactiveAppbar
A custom app bar widget that reacts to stream updates.
ReactiveWidget<T extends Widget>
A custom widget that reacts to stream updates.
SearchViewConfig
Search view Config
SkinToneConfig
Skin tone config Config
StateHistoryConfigs
A class representing configuration settings for managing state history.
StickerEditor
The StickerEditor class is responsible for creating a widget that allows users to select stickers
StickerEditorCallbacks
A class representing callbacks for the sticker editor.
StickerEditorConfigs
Configuration options for a sticker editor.
StickerEditorIcons
Customizable icons for the Sticker Editor component.
StickerEditorState
The state class for the StickerEditor widget.
StickerEditorStyle
The StickerEditorStyle class defines the style for the sticker editor in the image editor. It includes properties such as colors for the background, category indicator, category icons, and more.
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.
TextEditorIcons
Customizable icons for the Text Editor component.
TextEditorState
The state class for the TextEditor widget.
TextEditorStyle
The TextEditorStyle class defines the style for the text editor in the image editor. It includes properties such as colors for the app bar, background, text input, and more.
TextEditorWidgets
A custom widget for editing text in an image editor.
TextLayer
Represents a text layer with customizable properties.
TransformConfigs
A class representing configuration settings for image transformation.
TrimDurationSpan
Represents a span of time within a video for trimming purposes.
TuneAdjustmentItem
A class representing an adjustable tune item in the editor.
TuneEditor
The TuneEditor widget allows users to edit images with various tune adjustment tools such as brightness, contrast, and saturation.
TuneEditorCallbacks
A class representing callbacks for the tune editor.
TuneEditorConfigs
A configuration class for the Tune Editor.
TuneEditorIcons
A configuration class for defining icons used in the Tune Editor.
TuneEditorInitConfigs
TODO: Remove deprecated callbacks Configuration class for initializing the tune editor.
TuneEditorState
The state class for the TuneEditor widget.
TuneEditorStyle
A style class for the Tune Editor that allows customization of colors used in the app bar and background.
TuneEditorWidgets
A custom widget for the Tune Editor that extends the CustomWidgetsStandaloneEditor to manage its state.
VideoEditorCallbacks
Defines callback functions for handling video editor events.
VideoEditorConfigs
Configuration settings for the video editor.
VideoEditorIcons
Defines icon configurations for the video editor.
VideoEditorRemoveArea
A widget representing the remove area in the video editor.
VideoEditorStyle
Defines style configurations for the video editor.
VideoEditorWidgets
A configuration class for customizable video editor UI components.
WidgetLayer
A class representing a layer with custom widget content.
WidgetLayerExportConfigs
A class that represents the export configurations for a widget layer.

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
EditorMode
Defines the available editor modes.
ExportHistorySpan
Enum representing different spans of export history.
ImageEditorDesignMode
Enum representing design modes for an image editor.
ImageMaxSide
An enumeration representing the maximum side of an image.
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
An enumeration representing the style of the border for a selected layer.
LayerInteractionSelectable
Enumerates the different selectability states for a layer.
OutputFormat
Enumeration of image output formats.
PaintMode
The PaintMode enum represents different paint-item modes for a drawing application in Flutter.
PickMode
An enumeration representing different modes for color picking.
PngFilter
ProcessorMode
An enumeration representing the mode of processor utilization.
RecentTabBehavior
Behavior of Recent Tab
RotateDirection
An enumeration representing the direction of rotation for an image editor.
SubEditor
An enumeration representing different types of sub-editors available in the image editor.
VideoEditorControlPosition
Enum defining possible positions for video editor controls.

Constants

DefaultEmojiTextStyle → const TextStyle
Emoji text style providing commonly available fallback fonts
emojiSetChinese → const List<CategoryEmoji>
List of categories of emojis
emojiSetEnglish → const List<CategoryEmoji>
List of categories of emojis
emojiSetFrance → const List<CategoryEmoji>
List of categories of emojis
emojiSetGerman → const List<CategoryEmoji>
List of categories of emojis
emojiSetHindi → const List<CategoryEmoji>
List of categories of emojis
emojiSetItalian → const List<CategoryEmoji>
List of categories of emojis
emojiSetJapanese → const List<CategoryEmoji>
List of categories of emojis
emojiSetPortuguese → const List<CategoryEmoji>
List of categories of emojis
emojiSetRussian → const List<CategoryEmoji>
List of categories of emojis
emojiSetSpanish → const List<CategoryEmoji>
List of categories of emojis
kImageEditorAppBarBackground → const Color
Background color of the app bar in the image editor.
kImageEditorAppBarColor → const Color
Color of the app bar in the image editor.
kImageEditorBackground → const Color
Background color for the image editor.
kImageEditorBottomBarBackground → const Color
Background color of the bottom bar in the image editor.
kImageEditorBottomBarColor → const Color
Color of the bottom bar in the image editor.
kImageEditorPrimaryColor → const Color
Primary color used in the image editor interface.
kImageEditorTextColor → const Color
Text color used in the image editor interface.
kImageEditorUiOverlayStyle → const SystemUiOverlayStyle
UI overlay style for the image editor.

Properties

isDesktop → bool
Checks if the app is running on a desktop platform.
final
isWebMobile → bool
Checks if the current platform is a web mobile device.
final
platformDesignMode → ImageEditorDesignMode
Sets the design mode for the image editor based on the platform. Uses Material Design for non-iOS/macOS platforms and Cupertino for iOS/macOS.
final
platformIsMaterialDesign → bool
Determines if the platform uses Material Design.
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, ImageGenerationConfigs configs = const ImageGenerationConfigs(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 widget, {WidgetLayerExportConfigs? exportConfigs}), ScrollController scrollController)
A typedef representing a function signature for building sticker widgets.
CompleteWidthParametersCallback = Future<void> Function(CompleteParameters parameters)
Signature for a callback that handles a CompleteParameters object.
CropRotateEditorDone = dynamic Function(TransformConfigs transformations, double fitToScreenFactor, ImageInfos? imageInfos)
TODO: Remove deprecated callbacks A typedef representing a callback function signature for completing the crop and rotate editing process.
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.