Transformations UI for iOS

Requirements

• Xcode 12+
• Swift 4.2+ / Objective-C
• iOS 11.0+ / iPadOS 13.0+

Installation

To install our Swift Package, please follow the steps below:

• Add https://github.com/filestack/transformations-ui-ios.git as a Swift Package Manager dependency to your project.
• When asked to Choose Package Options, use the default settings provided by Xcode.
• When asked to Add Package, add TransformationsUI to your desired target(s).

Usage

1. Import TransformationsUI

   import TransformationsUI

2. Instantiate TransformationsUI and set delegate

   let transformationsUI = TransformationsUI()
   transformationsUI.delegate = self

3. Add conformance to TransformationsUIDelegate

   extension ViewController: TransformationsUIDelegate {
       func editorDismissed(with image: UIImage?) {
           if let image = image {
               // TODO: Do something with resulting image...
           }
       }
   }

4. Present TransformationsUI view controller

   if let editorVC = transformationsUI.editor(with: image) {
       editorVC.modalPresentationStyle = .fullScreen
       present(editorVC, animated: true)
   }

Modules Features

Below you will find an exhaustive list of configurable properties and commands per module.

Transform Module

Commands

Filters Module

Commands

Adjustments Module

Commands

Text Module

Properties

Commands

Stickers Module

Properties

Overlays Module

Properties

Border Module

Commands

Enabling or Disabling Modules

Modules may be enabled or disabled programmatically. Let’s see an example:

1. Defining the available modules

   modules.all = [
       modules.transform,
       modules.filters,
       modules.adjustments
   ]

Enabling or Disabling Module Features

Module features may be enabled or disabled programmatically. Let’s see a few examples:

1. Allow only circle crop in transform module

   modules.transform.cropCommands = [
       Modules.Transform.Commands.Crop(type: .none),
       Modules.Transform.Commands.Crop(type: .circle)
   ]

2. Disable extra commands in transform module

   modules.transform.extraCommands = []

3. Define custom crop modes in transform module

   // Keep original ratio
   modules.transform.cropCommands.append(
       Modules.Transform.Commands.Crop(type: .rect, aspectRatio: .original)
   )
   
   // Keep 16:9 ratio
   modules.transform.cropCommands.append(
       Modules.Transform.Commands.Crop(type: .rect, aspectRatio: .custom(CGSize(width: 16, height: 9)))
   )

4. Define available filters in filters module

   modules.filters.commands = [
       Modules.Filters.Commands.Filter(type: .chrome),
       Modules.Filters.Commands.Filter(type: .process),
       Modules.Filters.Commands.Filter(type: .instant)
   ]

5. Add extra available font families in text module

   modules.text.availableFontFamilies.append(contentsOf: ["Optima Regular", "Symbol"])

   Or you may want to replace available font families completely:

   modules.text.availableFontFamilies = ["Optima Regular", "Symbol"]

6. Add stickers in stickers module

   modules.sticker.stickers = [
       "Funny": (1...18).compactMap { UIImage(named: "stickers-funny-\($0)") },
       "Hilarious": (1...18).compactMap { UIImage(named: "stickers-hilarious-\($0)") },
       "Extravagant": (1...18).compactMap { UIImage(named: "stickers-extravagant-\($0)") },
       "Kick-ass": (1...18).compactMap { UIImage(named: "stickers-kickass-\($0)") }
   ]

To discover other module features that may be configured, enabled, or disabled, try Xcode’s autocompletion on your Modules objects.

Demo

Check the demo showcasing Transformations UI usage.

Screenshots