Skip to content
On this page

ImageEditor

An editing surface for adjusting an image.

ImageEditor in FluttyUIImageEditor in FluttyUI dark theme

Import

import 'package:flutter/widgets.dart';
import 'package:fluttyui/fluttyui.dart' as ui;

API Reference

The declarations below match the current FluttyUI source. Types are shown without the optional ui. import prefix.

ImageEditor

const ImageEditor({
  super.key,
  required this.image,
  this.controller,
  this.onDone,
  this.onCancel,
  this.onChanged,
  this.height = 600,
  this.maxOutputDimension = 4096,
  this.title = 'Edit photo',
  this.doneLabel = 'Done',
  this.cancelLabel = 'Cancel',
});
ParameterTypeRequiredDefault
keyKey?Nonull
imageImageProvider<Object>Yes—
controllerImageEditorController?Nonull
onDoneFutureOr<void> Function(ImageEditorResult result)?Nonull
onCancelVoidCallback?Nonull
onChangedValueChanged<ImageEdit>?Nonull
heightdouble?No600
maxOutputDimensionintNo4096
titleStringNo'Edit photo'
doneLabelStringNo'Done'
cancelLabelStringNo'Cancel'

Future<ImageEditorResult?> show

static Future<ImageEditorResult?> show({
  required BuildContext context,
  required ImageProvider<Object> image,
  ImageEditorController? controller,
  int maxOutputDimension = 4096,
});

Application Setup

Place components under FluttyApp to provide theme, navigation, localization, and overlay defaults. Use theme tokens for shared appearance settings.

Source

lib/src/widgets/media/image_editor/image_editor.dart

This reference is generated from the ImageEditor declaration in the FluttyUI core checkout. The component catalog lists the other available building blocks.

DartFlutter

Get started with FluttyUI