@imgly/editor-react-native 1.73.0 → 1.74.0

package/ios/StarterKits/Apparel/components/CanvasMenu+Apparel.swift

@@ -0,0 +1,22 @@
+import IMGLYEditor
+
+// MARK: - Canvas Menu
+
+extension ApparelEditorConfiguration {
+  /// The default canvas menu configuration.
+  static var defaultCanvasMenu: CanvasMenu.Configuration {
+    CanvasMenu.Configuration { builder in
+      // highlight-starter-kit-canvas-menu
+      builder.items { _ in
+        CanvasMenu.Buttons.selectGroup()
+        CanvasMenu.Divider()
+        CanvasMenu.Buttons.bringForward()
+        CanvasMenu.Buttons.sendBackward()
+        CanvasMenu.Divider()
+        CanvasMenu.Buttons.duplicate()
+        CanvasMenu.Buttons.delete()
+      }
+      // highlight-starter-kit-canvas-menu
+    }
+  }
+}

package/ios/StarterKits/Apparel/components/Dock+Apparel.swift

@@ -0,0 +1,19 @@
+import IMGLYEditor
+
+// MARK: - Dock
+
+extension ApparelEditorConfiguration {
+  /// The default dock configuration.
+  static var defaultDock: Dock.Configuration {
+    Dock.Configuration { builder in
+      // highlight-starter-kit-dock
+      builder.items { _ in
+        Dock.Buttons.assetLibrary(modifier: { _ in Dock.Buttons.AssetLibraryModifier() })
+      }
+      builder.alignment = { _ in .leading }
+      builder.backgroundColor = { _, _ in .clear }
+      builder.scrollDisabled = { _ in true }
+      // highlight-starter-kit-dock
+    }
+  }
+}

package/ios/StarterKits/Apparel/components/InspectorBar+Apparel.swift

@@ -0,0 +1,35 @@
+import IMGLYEditor
+
+// MARK: - Inspector Bar
+
+extension ApparelEditorConfiguration {
+  /// The default inspector bar configuration.
+  static var defaultInspectorBar: InspectorBar.Configuration {
+    InspectorBar.Configuration { builder in
+      // highlight-starter-kit-inspector-bar
+      builder.items { _ in
+        InspectorBar.Buttons.replace()
+
+        InspectorBar.Buttons.editText()
+        InspectorBar.Buttons.formatText()
+        InspectorBar.Buttons.fillStroke()
+        InspectorBar.Buttons.textBackground()
+        InspectorBar.Buttons.crop()
+
+        InspectorBar.Buttons.adjustments()
+        InspectorBar.Buttons.filter()
+        InspectorBar.Buttons.effect()
+        InspectorBar.Buttons.blur()
+        InspectorBar.Buttons.shape()
+
+        InspectorBar.Buttons.selectGroup()
+        InspectorBar.Buttons.enterGroup()
+
+        InspectorBar.Buttons.layer()
+        InspectorBar.Buttons.duplicate()
+        InspectorBar.Buttons.delete()
+      }
+      // highlight-starter-kit-inspector-bar
+    }
+  }
+}

package/ios/StarterKits/Apparel/components/NavigationBar+Apparel.swift

@@ -0,0 +1,26 @@
+import IMGLYEditor
+
+// MARK: - Navigation Bar
+
+extension ApparelEditorConfiguration {
+  /// The default navigation bar configuration.
+  static var defaultNavigationBar: NavigationBar.Configuration {
+    NavigationBar.Configuration { builder in
+      // highlight-starter-kit-navigation-bar
+      builder.items { _ in
+        NavigationBar.ItemGroup(placement: .topBarLeading) {
+          NavigationBar.Buttons.closeEditor()
+        }
+        NavigationBar.ItemGroup(placement: .principal) {
+          NavigationBar.Buttons.undo()
+          NavigationBar.Buttons.redo()
+          NavigationBar.Buttons.togglePreviewMode()
+        }
+        NavigationBar.ItemGroup(placement: .topBarTrailing) {
+          NavigationBar.Buttons.export()
+        }
+      }
+      // highlight-starter-kit-navigation-bar
+    }
+  }
+}

package/ios/StarterKits/Design/DesignEditorConfiguration.swift

@@ -0,0 +1,43 @@
+import IMGLYEditor
+import IMGLYEngine
+import SwiftUI
+
+// CE.SDK Starter Kit: Design Editor
+//
+// This starter kit provides a complete, production-ready Design Editor configuration
+// with all configuration code inline and fully documented. Copy this file into your
+// project and customize it to match your needs.
+
+// MARK: - Configuration
+
+/// A composable Design Editor configuration.
+public final class DesignEditorConfiguration: EditorConfiguration {
+  // MARK: - EditorConfiguration — Settings
+
+  /// The zoom padding for the canvas.
+  override public var zoomPadding: CGFloat? { 16 }
+
+  // MARK: - EditorConfiguration — Callbacks
+
+  /// The `onCreate` handler.
+  override public var onCreate: OnCreate.Handler? { Self.defaultOnCreateHandler }
+
+  /// The export handler.
+  ///
+  /// Default: Exports the scene as PDF and opens the system share sheet.
+  override public var onExport: OnExport.Handler? { Self.defaultOnExportHandler }
+
+  // MARK: - EditorConfiguration — UI Components
+
+  /// The navigation bar configuration.
+  override public var navigationBar: NavigationBar.Configuration? { Self.defaultNavigationBar }
+
+  /// The dock configuration.
+  override public var dock: Dock.Configuration? { Self.defaultDock }
+
+  /// The inspector bar configuration.
+  override public var inspectorBar: InspectorBar.Configuration? { Self.defaultInspectorBar }
+
+  /// The canvas menu configuration.
+  override public var canvasMenu: CanvasMenu.Configuration? { Self.defaultCanvasMenu }
+}

package/ios/StarterKits/Design/DesignEditorStarterKit.swift

@@ -0,0 +1,30 @@
+import IMGLYEditor
+import IMGLYEngine
+import SwiftUI
+
+// MARK: - Starter Kit View
+
+struct DesignEditorStarterKit: View {
+  // Provide `EngineSettings` with your license and an optional userId.
+  let settings = EngineSettings(
+    license: secrets.licenseKey, // Use nil for evaluation mode with watermark
+    userID: "<your unique user id>",
+  )
+
+  // highlight-starter-kit-view
+  var body: some View {
+    // highlight-starter-kit-composable
+    Editor(settings)
+      .imgly.configuration {
+        DesignEditorConfiguration()
+      }
+    // highlight-starter-kit-composable
+  }
+  // highlight-starter-kit-view
+}
+
+// MARK: - Preview
+
+#Preview {
+  DesignEditorStarterKit()
+}

package/ios/StarterKits/Design/callbacks/OnCreate+Design.swift

@@ -0,0 +1,131 @@
+import Foundation
+import IMGLYEditor
+import IMGLYEngine
+
+// MARK: - Default OnCreate
+
+public extension DesignEditorConfiguration {
+  /// The default `onCreate` handler.
+  internal static var defaultOnCreateHandler: OnCreate.Handler {
+    { engine, _ in
+      try await defaultOnCreate()(engine)
+    }
+  }
+
+  /// Default design editor specific `OnCreate.Callback` implementation with solution specific settings, scene
+  /// and editor creation setup.
+  /// - Parameters:
+  ///   - preCreateScene: Callback to do any pre scene loading tasks such as applying settings.
+  ///   Defaults to `DesignEditorConfiguration.defaultPreCreateScene`.
+  ///   - createScene: Callback to load/create the scene and load asset sources. Defaults to
+  /// `DesignEditorConfiguration.defaultCreateScene`.
+  ///   - loadAssetSources: Callback to load any asset sources. Defaults to
+  /// `DesignEditorConfiguration.defaultLoadAssetSources`.
+  ///   - postCreateScene: Callback to do any post scene loading tasks. Defaults to
+  ///   `DesignEditorConfiguration.defaultPostCreateScene`.
+  /// - Returns: A composed `OnCreate.Callback`that sequentially executes all three initialization phases.
+  static func defaultOnCreate(
+    preCreateScene: @escaping OnCreate.Callback = defaultPreCreateScene,
+    createScene: @escaping OnCreate.Callback = defaultCreateScene,
+    loadAssetSources: @escaping OnCreate.Callback = defaultLoadAssetSources,
+    postCreateScene: @escaping OnCreate.Callback = defaultPostCreateScene,
+  ) -> OnCreate.Callback {
+    { engine in
+      try await preCreateScene(engine)
+      try await createScene(engine)
+      try await loadAssetSources(engine)
+      try await postCreateScene(engine)
+    }
+  }
+
+  /// Configures engine settings before scene loading.
+  ///
+  /// Sets editor role, touch gestures, camera clamping, and global scopes.
+  static let defaultPreCreateScene: OnCreate.Callback = { engine in
+    try engine.editor.setRole("Adopter")
+    try engine.editor.setSettingEnum("camera/clamping/overshootMode", value: "Center")
+
+    let highlightColor: IMGLYEngine.Color = try engine.editor.getSettingColor("highlightColor")
+    try engine.editor.setSettingColor("placeholderHighlightColor", color: highlightColor)
+
+    try engine.editor.setSettingBool("touch/dragStartCanSelect", value: false)
+    try engine.editor.setSettingEnum("touch/pinchAction", value: "Zoom")
+    try engine.editor.setSettingEnum("touch/rotateAction", value: "None")
+
+    try ([
+      "appearance/adjustments", "appearance/filter", "appearance/effect",
+      "appearance/blur", "appearance/shadow",
+      "editor/select",
+      "fill/change", "fill/changeType",
+      "layer/crop", "layer/move", "layer/resize", "layer/rotate", "layer/flip",
+      "layer/opacity", "layer/blendMode", "layer/visibility", "layer/clipping",
+      "lifecycle/destroy", "lifecycle/duplicate",
+      "stroke/change", "shape/change",
+      "text/edit", "text/character",
+    ]).forEach { scope in
+      try engine.editor.setGlobalScope(key: scope, value: .defer)
+    }
+  }
+
+  /// Loads the built-in empty design scene.
+  static let defaultCreateScene: OnCreate.Callback = { engine in
+    // highlight-starter-kit-on-create-scene
+    let sceneURL = Bundle(for: DesignEditorConfiguration.self).url(
+      forResource: "design-ui-empty",
+      withExtension: "scene",
+    )!
+    try await engine.scene.load(from: sceneURL)
+    // highlight-starter-kit-on-create-scene
+  }
+
+  /// Registers all default and demo asset sources, plus text and photo roll sources.
+  static let defaultLoadAssetSources: OnCreate.Callback = { engine in
+    // highlight-starter-kit-on-load-asset-sources
+    let assetSources: [String: URL] = [
+      Engine.DefaultAssetSource.sticker.rawValue: Engine.assetBaseURL,
+      Engine.DefaultAssetSource.vectorPath.rawValue: Engine.assetBaseURL,
+      Engine.DefaultAssetSource.filterLut.rawValue: Engine.assetBaseURL,
+      Engine.DefaultAssetSource.filterDuotone.rawValue: Engine.assetBaseURL,
+      Engine.DefaultAssetSource.colorsDefaultPalette.rawValue: Engine.assetBaseURL,
+      Engine.DefaultAssetSource.effect.rawValue: Engine.assetBaseURL,
+      Engine.DefaultAssetSource.blur.rawValue: Engine.assetBaseURL,
+      Engine.DefaultAssetSource.typeface.rawValue: Engine.assetBaseURL,
+      Engine.DefaultAssetSource.cropPresets.rawValue: Engine.assetBaseURL,
+      Engine.DefaultAssetSource.pagePresets.rawValue: Engine.assetBaseURL,
+
+      Engine.DemoAssetSource.image.rawValue: Engine.assetBaseURL,
+      Engine.DemoAssetSource.textComponents.rawValue: Engine.assetBaseURL,
+    ]
+
+    try await withThrowingTaskGroup(of: Void.self) { group in
+      for assetSource in assetSources {
+        group.addTask {
+          try await engine.populateAssetSource(id: assetSource.key, baseURL: assetSource.value)
+        }
+      }
+      try await group.waitForAll()
+    }
+
+    try engine.asset.addLocalSource(
+      sourceID: Engine.DemoAssetSource.imageUpload.rawValue,
+      supportedMimeTypes: Engine.DemoAssetSource.imageUpload.mimeTypes,
+    )
+
+    try await engine.asset.addSource(TextAssetSource(engine: engine))
+    try engine.asset.addSource(PhotoRollAssetSource(engine: engine))
+    // highlight-starter-kit-on-load-asset-sources
+  }
+
+  /// Configures stack layout, clears selection, and enables page carousel.
+  static let defaultPostCreateScene: OnCreate.Callback = { engine in
+    if let stack = try engine.block.find(byType: .stack).first {
+      try engine.block.setEnum(stack, property: "stack/axis", value: "Horizontal")
+    }
+
+    try engine.block.findAllSelected().forEach {
+      try engine.block.setSelected($0, selected: false)
+    }
+
+    try engine.editor.setSettingBool("features/pageCarouselEnabled", value: true)
+  }
+}

package/ios/StarterKits/Design/callbacks/OnExport+Design.swift

@@ -0,0 +1,30 @@
+import IMGLYEditor
+import IMGLYEngine
+import UniformTypeIdentifiers
+
+// MARK: - Default OnExport
+
+extension DesignEditorConfiguration {
+  /// The default export handler.
+  ///
+  /// Exports the scene as PDF and opens the system share sheet.
+  static var defaultOnExportHandler: OnExport.Handler {
+    { engine, eventHandler, existing in
+      // highlight-starter-kit-on-export
+      try await existing()
+      guard let scene = try engine.scene.get() else {
+        throw EditorError("No scene was found.")
+      }
+      let data = try await engine.block.export(scene, mimeType: .pdf) { engine in
+        try engine.scene.getPages().forEach {
+          try engine.block.setScopeEnabled($0, key: "layer/visibility", enabled: true)
+          try engine.block.setVisible($0, visible: true)
+        }
+      }
+      let url = FileManager.default.temporaryDirectory.appendingPathComponent("Export", conformingTo: .pdf)
+      try data.write(to: url, options: [.atomic])
+      eventHandler.send(.shareFile(url))
+      // highlight-starter-kit-on-export
+    }
+  }
+}

package/ios/StarterKits/Design/components/CanvasMenu+Design.swift

@@ -0,0 +1,22 @@
+import IMGLYEditor
+
+// MARK: - Canvas Menu
+
+extension DesignEditorConfiguration {
+  /// The default canvas menu configuration.
+  static var defaultCanvasMenu: CanvasMenu.Configuration {
+    CanvasMenu.Configuration { builder in
+      // highlight-starter-kit-canvas-menu
+      builder.items { _ in
+        CanvasMenu.Buttons.selectGroup()
+        CanvasMenu.Divider()
+        CanvasMenu.Buttons.bringForward()
+        CanvasMenu.Buttons.sendBackward()
+        CanvasMenu.Divider()
+        CanvasMenu.Buttons.duplicate()
+        CanvasMenu.Buttons.delete()
+      }
+      // highlight-starter-kit-canvas-menu
+    }
+  }
+}

package/ios/StarterKits/Design/components/Dock+Design.swift

@@ -0,0 +1,23 @@
+import IMGLYEditor
+
+// MARK: - Dock
+
+extension DesignEditorConfiguration {
+  /// The default dock configuration.
+  static var defaultDock: Dock.Configuration {
+    Dock.Configuration { builder in
+      // highlight-starter-kit-dock
+      builder.items { _ in
+        Dock.Buttons.elementsLibrary()
+        Dock.Buttons.photoRoll()
+        Dock.Buttons.systemCamera()
+        Dock.Buttons.imagesLibrary()
+        Dock.Buttons.textLibrary()
+        Dock.Buttons.shapesLibrary()
+        Dock.Buttons.stickersLibrary()
+        Dock.Buttons.resize()
+      }
+      // highlight-starter-kit-dock
+    }
+  }
+}

package/ios/StarterKits/Design/components/InspectorBar+Design.swift

@@ -0,0 +1,35 @@
+import IMGLYEditor
+
+// MARK: - Inspector Bar
+
+extension DesignEditorConfiguration {
+  /// The default inspector bar configuration.
+  static var defaultInspectorBar: InspectorBar.Configuration {
+    InspectorBar.Configuration { builder in
+      // highlight-starter-kit-inspector-bar
+      builder.items { _ in
+        InspectorBar.Buttons.replace()
+
+        InspectorBar.Buttons.editText()
+        InspectorBar.Buttons.formatText()
+        InspectorBar.Buttons.fillStroke()
+        InspectorBar.Buttons.textBackground()
+        InspectorBar.Buttons.crop()
+
+        InspectorBar.Buttons.adjustments()
+        InspectorBar.Buttons.filter()
+        InspectorBar.Buttons.effect()
+        InspectorBar.Buttons.blur()
+        InspectorBar.Buttons.shape()
+
+        InspectorBar.Buttons.selectGroup()
+        InspectorBar.Buttons.enterGroup()
+
+        InspectorBar.Buttons.layer()
+        InspectorBar.Buttons.duplicate()
+        InspectorBar.Buttons.delete()
+      }
+      // highlight-starter-kit-inspector-bar
+    }
+  }
+}

package/ios/StarterKits/Design/components/NavigationBar+Design.swift

@@ -0,0 +1,24 @@
+import IMGLYEditor
+
+// MARK: - Navigation Bar
+
+extension DesignEditorConfiguration {
+  /// The default navigation bar configuration.
+  static var defaultNavigationBar: NavigationBar.Configuration {
+    NavigationBar.Configuration { builder in
+      // highlight-starter-kit-navigation-bar
+      builder.items { _ in
+        NavigationBar.ItemGroup(placement: .topBarLeading) {
+          NavigationBar.Buttons.closeEditor()
+        }
+        NavigationBar.ItemGroup(placement: .topBarTrailing) {
+          NavigationBar.Buttons.undo()
+          NavigationBar.Buttons.redo()
+          NavigationBar.Buttons.togglePagesMode()
+          NavigationBar.Buttons.export()
+        }
+      }
+      // highlight-starter-kit-navigation-bar
+    }
+  }
+}

package/ios/StarterKits/Photo/PhotoEditorConfiguration.swift

@@ -0,0 +1,48 @@
+import IMGLYEditor
+import IMGLYEngine
+import SwiftUI
+
+// CE.SDK Starter Kit: Photo Editor
+//
+// This starter kit provides a complete, production-ready Photo Editor configuration
+// with all configuration code inline and fully documented. Copy this file into your
+// project and customize it to match your needs.
+
+// MARK: - Configuration
+
+public final class PhotoEditorConfiguration: EditorConfiguration {
+  // MARK: - EditorConfiguration — Settings
+
+  /// The zoom padding for the canvas.
+  override public var zoomPadding: CGFloat? { 0 }
+
+  // MARK: - EditorConfiguration — Callbacks
+
+  /// The `onCreate` handler.
+  override public var onCreate: OnCreate.Handler? { Self.defaultOnCreateHandler }
+
+  /// The `onLoaded` handler.
+  override public var onLoaded: OnLoaded.Handler? { Self.defaultOnLoadedHandler }
+
+  /// The `onChanged` handler.
+  override public var onChanged: OnChanged.Handler? { Self.defaultOnChangedHandler }
+
+  /// The export handler.
+  ///
+  /// Default: Exports the scene as PNG and opens the system share sheet.
+  override public var onExport: OnExport.Handler? { Self.defaultOnExportHandler }
+
+  // MARK: - EditorConfiguration — UI Components
+
+  /// The navigation bar configuration.
+  override public var navigationBar: NavigationBar.Configuration? { Self.defaultNavigationBar }
+
+  /// The dock configuration.
+  override public var dock: Dock.Configuration? { Self.defaultDock }
+
+  /// The inspector bar configuration.
+  override public var inspectorBar: InspectorBar.Configuration? { Self.defaultInspectorBar }
+
+  /// The canvas menu configuration.
+  override public var canvasMenu: CanvasMenu.Configuration? { Self.defaultCanvasMenu }
+}

package/ios/StarterKits/Photo/PhotoEditorStarterKit.swift

@@ -0,0 +1,30 @@
+import IMGLYEditor
+import IMGLYEngine
+import SwiftUI
+
+// MARK: - Starter Kit View
+
+struct PhotoEditorStarterKit: View {
+  // Provide `EngineSettings` with your license and an optional userId.
+  let settings = EngineSettings(
+    license: secrets.licenseKey, // Use nil for evaluation mode with watermark
+    userID: "<your unique user id>",
+  )
+
+  // highlight-starter-kit-view
+  var body: some View {
+    // highlight-starter-kit-composable
+    Editor(settings)
+      .imgly.configuration {
+        PhotoEditorConfiguration()
+      }
+    // highlight-starter-kit-composable
+  }
+  // highlight-starter-kit-view
+}
+
+// MARK: - Preview
+
+#Preview {
+  PhotoEditorStarterKit()
+}

package/ios/StarterKits/Photo/callbacks/OnChanged+Photo.swift

@@ -0,0 +1,25 @@
+import IMGLYEditor
+import IMGLYEngine
+
+// MARK: - Default OnChanged
+
+extension PhotoEditorConfiguration {
+  /// The default `onChanged` handler.
+  static var defaultOnChangedHandler: OnChanged.Handler {
+    { update, context, _ in
+      switch update {
+      case let .editMode(oldValue, newValue):
+        guard oldValue != newValue else { return }
+
+        let isCrop = newValue == .crop
+        if let selection = context.engine.block.findAllSelected().first,
+           let type = try? context.engine.block.getType(selection), type == DesignBlockType.page.rawValue {
+          context.eventHandler.send(.setExtraCanvasInsets(isCrop ? 24 : 0))
+        }
+        try context.engine.editor.setSettingBool("page/allowResizeInteraction", value: isCrop)
+      default:
+        try OnChanged.default(update, context)
+      }
+    }
+  }
+}