README.md

May 22, 2026 ยท View on GitHub

Version Carthage compatible SwiftPM compatible License Platform Language


ZLImageEditor is a powerful image editor framework. Supports graffiti, cropping, mosaic, text stickers, picture stickers, filters, adjust(brightness, contrast, saturation).

ZLImageEditor is extracted from ZLPhotoBrowser.

Directory

Features

  • Draw (Support custom line color).
  • Crop (Support custom crop ratios).
  • Image sticker (Support custom image sticker container view).
  • Text sticker (Support custom text color).
  • Mosaic.
  • Filter (Support custom filters).
  • Adjust (Brightness, Contrast, Saturation).

Requirements

v >= 2.0.0iOS 10.0+
v < 2.0.0iOS 9.0+
  • Swift 5.x
  • Xcode 12.x

Usage

ZLImageEditorConfiguration.default()
    .editImageTools([.draw, .clip, .imageSticker, .textSticker, .mosaic, .filter, .adjust])
    .adjustTools([.brightness, .contrast, .saturation])

ZLEditImageViewController.showEditImageVC(parentVC: self, image: image, editModel: editModel) { [weak self] (resImage, editModel) in
    // your code
}

Change Log

More logs

โ— 3.0.0
  Add:
    Improved sticker editing interactions with coordinated gesture handling.
    Added dedicated text sticker content rendering for a clearer editing experience.
    Improved doodle smoothing and eraser hit detection for smoother drawing and more reliable stroke removal.
โ— 2.0.6
  Fix:
    Fixed the issue where the eraser position was displayed incorrectly when editing pictures.
โ— 2.0.5
  Add:
    Support SwiftUI.
  Fix:
    Fix retain cycle in ZLEditImageViewController.
    Correct eraser misalignment after image cropping.
...

Languages

๐Ÿ‡จ๐Ÿ‡ณ Chinese (Simplified/Traditional), ๐Ÿ‡บ๐Ÿ‡ธ English, ๐Ÿ‡ฏ๐Ÿ‡ต Japanese, ๐Ÿ‡ซ๐Ÿ‡ท French, ๐Ÿ‡ฉ๐Ÿ‡ช German, ๐Ÿ‡บ๐Ÿ‡ฆ Ukranian, ๐Ÿ‡ท๐Ÿ‡บ Russian, ๐Ÿ‡ป๐Ÿ‡ณ Vietnamese, ๐Ÿ‡ฐ๐Ÿ‡ท Korean, ๐Ÿ‡ฒ๐Ÿ‡พ Malay, ๐Ÿ‡ฎ๐Ÿ‡น Italian, ๐Ÿ‡ฎ๐Ÿ‡ฉ Indonesian, ๐Ÿ‡ช๐Ÿ‡ธ Spanish, ๐Ÿ‡ต๐Ÿ‡น Portuguese, ๐Ÿ‡น๐Ÿ‡ท Turkey, ๐Ÿ‡ธ๐Ÿ‡ฆ Arabic, ๐Ÿ‡ณ๐Ÿ‡ฑ Dutch.

Installation

There are four ways to use ZLImageEditor in your project:

  • using CocoaPods
  • using Carthage
  • using Swift Package Manager
  • manual install (build frameworks or embed Xcode Project)

CocoaPods

To integrate ZLImageEditor into your Xcode project using CocoaPods, specify it to a target in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!

target 'MyApp' do
  # your other pod
  # ...
  pod 'ZLImageEditor'
end

Then, run the following command:

$ pod install

If you cannot find the latest version, you can execute pod repo update first

Carthage

To integrate ZLImageEditor into your Xcode project using Carthage, specify it in your Cartfile:

github "longitachi/ZLImageEditor"

Then, run the following command to build the ZLImageEditor framework:

$ carthage update ZLImageEditor

Swift Package Manager

  1. Select File > Swift Packages > Add Package Dependency. Enter https://github.com/longitachi/ZLImageEditor.git in the "Choose Package Repository" dialog.
  2. In the next page, specify the version resolving rule as "Up to Next Major" with "3.0.0" as its earliest version.
  3. After Xcode checking out the source and resolving the version, you can choose the "ZLImageEditor" library and add it to your app target.

Support

Demo Effect

image