@codebymanan/react-native-photo-editor 0.1.1 → 0.2.0

package/PhotoEditor.podspec

@@ -17,7 +17,8 @@ Pod::Spec.new do |s|
   s.private_header_files = "ios/**/*.h"
   s.swift_version = "5.0"
 
-  s.dependency "ZLImageEditor", "~> 3.0"
+  s.frameworks = "Photos"
+  s.dependency "ZLImageEditor", "~> 4.0"
 
   install_modules_dependencies(s)
 end

package/README.md

@@ -20,15 +20,51 @@ const editedPath = await open({
 ```
 
 `open()` resolves with the file path of the edited image, or rejects with
-`E_CANCELLED` if the user backs out.
+`E_CANCELLED` if the user backs out (see [Errors](#errors)).
 
 | Option | Type | Description |
 | --- | --- | --- |
-| `path` | `string` | **Required.** Image to edit. Accepts a local file path, a `file://` or `content://` URI, or a remote `http(s)` URL. |
-| `stickers` | `string[]` | Sticker image URLs shown in the sticker picker. |
+| `path` | `string` | **Required.** Image to edit. Accepts a local file path, a `file://` URI, a remote `http(s)` URL, a `content://` URI (Android) or a `ph://` photo library URI (iOS, see below). |
+| `stickers` | `string[]` | Sticker images shown in the sticker picker, as remote URLs or local paths. On iOS the sticker tool only appears when this is non-empty. |
 | `language` | `string` | BCP-47 tag (`'fr'`, `'pt-BR'`, `'zh-Hans'`) for the editor UI. Defaults to the device language. See [Localization](#localization). |
 | `translations` | `Record<string, string>` | Per-key string overrides. See [Localization](#localization). |
 
+### Stickers
+
+Pass the images you want in the sticker picker as `stickers`. Each entry is a
+remote `http(s)` URL or a path to a file on the device; transparent PNGs work
+best.
+
+```js
+const STICKERS = [
+  'https://example.com/stickers/heart.png',
+  'https://example.com/stickers/star.png',
+  `${RNFS.DocumentDirectoryPath}/stickers/smile.png`, // a file you saved earlier
+];
+
+await open({ path, stickers: STICKERS });
+```
+
+The user opens the sticker tool, taps a sticker to drop it onto the photo, then
+drags, pinches and rotates it into place. Stickers load in the background, so
+remote ones appear in the picker as they arrive.
+
+Images bundled with `require('./sticker.png')` are not file paths in release
+builds, so they cannot be passed directly. Host them remotely or copy them to
+the device first.
+
+When `stickers` is omitted or empty the platforms differ: **iOS** hides the
+sticker tool, while **Android** shows a small built-in set of sample stickers.
+Pass your own list if you want the same behaviour on both.
+
+### Photo library URIs on iOS
+
+`ph://` URIs, as returned by pickers such as
+`@react-native-camera-roll/camera-roll`, are loaded through the Photos
+framework. iCloud-only photos are downloaded on demand. Your app needs an
+`NSPhotoLibraryUsageDescription` entry in its `Info.plist`; if the user has
+never been asked, the editor asks for access before loading the photo.
+
 ## Localization
 
 By default the editor follows the device language on both platforms. Pass
@@ -185,6 +221,48 @@ underlying editor never sets `semanticContentAttribute`. So the iOS editor lays
 out right-to-left when your app itself is running in an RTL language, and not
 because of this option.
 
+## Errors
+
+`open()` rejects with one of these codes on `error.code`:
+
+| Code | When |
+| --- | --- |
+| `E_CANCELLED` | The user closed the editor without saving. Usually not an error worth showing. |
+| `E_IN_PROGRESS` | `open()` was called while another editor session was still open. |
+| `E_INVALID_OPTIONS` | `path` was missing or empty. |
+| `E_NO_ACTIVITY` | There was no screen to present the editor from, e.g. the app was in the background. |
+| `E_FAILED` | The image could not be loaded or saved. `error.message` says which, including a missing photo library permission on iOS. |
+
+```js
+try {
+  const edited = await open({ path });
+} catch (e) {
+  if (e.code !== 'E_CANCELLED') {
+    console.warn(e.code, e.message);
+  }
+}
+```
+
+## Testing with Jest
+
+The native module is not available under Jest. Mock it with the bundled stub,
+whose `open` resolves with a fake path and can be overridden per test:
+
+```js
+// jest.setup.js
+jest.mock('@codebymanan/react-native-photo-editor', () =>
+  require('@codebymanan/react-native-photo-editor/jest/mock')
+);
+```
+
+```js
+import { open } from '@codebymanan/react-native-photo-editor';
+
+open.mockRejectedValueOnce(
+  Object.assign(new Error('cancelled'), { code: 'E_CANCELLED' })
+);
+```
+
 ## Contributing
 
 - [Development workflow](CONTRIBUTING.md#development-workflow)

package/android/build.gradle

@@ -50,7 +50,7 @@ dependencies {
   implementation "com.facebook.react:react-android"
 
   // Editing engine
-  implementation "com.burhanrashid52:photoeditor:3.0.2"
+  implementation "com.burhanrashid52:photoeditor:3.1.1"
 
   // Editor screen UI
   implementation "androidx.appcompat:appcompat:1.7.0"

package/android/src/main/java/com/photoeditor/PhotoEditorModule.kt

@@ -55,7 +55,7 @@ class PhotoEditorModule(reactContext: ReactApplicationContext) :
   }
 
   override fun open(options: ReadableMap, promise: Promise) {
-    val activity = currentActivity
+    val activity = reactApplicationContext.currentActivity
     if (activity == null) {
       promise.reject(E_NO_ACTIVITY, "No activity attached to React context")
       return

package/android/src/main/java/com/photoeditor/editor/EditImageActivity.kt

@@ -128,6 +128,7 @@ class EditImageActivity : BaseActivity(), OnPhotoEditorListener, View.OnClickLis
             .build()
 
         mPhotoEditor.setOnPhotoEditorListener(this)
+        updateUndoRedoState()
 
         loadSourceImage()
     }
@@ -195,10 +196,12 @@ class EditImageActivity : BaseActivity(), OnPhotoEditorListener, View.OnClickLis
 
     override fun onAddViewListener(viewType: ViewType, numberOfAddedViews: Int) {
         Log.d(TAG, "onAddViewListener() called with: viewType = [$viewType]")
+        updateUndoRedoState()
     }
 
     override fun onRemoveViewListener(viewType: ViewType, numberOfAddedViews: Int) {
         Log.d(TAG, "onRemoveViewListener() called with: viewType = [$viewType]")
+        updateUndoRedoState()
     }
 
     override fun onStartViewChangeListener(viewType: ViewType) {
@@ -207,6 +210,14 @@ class EditImageActivity : BaseActivity(), OnPhotoEditorListener, View.OnClickLis
 
     override fun onStopViewChangeListener(viewType: ViewType) {
         Log.d(TAG, "onStopViewChangeListener() called with: viewType = [$viewType]")
+        // A finished brush stroke clears the redo stack without firing add/remove
+        updateUndoRedoState()
+    }
+
+    /** Greys out undo/redo when there is nothing to step through, via the pe_undo/pe_redo selectors. */
+    private fun updateUndoRedoState() {
+        mImgUndo.isEnabled = mPhotoEditor.isUndoAvailable
+        mImgRedo.isEnabled = mPhotoEditor.isRedoAvailable
     }
 
     override fun onTouchSourceImage(event: MotionEvent) {
@@ -216,8 +227,14 @@ class EditImageActivity : BaseActivity(), OnPhotoEditorListener, View.OnClickLis
     @SuppressLint("NonConstantResourceId")
     override fun onClick(view: View) {
         when (view.id) {
-            R.id.imgUndo -> mPhotoEditor.undo()
-            R.id.imgRedo -> mPhotoEditor.redo()
+            R.id.imgUndo -> {
+                mPhotoEditor.undo()
+                updateUndoRedoState()
+            }
+            R.id.imgRedo -> {
+                mPhotoEditor.redo()
+                updateUndoRedoState()
+            }
 
             R.id.imgSave -> saveImage()
             R.id.imgClose -> onBackPressed()

package/ios/PhotoEditorManager.swift

@@ -1,9 +1,14 @@
+import Photos
 import UIKit
 import ZLImageEditor
 
 @objc(PhotoEditorManager)
 public class PhotoEditorManager: NSObject {
 
+  /// True from the moment `open()` accepts a call until its promise settles,
+  /// which spans the image load as well as the editor itself. Main thread only.
+  private static var isSessionActive = false
+
   @objc public static func open(
     _ path: String,
     stickers: [String],
@@ -12,10 +17,46 @@ public class PhotoEditorManager: NSObject {
     resolve: @escaping (String) -> Void,
     reject: @escaping (String, String) -> Void
   ) {
-    loadImage(path) { image in
+    DispatchQueue.main.async {
+      guard !isSessionActive else {
+        reject("E_IN_PROGRESS", "Another editor session is already open")
+        return
+      }
+      isSessionActive = true
+
+      // Every settlement below already happens on the main thread.
+      startSession(
+        path,
+        stickers: stickers,
+        language: language,
+        translations: translations,
+        resolve: { outputPath in
+          isSessionActive = false
+          resolve(outputPath)
+        },
+        reject: { code, message in
+          isSessionActive = false
+          reject(code, message)
+        })
+    }
+  }
+
+  private static func startSession(
+    _ path: String,
+    stickers: [String],
+    language: String?,
+    translations: [String: Any]?,
+    resolve: @escaping (String) -> Void,
+    reject: @escaping (String, String) -> Void
+  ) {
+    loadImage(path) { result in
       DispatchQueue.main.async {
-        guard let image else {
-          reject("E_FAILED", "Could not load image: \(path)")
+        let image: UIImage
+        switch result {
+        case .success(let loaded):
+          image = loaded
+        case .failure(let error):
+          reject("E_FAILED", error.message)
           return
         }
         guard let presenter = topViewController() else {
@@ -27,9 +68,12 @@ public class PhotoEditorManager: NSObject {
           .languageType(languageType(for: language))
           .customLanguageConfig(customLanguage(from: translations))
 
+        // Assigned on every call, nil included: the configuration is a shared
+        // singleton, and the editor hides the sticker tool when this is nil.
         ZLImageEditorConfiguration.default()
-          .editImageTools([.draw, .clip, .textSticker, .mosaic, .filter, .adjust])
+          .editImageTools([.draw, .clip, .imageSticker, .textSticker, .mosaic, .filter, .adjust])
           .adjustTools([.brightness, .contrast, .saturation])
+          .imageStickerContainerView(stickers.isEmpty ? nil : StickerContainerView(urls: stickers))
 
         let editor = ZLEditImageViewController(image: image)
         editor.modalPresentationStyle = .fullScreen
@@ -112,18 +156,93 @@ public class PhotoEditorManager: NSObject {
     }
   }
 
-  private static func loadImage(_ path: String, completion: @escaping (UIImage?) -> Void) {
-    if path.hasPrefix("http://") || path.hasPrefix("https://") {
+  struct LoadError: Error {
+    let message: String
+  }
+
+  /// Loads the editor image or a sticker. `completion` may run on any queue.
+  static func loadImage(_ path: String, completion: @escaping (Result<UIImage, LoadError>) -> Void) {
+    let failed = LoadError(message: "Could not load image: \(path)")
+
+    if path.hasPrefix("ph://") {
+      loadPhotoLibraryImage(localIdentifier: String(path.dropFirst(5)), path: path, completion: completion)
+    } else if path.hasPrefix("http://") || path.hasPrefix("https://") {
       guard let url = URL(string: path) else {
-        completion(nil)
+        completion(.failure(failed))
         return
       }
       URLSession.shared.dataTask(with: url) { data, _, _ in
-        completion(data.flatMap(UIImage.init(data:)))
+        guard let image = data.flatMap(UIImage.init(data:)) else {
+          completion(.failure(failed))
+          return
+        }
+        completion(.success(image))
       }.resume()
     } else {
       let filePath = path.hasPrefix("file://") ? String(path.dropFirst(7)) : path
-      completion(UIImage(contentsOfFile: filePath))
+      guard let image = UIImage(contentsOfFile: filePath) else {
+        completion(.failure(failed))
+        return
+      }
+      completion(.success(image))
+    }
+  }
+
+  /// Resolves a `ph://` URI, as returned by photo pickers such as
+  /// @react-native-camera-roll/camera-roll, through the Photos framework.
+  private static func loadPhotoLibraryImage(
+    localIdentifier: String,
+    path: String,
+    completion: @escaping (Result<UIImage, LoadError>) -> Void
+  ) {
+    withPhotoLibraryAccess { granted in
+      guard granted else {
+        completion(.failure(LoadError(
+          message: "Photo library access is needed to load \(path)")))
+        return
+      }
+
+      // Some pickers hand out only the asset UUID, without the "/L0/001"
+      // suffix that a full local identifier carries; try both.
+      var identifiers = [localIdentifier]
+      if !localIdentifier.contains("/") {
+        identifiers.append("\(localIdentifier)/L0/001")
+      }
+      guard let asset = PHAsset.fetchAssets(withLocalIdentifiers: identifiers, options: nil).firstObject
+      else {
+        completion(.failure(LoadError(message: "No photo library asset found for \(path)")))
+        return
+      }
+
+      let options = PHImageRequestOptions()
+      // Lets iCloud-only photos download instead of failing.
+      options.isNetworkAccessAllowed = true
+      options.deliveryMode = .highQualityFormat
+      options.version = .current
+
+      PHImageManager.default().requestImageDataAndOrientation(for: asset, options: options) {
+        data, _, _, _ in
+        guard let image = data.flatMap(UIImage.init(data:)) else {
+          completion(.failure(LoadError(message: "Could not load image: \(path)")))
+          return
+        }
+        completion(.success(image))
+      }
+    }
+  }
+
+  /// Only prompts when the user has never been asked. Limited access counts as
+  /// granted: the asset is reachable if the user included it in the selection.
+  private static func withPhotoLibraryAccess(_ completion: @escaping (Bool) -> Void) {
+    switch PHPhotoLibrary.authorizationStatus(for: .readWrite) {
+    case .authorized, .limited:
+      completion(true)
+    case .notDetermined:
+      PHPhotoLibrary.requestAuthorization(for: .readWrite) { status in
+        completion(status == .authorized || status == .limited)
+      }
+    default:
+      completion(false)
     }
   }
 

package/ios/StickerContainerView.swift

@@ -0,0 +1,179 @@
+import UIKit
+import ZLImageEditor
+
+/// Bottom sheet listing the `stickers` passed to `open()`.
+///
+/// ZLImageEditor only offers its image sticker tool when a view conforming to
+/// `ZLImageStickerContainerDelegate` is configured, and leaves showing, hiding
+/// and populating it entirely to that view.
+final class StickerContainerView: UIView, ZLImageStickerContainerDelegate {
+
+  var selectImageBlock: ((UIImage) -> Void)?
+  var hideBlock: (() -> Void)?
+
+  private static let sheetHeightRatio: CGFloat = 0.45
+  private static let cellSpacing: CGFloat = 12
+  private static let columns: CGFloat = 4
+
+  private let urls: [String]
+  /// Indexed like `urls`; nil until that sticker has loaded, and stays nil if it fails.
+  private var images: [UIImage?]
+
+  private let sheet = UIView()
+  private let collectionView: UICollectionView
+
+  init(urls: [String]) {
+    self.urls = urls
+    self.images = Array(repeating: nil, count: urls.count)
+
+    let layout = UICollectionViewFlowLayout()
+    layout.minimumInteritemSpacing = Self.cellSpacing
+    layout.minimumLineSpacing = Self.cellSpacing
+    layout.sectionInset = UIEdgeInsets(
+      top: Self.cellSpacing, left: Self.cellSpacing, bottom: Self.cellSpacing, right: Self.cellSpacing)
+    collectionView = UICollectionView(frame: .zero, collectionViewLayout: layout)
+
+    super.init(frame: .zero)
+
+    // Tapping the dimmed area above the sheet dismisses it; the editor does not.
+    let dismissTap = UITapGestureRecognizer(target: self, action: #selector(hide))
+    dismissTap.delegate = self
+    addGestureRecognizer(dismissTap)
+
+    sheet.backgroundColor = UIColor(white: 0.1, alpha: 0.95)
+    sheet.layer.cornerRadius = 12
+    sheet.layer.maskedCorners = [.layerMinXMinYCorner, .layerMaxXMinYCorner]
+    addSubview(sheet)
+
+    collectionView.backgroundColor = .clear
+    collectionView.dataSource = self
+    collectionView.delegate = self
+    collectionView.register(StickerCell.self, forCellWithReuseIdentifier: StickerCell.reuseIdentifier)
+    sheet.addSubview(collectionView)
+
+    loadStickers()
+  }
+
+  @available(*, unavailable)
+  required init?(coder: NSCoder) {
+    fatalError("init(coder:) has not been implemented")
+  }
+
+  // MARK: - ZLImageStickerContainerDelegate
+
+  func show(in view: UIView) {
+    if superview !== view {
+      removeFromSuperview()
+      view.addSubview(self)
+    }
+    frame = view.bounds
+    autoresizingMask = [.flexibleWidth, .flexibleHeight]
+    isHidden = false
+    layoutIfNeeded()
+
+    sheet.transform = CGAffineTransform(translationX: 0, y: sheet.bounds.height)
+    backgroundColor = .clear
+    UIView.animate(withDuration: 0.25) {
+      self.sheet.transform = .identity
+      self.backgroundColor = UIColor(white: 0, alpha: 0.3)
+    }
+  }
+
+  @objc private func hide() {
+    UIView.animate(withDuration: 0.25, animations: {
+      self.sheet.transform = CGAffineTransform(translationX: 0, y: self.sheet.bounds.height)
+      self.backgroundColor = .clear
+    }, completion: { _ in
+      self.isHidden = true
+      self.sheet.transform = .identity
+    })
+    hideBlock?()
+  }
+
+  // MARK: - Layout
+
+  override func layoutSubviews() {
+    super.layoutSubviews()
+    let height = bounds.height * Self.sheetHeightRatio
+    sheet.frame = CGRect(x: 0, y: bounds.height - height, width: bounds.width, height: height)
+    collectionView.frame = sheet.bounds
+    collectionView.contentInset.bottom = safeAreaInsets.bottom
+  }
+
+  // MARK: - Loading
+
+  private func loadStickers() {
+    for (index, url) in urls.enumerated() {
+      PhotoEditorManager.loadImage(url) { [weak self] result in
+        guard case .success(let image) = result else { return }
+        DispatchQueue.main.async {
+          guard let self else { return }
+          self.images[index] = image
+          self.collectionView.reloadItems(at: [IndexPath(item: index, section: 0)])
+        }
+      }
+    }
+  }
+}
+
+extension StickerContainerView: UIGestureRecognizerDelegate {
+  func gestureRecognizer(_ gestureRecognizer: UIGestureRecognizer, shouldReceive touch: UITouch) -> Bool {
+    !sheet.frame.contains(touch.location(in: self))
+  }
+}
+
+extension StickerContainerView: UICollectionViewDataSource, UICollectionViewDelegateFlowLayout {
+  func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
+    urls.count
+  }
+
+  func collectionView(
+    _ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath
+  ) -> UICollectionViewCell {
+    let cell = collectionView.dequeueReusableCell(
+      withReuseIdentifier: StickerCell.reuseIdentifier, for: indexPath) as! StickerCell
+    cell.imageView.image = images[indexPath.item]
+    return cell
+  }
+
+  func collectionView(
+    _ collectionView: UICollectionView,
+    layout collectionViewLayout: UICollectionViewLayout,
+    sizeForItemAt indexPath: IndexPath
+  ) -> CGSize {
+    let gaps = Self.cellSpacing * (Self.columns + 1)
+    let side = floor((collectionView.bounds.width - gaps) / Self.columns)
+    return CGSize(width: side, height: side)
+  }
+
+  func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
+    // A sticker that has not loaded (or failed to) has nothing to add.
+    guard let image = images[indexPath.item] else { return }
+    selectImageBlock?(image)
+    hide()
+  }
+}
+
+private final class StickerCell: UICollectionViewCell {
+  static let reuseIdentifier = "StickerCell"
+
+  let imageView = UIImageView()
+
+  override init(frame: CGRect) {
+    super.init(frame: frame)
+    imageView.contentMode = .scaleAspectFit
+    imageView.frame = contentView.bounds
+    imageView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
+    contentView.addSubview(imageView)
+  }
+
+  @available(*, unavailable)
+  required init?(coder: NSCoder) {
+    fatalError("init(coder:) has not been implemented")
+  }
+
+  override func prepareForReuse() {
+    super.prepareForReuse()
+    imageView.image = nil
+  }
+}

package/jest/mock.js

@@ -0,0 +1,7 @@
+/* global jest */
+// Stands in for the native module in Jest, where TurboModules are unavailable.
+// Usage: jest.mock('@codebymanan/react-native-photo-editor', () =>
+//   require('@codebymanan/react-native-photo-editor/jest/mock'));
+module.exports = {
+  open: jest.fn(() => Promise.resolve('/tmp/photo_editor/edited.png')),
+};

package/lib/typescript/src/types.d.ts

@@ -1,11 +1,13 @@
 export interface PhotoEditorOptions {
     /**
-     * The image to edit. Accepts a local file path, `file://` or `content://`
-     * URI, or a remote `http(s)` URL.
+     * The image to edit. Accepts a local file path, `file://` URI, or a remote
+     * `http(s)` URL, plus `content://` URIs on Android and `ph://` photo library
+     * URIs on iOS.
      */
     path: string;
     /**
-     * Optional list of sticker image URLs shown in the sticker picker.
+     * Optional list of sticker images (remote URLs or local paths) shown in the
+     * sticker picker. On iOS the sticker tool only appears when this is set.
      */
     stickers?: string[];
     /**

package/lib/typescript/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC1C"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC1C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codebymanan/react-native-photo-editor",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A React Native photo editor plugin wrapping native editors for Android and iOS",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
@@ -10,6 +10,7 @@
       "types": "./lib/typescript/src/index.d.ts",
       "default": "./lib/module/index.js"
     },
+    "./jest/mock": "./jest/mock.js",
     "./package.json": "./package.json"
   },
   "files": [
@@ -20,6 +21,7 @@
     "cpp",
     "*.podspec",
     "react-native.config.js",
+    "jest",
     "!ios/build",
     "!android/build",
     "!android/gradle",

package/src/types.ts

@@ -1,11 +1,13 @@
 export interface PhotoEditorOptions {
   /**
-   * The image to edit. Accepts a local file path, `file://` or `content://`
-   * URI, or a remote `http(s)` URL.
+   * The image to edit. Accepts a local file path, `file://` URI, or a remote
+   * `http(s)` URL, plus `content://` URIs on Android and `ph://` photo library
+   * URIs on iOS.
    */
   path: string;
   /**
-   * Optional list of sticker image URLs shown in the sticker picker.
+   * Optional list of sticker images (remote URLs or local paths) shown in the
+   * sticker picker. On iOS the sticker tool only appears when this is set.
    */
   stickers?: string[];
   /**