image_cropper 3.0.1 icon indicating copy to clipboard operation
image_cropper: ^3.0.1 copied to clipboard

A Flutter plugin for Android, iOS and Web supports cropping images

Image Cropper #

pub package

A Flutter plugin for Android, iOS and Web supports cropping images. This plugin is based on three different native libraries so it comes with different UI between these platforms.

Introduction #

Image Cropper doesn't manipulate images in Dart codes directly, instead, the plugin uses Platform Channel to expose Dart APIs that Flutter application can use to communicate with three very powerful native libraries (uCrop, TOCropViewController and croppie) to crop and rotate images. Because of that, all credits belong to these libraries.

uCrop - Yalantis #

GitHub watchers GitHub stars GitHub forks License

This project aims to provide an ultimate and flexible image cropping experience. Made in Yalantis

TOCropViewController - TimOliver #

GitHub watchers GitHub stars GitHub forks Version GitHub license

TOCropViewController is an open-source UIViewController subclass to crop out sections of UIImage objects, as well as perform basic rotations. It is excellent for things like editing profile pictures, or sharing parts of a photo online. It has been designed with the iOS Photos app editor in mind, and as such, behaves in a way that should already feel familiar to users of iOS.

Croppie - Foliotek #

GitHub watchers GitHub stars GitHub forks npm version

Croppie is a fast, easy to use image cropping plugin with tons of configuration options!

How to install #

Android #

  • Add UCropActivity into your AndroidManifest.xml
<activity
    android:name="com.yalantis.ucrop.UCropActivity"
    android:screenOrientation="portrait"
    android:theme="@style/Theme.AppCompat.Light.NoActionBar"/>

Note:

From v1.2.0, you need to migrate your android project to v2 embedding (detail)

iOS #

  • No configuration required

Web #

  • Add following codes inside <head> tag in file web/index.html:
<head>
  ....

  <!-- Croppie -->
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/croppie/2.6.5/croppie.css" />
  <script defer src="https://cdnjs.cloudflare.com/ajax/libs/exif-js/2.3.0/exif.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/croppie/2.6.5/croppie.min.js"></script>

  ....
</head>

Usage #

Required parameters #

  • sourcePath: the absolute path of an image file.

Optional parameters #

  • maxWidth: maximum cropped image width. Note: this field is ignored on Web.

  • maxHeight: maximum cropped image height. Note: this field is ignored on Web.

  • aspectRatio: controls the aspect ratio of crop bounds. If this values is set, the cropper is locked and user can't change the aspect ratio of crop bounds. Note: this field is ignored on Web.

  • aspectRatioPresets: controls the list of aspect ratios in the crop menu view. In Android, you can set the initialized aspect ratio when starting the cropper by setting the value of AndroidUiSettings.initAspectRatio. Note: this field is ignored on Web.

  • cropStyle: controls the style of crop bounds, it can be rectangle or circle style (default is CropStyle.rectangle). Note: this field can be overrided by WebUiSettings.viewPort.type on Web

  • compressFormat: the format of result image, png or jpg (default is ImageCompressFormat.jpg).

  • compressQuality: number between 0 and 100 to control the quality of image compression.

  • uiSettings: controls UI customization on specific platform (android, ios, web,...)

Note #

  • The result file is saved in NSTemporaryDirectory on iOS and application Cache directory on Android, so it can be lost later, you are responsible for storing it somewhere permanent (if needed).

  • The implementation on Web is much different compared to the implementation on mobile app. It causes some configuration fields not working (maxWidth, maxHeight, aspectRatio, aspectRatioPresets) on Web.

  • WebUiSettings is required for Web.

Customization #

Android #

Click to view detail

Image Cropper provides a helper class called AndroidUiSettings that wraps all properties can be used to customize UI in uCrop library.

PropertyDescriptionType
toolbarTitledesired text for Toolbar titleString
toolbarColordesired color of the ToolbarColor
statusBarColordesired color of statusColor
toolbarWidgetColordesired color of Toolbar text and buttons (default is darker orange)Color
backgroundColordesired background color that should be applied to the root viewColor
activeControlsWidgetColordesired resolved color of the active and selected widget and progress wheel middle line (default is white)Color
dimmedLayerColordesired color of dimmed area around the crop boundsColor
cropFrameColordesired color of crop frameColor
cropGridColordesired color of crop grid/guidelinesColor
cropFrameStrokeWidthdesired width of crop frame line in pixelsint
cropGridRowCountcrop grid rows countint
cropGridColumnCountcrop grid columns countint
cropGridStrokeWidthdesired width of crop grid lines in pixelsint
showCropGridset to true if you want to see a crop grid/guidelines on top of an imagebool
lockAspectRatioset to true if you want to lock the aspect ratio of crop bounds with a fixed value (locked by default)bool
hideBottomControlsset to true to hide the bottom controls (shown by default)bool
initAspectRatiodesired aspect ratio is applied (from the list of given aspect ratio presets) when starting the cropperCropAspectRatioPreset

iOS #

Click to view detail

Image Cropper provides a helper class called IOUiSettings that wraps all properties can be used to customize UI in TOCropViewController library.

PropertyDescriptionType
minimumAspectRatioThe minimum croping aspect ratio. If set, user is prevented from setting cropping rectangle to lower aspect ratio than defined by the parameterdouble
rectXThe initial rect of cropping: x.double
rectYThe initial rect of cropping: y.double
rectWidthThe initial rect of cropping: width.double
rectHeightThe initial rect of cropping: height.double
showActivitySheetOnDoneIf true, when the user hits 'Done', a UIActivityController will appear before the view controller endsbool
showCancelConfirmationDialogShows a confirmation dialog when the user hits 'Cancel' and there are pending changes (default is false)bool
rotateClockwiseButtonHiddenWhen disabled, an additional rotation button that rotates the canvas in 90-degree segments in a clockwise direction is shown in the toolbar (default is false)bool
hidesNavigationBarIf this controller is embedded in UINavigationController its navigation bar is hidden by default. Set this property to false to show the navigation bar. This must be set before this controller is presentedbool
rotateButtonsHiddenWhen enabled, hides the rotation button, as well as the alternative rotation button visible when showClockwiseRotationButton is set to YES (default is false)bool
resetButtonHiddenWhen enabled, hides the 'Reset' button on the toolbar (default is false)bool
aspectRatioPickerButtonHiddenWhen enabled, hides the 'Aspect Ratio Picker' button on the toolbar (default is false)bool
resetAspectRatioEnabledIf true, tapping the reset button will also reset the aspect ratio back to the image default ratio. Otherwise, the reset will just zoom out to the current aspect ratio. If this is set to false, and aspectRatioLockEnabled is set to true, then the aspect ratio button will automatically be hidden from the toolbar (default is true)bool
aspectRatioLockDimensionSwapEnabledIf true, a custom aspect ratio is set, and the aspectRatioLockEnabled is set to true, the crop box will swap it's dimensions depending on portrait or landscape sized images. This value also controls whether the dimensions can swap when the image is rotated (default is false)bool
aspectRatioLockEnabledIf true, while it can still be resized, the crop box will be locked to its current aspect ratio. If this is set to true, and resetAspectRatioEnabled is set to false, then the aspect ratio button will automatically be hidden from the toolbar (default is false)bool
titleTitle text that appears at the top of the view controller.String
doneButtonTitleTitle for the 'Done' button. Setting this will override the Default which is a localized string for "Done"String
cancelButtonTitleTitle for the 'Cancel' button. Setting this will override the Default which is a localized string for "Cancel"String

Web #

Click to view detail

Image Cropper provides a helper class called WebUiSettings that wraps all properties can be used to customize UI in croppie library.

PropertyDescriptionType
boundaryThe outer container of the cropper. Default = { width: 500, height: 500 }Boundary
viewPortThe inner container of the coppie. The visible part of the image. Valid type values:'square' 'circle'. Default = { width: 400, height: 400, type: 'square' }ViewPort
customClassA class of your choosing to add to the container to add custom styles to your croppie. Default = ''String
enableExifEnable exif orientation reading. Tells Croppie to read exif orientation from the image data and orient the image correctly before rendering to the page. Requires exif.js (packages/croppie_dart/lib/src/exif.js)bool
enableOrientationEnable or disable support for specifying a custom orientation when binding images. Default = truebool
enableZoomEnable zooming functionality. If set to false - scrolling and pinching would not zoom. Default = falsebool
enableResizeEnable or disable support for resizing the viewport area. Default = falsebool
mouseWheelZoomEnable or disable the ability to use the mouse wheel to zoom in and out on a croppie instance. Default = truebool
showZoomerHide or show the zoom slider. Default = truebool
presentStylePresentation style of cropper, either a dialog or a page (route). Default = dialogCropperPresentStyle
contextCurrent BuildContext. The context is required to show cropper dialog or routeBuildContext
customDialogBuilderBuilder to customize the cropper DialogCropperDialogBuilder
customRouteBuilderBuilder to customize the cropper PageRouteCropperRouteBuilder

Note:

If using CropperDialogBuilder and CropperRouteBuilder to customize cropper dialog and route, the customization codes need to call crop() function to trigger crop feature and then returning the cropped result data to the plugin by using Navigator.of(context).pop(result).


 WebUiSettings(
   ...
   customDialogBuilder: (cropper, crop, rotate) {
      return Dialog(
       child: Builder(
         builder: (context) {
          return Column(
            children: [
              ...
              cropper,
              ...
              TextButton(
                onPressed: () async {
                  /// it is important to call crop() function and return
                  /// result data to plugin, for example:
                  final result = await crop();
                  Navigator.of(context).pop(result);
                },
                child: Text('Crop'),
              )
            ]
          );
        },
       ),
     );
   },
   ...
 )

Example #


import 'package:image_cropper/image_cropper.dart';

CroppedFile croppedFile = await ImageCropper().cropImage(
      sourcePath: imageFile.path,
      aspectRatioPresets: [
        CropAspectRatioPreset.square,
        CropAspectRatioPreset.ratio3x2,
        CropAspectRatioPreset.original,
        CropAspectRatioPreset.ratio4x3,
        CropAspectRatioPreset.ratio16x9
      ],
      uiSettings: [
        AndroidUiSettings(
            toolbarTitle: 'Cropper',
            toolbarColor: Colors.deepOrange,
            toolbarWidgetColor: Colors.white,
            initAspectRatio: CropAspectRatioPreset.original,
            lockAspectRatio: false),
        IOSUiSettings(
          title: 'Cropper',
        ),
        WebUiSettings(
          context: context,
        ),
      ],
    );
    

Credits #

1483
likes
125
pub points
100%
popularity

Publisher

verified publisher iconhunghd.dev

A Flutter plugin for Android, iOS and Web supports cropping images

Repository (GitHub)

Documentation

API reference

License

Icon for licenses.BSD-3-Clause (LICENSE)

Dependencies

flutter, image_cropper_for_web, image_cropper_platform_interface

More

Packages that depend on image_cropper