@imgly/editor-react-native 1.72.3 → 1.73.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (126) hide show
  1. package/IMGLYEditorModule.podspec +23 -0
  2. package/android/build.gradle +9 -6
  3. package/android/src/main/AndroidManifest.xml +1 -1
  4. package/android/src/main/assets/scene/apparel.scene +1 -0
  5. package/android/src/main/assets/scene/design.scene +1 -0
  6. package/android/src/main/assets/scene/postcard.scene +1 -0
  7. package/android/src/main/assets/scene/video.scene +1 -0
  8. package/android/src/main/kotlin/ly/img/editor/configuration/apparel/ApparelConfigurationBuilder.kt +113 -0
  9. package/android/src/main/kotlin/ly/img/editor/configuration/apparel/EditorActivity.kt +37 -0
  10. package/android/src/main/kotlin/ly/img/editor/configuration/apparel/callback/OnCreate.kt +190 -0
  11. package/android/src/main/kotlin/ly/img/editor/configuration/apparel/callback/OnExport.kt +82 -0
  12. package/android/src/main/kotlin/ly/img/editor/configuration/apparel/callback/OnLoaded.kt +88 -0
  13. package/android/src/main/kotlin/ly/img/editor/configuration/apparel/component/CanvasMenu.kt +45 -0
  14. package/android/src/main/kotlin/ly/img/editor/configuration/apparel/component/Dock.kt +37 -0
  15. package/android/src/main/kotlin/ly/img/editor/configuration/apparel/component/InspectorBar.kt +52 -0
  16. package/android/src/main/kotlin/ly/img/editor/configuration/apparel/component/NavigationBar.kt +45 -0
  17. package/android/src/main/kotlin/ly/img/editor/configuration/apparel/component/Overlay.kt +15 -0
  18. package/android/src/main/kotlin/ly/img/editor/configuration/design/DesignConfigurationBuilder.kt +106 -0
  19. package/android/src/main/kotlin/ly/img/editor/configuration/design/EditorActivity.kt +37 -0
  20. package/android/src/main/kotlin/ly/img/editor/configuration/design/callback/OnCreate.kt +162 -0
  21. package/android/src/main/kotlin/ly/img/editor/configuration/design/callback/OnExport.kt +82 -0
  22. package/android/src/main/kotlin/ly/img/editor/configuration/design/callback/OnLoaded.kt +10 -0
  23. package/android/src/main/kotlin/ly/img/editor/configuration/design/component/CanvasMenu.kt +45 -0
  24. package/android/src/main/kotlin/ly/img/editor/configuration/design/component/Dock.kt +35 -0
  25. package/android/src/main/kotlin/ly/img/editor/configuration/design/component/InspectorBar.kt +52 -0
  26. package/android/src/main/kotlin/ly/img/editor/configuration/design/component/NavigationBar.kt +45 -0
  27. package/android/src/main/kotlin/ly/img/editor/configuration/design/component/Overlay.kt +15 -0
  28. package/android/src/main/kotlin/ly/img/editor/configuration/photo/EditorActivity.kt +37 -0
  29. package/android/src/main/kotlin/ly/img/editor/configuration/photo/PhotoConfigurationBuilder.kt +106 -0
  30. package/android/src/main/kotlin/ly/img/editor/configuration/photo/callback/OnCreate.kt +143 -0
  31. package/android/src/main/kotlin/ly/img/editor/configuration/photo/callback/OnExport.kt +82 -0
  32. package/android/src/main/kotlin/ly/img/editor/configuration/photo/callback/OnLoaded.kt +49 -0
  33. package/android/src/main/kotlin/ly/img/editor/configuration/photo/component/CanvasMenu.kt +45 -0
  34. package/android/src/main/kotlin/ly/img/editor/configuration/photo/component/Dock.kt +43 -0
  35. package/android/src/main/kotlin/ly/img/editor/configuration/photo/component/InspectorBar.kt +52 -0
  36. package/android/src/main/kotlin/ly/img/editor/configuration/photo/component/NavigationBar.kt +45 -0
  37. package/android/src/main/kotlin/ly/img/editor/configuration/photo/component/Overlay.kt +15 -0
  38. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/EditorActivity.kt +37 -0
  39. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/PostcardConfigurationBuilder.kt +106 -0
  40. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/callback/OnCreate.kt +149 -0
  41. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/callback/OnExport.kt +82 -0
  42. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/callback/OnLoaded.kt +58 -0
  43. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/component/CanvasMenu.kt +45 -0
  44. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/component/Dock.kt +243 -0
  45. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/component/InspectorBar.kt +52 -0
  46. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/component/NavigationBar.kt +76 -0
  47. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/component/Overlay.kt +15 -0
  48. package/android/src/main/kotlin/ly/img/editor/configuration/postcard/ext/Engine.kt +107 -0
  49. package/android/src/main/kotlin/ly/img/editor/configuration/video/EditorActivity.kt +37 -0
  50. package/android/src/main/kotlin/ly/img/editor/configuration/video/VideoConfigurationBuilder.kt +135 -0
  51. package/android/src/main/kotlin/ly/img/editor/configuration/video/callback/OnCreate.kt +191 -0
  52. package/android/src/main/kotlin/ly/img/editor/configuration/video/callback/OnExport.kt +98 -0
  53. package/android/src/main/kotlin/ly/img/editor/configuration/video/callback/OnLoaded.kt +20 -0
  54. package/android/src/main/kotlin/ly/img/editor/configuration/video/component/BottomPanel.kt +13 -0
  55. package/android/src/main/kotlin/ly/img/editor/configuration/video/component/CanvasMenu.kt +45 -0
  56. package/android/src/main/kotlin/ly/img/editor/configuration/video/component/Dock.kt +71 -0
  57. package/android/src/main/kotlin/ly/img/editor/configuration/video/component/InspectorBar.kt +68 -0
  58. package/android/src/main/kotlin/ly/img/editor/configuration/video/component/NavigationBar.kt +57 -0
  59. package/android/src/main/kotlin/ly/img/editor/configuration/video/component/Overlay.kt +421 -0
  60. package/android/src/main/kotlin/ly/img/editor/configuration/video/iconPack/CheckCircleOutline.kt +79 -0
  61. package/android/src/main/kotlin/ly/img/editor/configuration/video/iconPack/ErrorOutline.kt +92 -0
  62. package/android/src/main/kotlin/ly/img/editor/configuration/video/iconPack/IconPack.kt +14 -0
  63. package/android/src/main/kotlin/ly/img/editor/configuration/video/model/ExportStatus.kt +39 -0
  64. package/android/src/main/kotlin/ly/img/editor/reactnative/module/activity/EditorActivity.kt +2 -0
  65. package/android/src/main/kotlin/ly/img/editor/reactnative/module/builder/EditorBuilder.kt +240 -282
  66. package/ios/Extensions/OnCreate+.swift +38 -62
  67. package/ios/IMGLYEditorModule.swift +10 -1
  68. package/ios/Model/EditorBuilder.swift +132 -225
  69. package/ios/Model/ModalEditorConfiguration.swift +40 -0
  70. package/ios/Model/Source.swift +8 -0
  71. package/ios/StarterKits/Apparel/ApparelEditorConfiguration.swift +46 -0
  72. package/ios/StarterKits/Apparel/ApparelEditorStarterKit.swift +30 -0
  73. package/ios/StarterKits/Apparel/callbacks/OnChanged+Apparel.swift +116 -0
  74. package/ios/StarterKits/Apparel/callbacks/OnCreate+Apparel.swift +197 -0
  75. package/ios/StarterKits/Apparel/callbacks/OnExport+Apparel.swift +29 -0
  76. package/ios/StarterKits/Apparel/components/CanvasMenu+Apparel.swift +22 -0
  77. package/ios/StarterKits/Apparel/components/Dock+Apparel.swift +19 -0
  78. package/ios/StarterKits/Apparel/components/InspectorBar+Apparel.swift +35 -0
  79. package/ios/StarterKits/Apparel/components/NavigationBar+Apparel.swift +26 -0
  80. package/ios/StarterKits/Design/DesignEditorConfiguration.swift +43 -0
  81. package/ios/StarterKits/Design/DesignEditorStarterKit.swift +30 -0
  82. package/ios/StarterKits/Design/callbacks/OnCreate+Design.swift +131 -0
  83. package/ios/StarterKits/Design/callbacks/OnExport+Design.swift +30 -0
  84. package/ios/StarterKits/Design/components/CanvasMenu+Design.swift +22 -0
  85. package/ios/StarterKits/Design/components/Dock+Design.swift +23 -0
  86. package/ios/StarterKits/Design/components/InspectorBar+Design.swift +35 -0
  87. package/ios/StarterKits/Design/components/NavigationBar+Design.swift +24 -0
  88. package/ios/StarterKits/Photo/PhotoEditorConfiguration.swift +48 -0
  89. package/ios/StarterKits/Photo/PhotoEditorStarterKit.swift +30 -0
  90. package/ios/StarterKits/Photo/callbacks/OnChanged+Photo.swift +25 -0
  91. package/ios/StarterKits/Photo/callbacks/OnCreate+Photo.swift +138 -0
  92. package/ios/StarterKits/Photo/callbacks/OnExport+Photo.swift +29 -0
  93. package/ios/StarterKits/Photo/callbacks/OnLoaded+Photo.swift +18 -0
  94. package/ios/StarterKits/Photo/components/CanvasMenu+Photo.swift +22 -0
  95. package/ios/StarterKits/Photo/components/Dock+Photo.swift +23 -0
  96. package/ios/StarterKits/Photo/components/InspectorBar+Photo.swift +39 -0
  97. package/ios/StarterKits/Photo/components/NavigationBar+Photo.swift +24 -0
  98. package/ios/StarterKits/Photo/examples/ExampleForceCrop.swift +30 -0
  99. package/ios/StarterKits/Postcard/PostcardEditorConfiguration.swift +45 -0
  100. package/ios/StarterKits/Postcard/PostcardEditorStarterKit.swift +30 -0
  101. package/ios/StarterKits/Postcard/callbacks/OnChanged+Postcard.swift +92 -0
  102. package/ios/StarterKits/Postcard/callbacks/OnCreate+Postcard.swift +127 -0
  103. package/ios/StarterKits/Postcard/callbacks/OnExport+Postcard.swift +29 -0
  104. package/ios/StarterKits/Postcard/components/CanvasMenu+Postcard.swift +22 -0
  105. package/ios/StarterKits/Postcard/components/Dock+Postcard.swift +34 -0
  106. package/ios/StarterKits/Postcard/components/DockButtons+Postcard.swift +129 -0
  107. package/ios/StarterKits/Postcard/components/InspectorBar+Postcard.swift +35 -0
  108. package/ios/StarterKits/Postcard/components/NavigationBar+Postcard.swift +38 -0
  109. package/ios/StarterKits/Video/VideoEditorConfiguration.swift +54 -0
  110. package/ios/StarterKits/Video/VideoEditorStarterKit.swift +30 -0
  111. package/ios/StarterKits/Video/callbacks/OnCreate+Video.swift +137 -0
  112. package/ios/StarterKits/Video/callbacks/OnExport+Video.swift +46 -0
  113. package/ios/StarterKits/Video/components/BottomPanel+Video.swift +16 -0
  114. package/ios/StarterKits/Video/components/CanvasMenu+Video.swift +22 -0
  115. package/ios/StarterKits/Video/components/Dock+Video.swift +30 -0
  116. package/ios/StarterKits/Video/components/InspectorBar+Video.swift +43 -0
  117. package/ios/StarterKits/Video/components/NavigationBar+Video.swift +32 -0
  118. package/ios/StarterKits/Video/examples/ExampleVideoDurationConstraints.swift +23 -0
  119. package/ios/StarterKits/apparel-ui-b-empty.scene +1 -0
  120. package/ios/StarterKits/design-ui-empty.scene +1 -0
  121. package/ios/StarterKits/photo-ui-empty.png +0 -0
  122. package/ios/StarterKits/postcard-empty.scene +1 -0
  123. package/ios/StarterKits/video-empty.scene +1 -0
  124. package/package.json +1 -1
  125. package/src/NativeIMGLYEditor.ts +1 -1
  126. package/ios/View/ModalEditor.swift +0 -43
@@ -0,0 +1,116 @@
1
+ import IMGLYEditor
2
+ import IMGLYEngine
3
+
4
+ // MARK: - Default OnChanged
5
+
6
+ extension ApparelEditorConfiguration {
7
+ /// The default `onChanged` handler.
8
+ static var defaultOnChangedHandler: OnChanged.Handler {
9
+ { update, context, _ in
10
+ switch update {
11
+ case let .gestureActive(_, newValue):
12
+ try Self.showOutline(newValue, engine: context.engine)
13
+
14
+ case let .page(_, newValue):
15
+ // Deselect all blocks.
16
+ try context.engine.block.findAllSelected().forEach {
17
+ try context.engine.block.setSelected($0, selected: false)
18
+ }
19
+
20
+ // Reset history.
21
+ let oldHistory = context.engine.editor.getActiveHistory()
22
+ let newHistory = context.engine.editor.createHistory()
23
+ context.engine.editor.setActiveHistory(newHistory)
24
+ context.engine.editor.destroyHistory(oldHistory)
25
+ try context.engine.editor.addUndoStep()
26
+
27
+ if let stack = try? context.engine.block.find(byType: .stack).first {
28
+ try context.engine.block.setEnum(stack, property: "stack/axis", value: "Depth")
29
+ }
30
+
31
+ let pages = try context.engine.scene.getPages()
32
+ for (i, block) in pages.enumerated() {
33
+ let isVisibilityEnabled = try context.engine.block.isScopeEnabled(block, key: "layer/visibility")
34
+ try context.engine.block.setScopeEnabled(block, key: "layer/visibility", enabled: true)
35
+ try context.engine.block.setVisible(block, visible: i == newValue)
36
+ try context.engine.block.setScopeEnabled(block, key: "layer/visibility", enabled: isVisibilityEnabled)
37
+ }
38
+
39
+ case let .viewMode(_, state):
40
+ if state.editorViewMode == .edit {
41
+ try Self.setupPage(context)
42
+ } else if state.editorViewMode == .preview {
43
+ guard let scene = try context.engine.block.find(byType: .scene).first
44
+ else { throw EditorError("No scene found.") }
45
+
46
+ Task {
47
+ // Disable camera clamping.
48
+ if try context.engine.scene.unstable_isCameraZoomClampingEnabled(scene) {
49
+ try context.engine.scene.unstable_disableCameraZoomClamping()
50
+ }
51
+ if try context.engine.scene.unstable_isCameraPositionClampingEnabled(scene) {
52
+ try context.engine.scene.unstable_disableCameraPositionClamping()
53
+ }
54
+
55
+ // Zoom to the backdrop image.
56
+ try await context.engine.scene.zoom(
57
+ to: Self.getBackdropImage(engine: context.engine),
58
+ paddingLeft: Float(state.insets?.leading ?? 0),
59
+ paddingTop: Float(state.insets?.top ?? 0),
60
+ paddingRight: Float(state.insets?.trailing ?? 0),
61
+ paddingBottom: Float(state.insets?.bottom ?? 0),
62
+ )
63
+
64
+ // Deselect all blocks.
65
+ let selectedBlocks = context.engine.block.findAllSelected()
66
+ try selectedBlocks.forEach { try context.engine.block.setSelected($0, selected: false) }
67
+
68
+ try Self.setupPage(context)
69
+ }
70
+ } else {
71
+ try OnChanged.default(update, context)
72
+ }
73
+
74
+ default:
75
+ try OnChanged.default(update, context)
76
+ }
77
+ }
78
+ }
79
+
80
+ // MARK: - Helpers
81
+
82
+ /// Gets the backdrop image from the scene.
83
+ /// The backdrop image is the only image that is a direct child of the scene block.
84
+ static func getBackdropImage(engine: Engine) throws -> DesignBlockID {
85
+ guard let scene = try engine.scene.get() else { throw EditorError("No scene found.") }
86
+ let childIDs = try engine.block.getChildren(scene)
87
+ let imageID = try childIDs.first {
88
+ guard try engine.block.getType($0) == DesignBlockType.graphic.rawValue,
89
+ try engine.block.supportsFill($0)
90
+ else {
91
+ return false
92
+ }
93
+ return try engine.block.getType(try engine.block.getFill($0)) == FillType.image.rawValue
94
+ }
95
+ guard let imageID else {
96
+ throw EditorError("No backdrop image found.")
97
+ }
98
+ return imageID
99
+ }
100
+
101
+ /// Configures the current page for proper apparel editing.
102
+ static func setupPage(_ context: OnChanged.Context) throws {
103
+ guard let page = try context.engine.scene.getCurrentPage() else {
104
+ throw EditorError("No scene found.")
105
+ }
106
+
107
+ let fillChangeEnabled = try context.engine.block.isScopeEnabled(page, key: "fill/change")
108
+ let layerClippingEnabled = try context.engine.block.isScopeEnabled(page, key: "layer/clipping")
109
+ try context.engine.editor.setSettingBool("page/dimOutOfPageAreas", value: false)
110
+ try context.engine.block.setClipped(page, clipped: true)
111
+ try context.engine.block.setBool(page, property: "fill/enabled", value: false)
112
+ try showOutline(false, engine: context.engine)
113
+ try context.engine.block.setScopeEnabled(page, key: "fill/change", enabled: fillChangeEnabled)
114
+ try context.engine.block.setScopeEnabled(page, key: "layer/clipping", enabled: layerClippingEnabled)
115
+ }
116
+ }
@@ -0,0 +1,197 @@
1
+ import CoreGraphics
2
+ import Foundation
3
+ import IMGLYEditor
4
+ import IMGLYEngine
5
+
6
+ // MARK: - Default OnCreate
7
+
8
+ public extension ApparelEditorConfiguration {
9
+ /// The default `onCreate` handler.
10
+ internal static var defaultOnCreateHandler: OnCreate.Handler {
11
+ { engine, _ in
12
+ try await defaultOnCreate()(engine)
13
+ }
14
+ }
15
+
16
+ /// Default apparel editor specific `OnCreate.Callback` implementation with solution specific settings, scene
17
+ /// and editor creation setup.
18
+ /// - Parameters:
19
+ /// - preCreateScene: Callback to do any pre scene loading tasks such as applying settings.
20
+ /// Defaults to `ApparelEditorConfiguration.defaultPreCreateScene`.
21
+ /// - createScene: Callback to load/create the scene and load asset sources. Defaults to
22
+ /// `ApparelEditorConfiguration.defaultCreateScene`.
23
+ /// - loadAssetSources: Callback to load any asset sources. Defaults to
24
+ /// `ApparelEditorConfiguration.defaultLoadAssetSources`.
25
+ /// - postCreateScene: Callback to do any post scene loading tasks. Defaults to
26
+ /// `ApparelEditorConfiguration.defaultPostCreateScene`.
27
+ /// - Returns: A composed `OnCreate.Callback`that sequentially executes all three initialization phases.
28
+ static func defaultOnCreate(
29
+ preCreateScene: @escaping OnCreate.Callback = defaultPreCreateScene,
30
+ createScene: @escaping OnCreate.Callback = defaultCreateScene,
31
+ loadAssetSources: @escaping OnCreate.Callback = defaultLoadAssetSources,
32
+ postCreateScene: @escaping OnCreate.Callback = defaultPostCreateScene,
33
+ ) -> OnCreate.Callback {
34
+ { engine in
35
+ try await preCreateScene(engine)
36
+ try await createScene(engine)
37
+ try await loadAssetSources(engine)
38
+ try await postCreateScene(engine)
39
+ }
40
+ }
41
+
42
+ /// Configures engine settings before scene loading.
43
+ ///
44
+ /// Sets editor role, touch gestures, camera clamping, and global scopes.
45
+ static let defaultPreCreateScene: OnCreate.Callback = { engine in
46
+ try engine.editor.setRole("Adopter")
47
+ try engine.editor.setSettingEnum("camera/clamping/overshootMode", value: "Center")
48
+
49
+ let highlightColor: IMGLYEngine.Color = try engine.editor.getSettingColor("highlightColor")
50
+ try engine.editor.setSettingColor("placeholderHighlightColor", color: highlightColor)
51
+
52
+ try engine.editor.setSettingBool("touch/dragStartCanSelect", value: false)
53
+ try engine.editor.setSettingEnum("touch/pinchAction", value: "Zoom")
54
+ try engine.editor.setSettingEnum("touch/rotateAction", value: "None")
55
+
56
+ try ([
57
+ "appearance/adjustments", "appearance/filter", "appearance/effect",
58
+ "appearance/blur", "appearance/shadow",
59
+ "editor/select",
60
+ "fill/change", "fill/changeType",
61
+ "layer/crop", "layer/move", "layer/resize", "layer/rotate", "layer/flip",
62
+ "layer/opacity", "layer/blendMode", "layer/visibility", "layer/clipping",
63
+ "lifecycle/destroy", "lifecycle/duplicate",
64
+ "stroke/change", "shape/change",
65
+ "text/edit", "text/character",
66
+ ]).forEach { scope in
67
+ try engine.editor.setGlobalScope(key: scope, value: .defer)
68
+ }
69
+ }
70
+
71
+ /// Loads the built-in empty apparel scene.
72
+ static let defaultCreateScene: OnCreate.Callback = { engine in
73
+ // highlight-starter-kit-on-create-scene
74
+ let sceneURL = Bundle(for: ApparelEditorConfiguration.self).url(
75
+ forResource: "apparel-ui-b-empty",
76
+ withExtension: "scene",
77
+ )!
78
+ try await engine.scene.load(from: sceneURL)
79
+ // highlight-starter-kit-on-create-scene
80
+ }
81
+
82
+ /// Registers all default and demo asset sources, plus text and photo roll sources.
83
+ static let defaultLoadAssetSources: OnCreate.Callback = { engine in
84
+ // highlight-starter-kit-on-load-asset-sources
85
+ let assetSources: [String: URL] = [
86
+ Engine.DefaultAssetSource.sticker.rawValue: Engine.assetBaseURL,
87
+ Engine.DefaultAssetSource.vectorPath.rawValue: Engine.assetBaseURL,
88
+ Engine.DefaultAssetSource.filterLut.rawValue: Engine.assetBaseURL,
89
+ Engine.DefaultAssetSource.filterDuotone.rawValue: Engine.assetBaseURL,
90
+ Engine.DefaultAssetSource.colorsDefaultPalette.rawValue: Engine.assetBaseURL,
91
+ Engine.DefaultAssetSource.effect.rawValue: Engine.assetBaseURL,
92
+ Engine.DefaultAssetSource.blur.rawValue: Engine.assetBaseURL,
93
+ Engine.DefaultAssetSource.typeface.rawValue: Engine.assetBaseURL,
94
+ Engine.DefaultAssetSource.cropPresets.rawValue: Engine.assetBaseURL,
95
+ Engine.DefaultAssetSource.pagePresets.rawValue: Engine.assetBaseURL,
96
+
97
+ Engine.DemoAssetSource.image.rawValue: Engine.assetBaseURL,
98
+ Engine.DemoAssetSource.textComponents.rawValue: Engine.assetBaseURL,
99
+ ]
100
+
101
+ try await withThrowingTaskGroup(of: Void.self) { group in
102
+ for assetSource in assetSources {
103
+ group.addTask {
104
+ try await engine.populateAssetSource(id: assetSource.key, baseURL: assetSource.value)
105
+ }
106
+ }
107
+ try await group.waitForAll()
108
+ }
109
+
110
+ try engine.asset.addLocalSource(
111
+ sourceID: Engine.DemoAssetSource.imageUpload.rawValue,
112
+ supportedMimeTypes: Engine.DemoAssetSource.imageUpload.mimeTypes,
113
+ )
114
+
115
+ try await engine.asset.addSource(TextAssetSource(engine: engine))
116
+ try engine.asset.addSource(PhotoRollAssetSource(engine: engine))
117
+ // highlight-starter-kit-on-load-asset-sources
118
+ }
119
+
120
+ /// Configures apparel-specific outline and page clipping behavior.
121
+ static let defaultPostCreateScene: OnCreate.Callback = { engine in
122
+ guard let scene = try engine.block.find(byType: .scene).first,
123
+ let page = try engine.scene.getPages().first
124
+ else {
125
+ return
126
+ }
127
+
128
+ // Add outline block for apparel shape visualization.
129
+ _ = try ApparelEditorConfiguration.addOutline(
130
+ "always-on-top-page-outline", for: page, to: scene, engine: engine,
131
+ )
132
+ try ApparelEditorConfiguration.showOutline(false, engine: engine)
133
+
134
+ // Temporarily enable scopes to configure page clipping.
135
+ let isFillChangeEnabled = try engine.block.isScopeEnabled(page, key: "fill/change")
136
+ let isLayerClippingEnabled = try engine.block.isScopeEnabled(page, key: "layer/clipping")
137
+ try engine.block.setScopeEnabled(page, key: "fill/change", enabled: true)
138
+ try engine.block.setScopeEnabled(page, key: "layer/clipping", enabled: true)
139
+
140
+ // Configure page appearance and clipping for apparel editing.
141
+ try engine.editor.setSettingBool("page/dimOutOfPageAreas", value: false)
142
+ try engine.block.setClipped(page, clipped: true)
143
+ try engine.block.setBool(page, property: "fill/enabled", value: false)
144
+ try ApparelEditorConfiguration.showOutline(false, engine: engine)
145
+
146
+ // Restore original scope states.
147
+ try engine.block.setScopeEnabled(page, key: "fill/change", enabled: isFillChangeEnabled)
148
+ try engine.block.setScopeEnabled(page, key: "layer/clipping", enabled: isLayerClippingEnabled)
149
+ }
150
+
151
+ // MARK: - Helpers
152
+
153
+ /// Adds an outline block for apparel shape visualization.
154
+ internal static func addOutline(
155
+ _ name: String? = nil,
156
+ for id: DesignBlockID,
157
+ to parent: DesignBlockID,
158
+ engine: Engine,
159
+ ) throws -> DesignBlockID {
160
+ let outline = try engine.block.create(.graphic)
161
+ let rect = try engine.block.createShape(.rect)
162
+ try engine.block.setShape(outline, shape: rect)
163
+
164
+ let height = try engine.block.getHeight(id)
165
+ let width = try engine.block.getWidth(id)
166
+
167
+ if let name {
168
+ try engine.block.setName(outline, name: name)
169
+ }
170
+ try engine.block.setHeightMode(outline, mode: .absolute)
171
+ try engine.block.setHeight(outline, value: height)
172
+ try engine.block.setWidthMode(outline, mode: .absolute)
173
+ try engine.block.setWidth(outline, value: width)
174
+ try engine.block.appendChild(to: parent, child: outline)
175
+
176
+ try engine.block.setBool(outline, property: "fill/enabled", value: false)
177
+ try engine.block.setBool(outline, property: "stroke/enabled", value: true)
178
+ try engine.block.setStrokeStyle(outline, style: .dotted)
179
+ try engine.block.setStrokeWidth(outline, width: 1.0)
180
+ try engine.block.setBlendMode(outline, mode: .difference)
181
+ try engine.block.setScopeEnabled(outline, key: "editor/select", enabled: false)
182
+ if let color = Color(cgColor: CGColor.imgly.white) {
183
+ try engine.block.setColor(outline, property: "stroke/color", color: color)
184
+ }
185
+ return outline
186
+ }
187
+
188
+ /// Shows or hides the outline block.
189
+ internal static func showOutline(_ isVisible: Bool, engine: Engine) throws {
190
+ guard let outline = engine.block.find(byName: "always-on-top-page-outline").first else {
191
+ throw EditorError("No outline block was found.")
192
+ }
193
+ try engine.block.setVisible(outline, visible: isVisible)
194
+ // Workaround: Trigger opacity to force refresh on "fast" devices.
195
+ try engine.block.setOpacity(outline, value: isVisible ? 1 : 0)
196
+ }
197
+ }
@@ -0,0 +1,29 @@
1
+ import IMGLYEditor
2
+ import IMGLYEngine
3
+ import UniformTypeIdentifiers
4
+
5
+ // MARK: - Default OnExport
6
+
7
+ extension ApparelEditorConfiguration {
8
+ /// The default export handler.
9
+ ///
10
+ /// Exports the scene as PDF and opens the system share sheet.
11
+ static var defaultOnExportHandler: OnExport.Handler {
12
+ { engine, eventHandler, _ in
13
+ // highlight-starter-kit-on-export
14
+ guard let scene = try engine.scene.get() else {
15
+ throw EditorError("No scene was found.")
16
+ }
17
+ let data = try await engine.block.export(scene, mimeType: .pdf) { engine in
18
+ try engine.scene.getPages().forEach {
19
+ try engine.block.setScopeEnabled($0, key: "layer/visibility", enabled: true)
20
+ try engine.block.setVisible($0, visible: true)
21
+ }
22
+ }
23
+ let url = FileManager.default.temporaryDirectory.appendingPathComponent("Export", conformingTo: .pdf)
24
+ try data.write(to: url, options: [.atomic])
25
+ eventHandler.send(.shareFile(url))
26
+ // highlight-starter-kit-on-export
27
+ }
28
+ }
29
+ }
@@ -0,0 +1,22 @@
1
+ import IMGLYEditor
2
+
3
+ // MARK: - Canvas Menu
4
+
5
+ extension ApparelEditorConfiguration {
6
+ /// The default canvas menu configuration.
7
+ static var defaultCanvasMenu: CanvasMenu.Configuration {
8
+ CanvasMenu.Configuration { builder in
9
+ // highlight-starter-kit-canvas-menu
10
+ builder.items { _ in
11
+ CanvasMenu.Buttons.selectGroup()
12
+ CanvasMenu.Divider()
13
+ CanvasMenu.Buttons.bringForward()
14
+ CanvasMenu.Buttons.sendBackward()
15
+ CanvasMenu.Divider()
16
+ CanvasMenu.Buttons.duplicate()
17
+ CanvasMenu.Buttons.delete()
18
+ }
19
+ // highlight-starter-kit-canvas-menu
20
+ }
21
+ }
22
+ }
@@ -0,0 +1,19 @@
1
+ import IMGLYEditor
2
+
3
+ // MARK: - Dock
4
+
5
+ extension ApparelEditorConfiguration {
6
+ /// The default dock configuration.
7
+ static var defaultDock: Dock.Configuration {
8
+ Dock.Configuration { builder in
9
+ // highlight-starter-kit-dock
10
+ builder.items { _ in
11
+ Dock.Buttons.assetLibrary(modifier: { _ in Dock.Buttons.AssetLibraryModifier() })
12
+ }
13
+ builder.alignment = { _ in .leading }
14
+ builder.backgroundColor = { _, _ in .clear }
15
+ builder.scrollDisabled = { _ in true }
16
+ // highlight-starter-kit-dock
17
+ }
18
+ }
19
+ }
@@ -0,0 +1,35 @@
1
+ import IMGLYEditor
2
+
3
+ // MARK: - Inspector Bar
4
+
5
+ extension ApparelEditorConfiguration {
6
+ /// The default inspector bar configuration.
7
+ static var defaultInspectorBar: InspectorBar.Configuration {
8
+ InspectorBar.Configuration { builder in
9
+ // highlight-starter-kit-inspector-bar
10
+ builder.items { _ in
11
+ InspectorBar.Buttons.replace()
12
+
13
+ InspectorBar.Buttons.editText()
14
+ InspectorBar.Buttons.formatText()
15
+ InspectorBar.Buttons.fillStroke()
16
+ InspectorBar.Buttons.textBackground()
17
+ InspectorBar.Buttons.crop()
18
+
19
+ InspectorBar.Buttons.adjustments()
20
+ InspectorBar.Buttons.filter()
21
+ InspectorBar.Buttons.effect()
22
+ InspectorBar.Buttons.blur()
23
+ InspectorBar.Buttons.shape()
24
+
25
+ InspectorBar.Buttons.selectGroup()
26
+ InspectorBar.Buttons.enterGroup()
27
+
28
+ InspectorBar.Buttons.layer()
29
+ InspectorBar.Buttons.duplicate()
30
+ InspectorBar.Buttons.delete()
31
+ }
32
+ // highlight-starter-kit-inspector-bar
33
+ }
34
+ }
35
+ }
@@ -0,0 +1,26 @@
1
+ import IMGLYEditor
2
+
3
+ // MARK: - Navigation Bar
4
+
5
+ extension ApparelEditorConfiguration {
6
+ /// The default navigation bar configuration.
7
+ static var defaultNavigationBar: NavigationBar.Configuration {
8
+ NavigationBar.Configuration { builder in
9
+ // highlight-starter-kit-navigation-bar
10
+ builder.items { _ in
11
+ NavigationBar.ItemGroup(placement: .topBarLeading) {
12
+ NavigationBar.Buttons.closeEditor()
13
+ }
14
+ NavigationBar.ItemGroup(placement: .principal) {
15
+ NavigationBar.Buttons.undo()
16
+ NavigationBar.Buttons.redo()
17
+ NavigationBar.Buttons.togglePreviewMode()
18
+ }
19
+ NavigationBar.ItemGroup(placement: .topBarTrailing) {
20
+ NavigationBar.Buttons.export()
21
+ }
22
+ }
23
+ // highlight-starter-kit-navigation-bar
24
+ }
25
+ }
26
+ }
@@ -0,0 +1,43 @@
1
+ import IMGLYEditor
2
+ import IMGLYEngine
3
+ import SwiftUI
4
+
5
+ // CE.SDK Starter Kit: Design Editor
6
+ //
7
+ // This starter kit provides a complete, production-ready Design Editor configuration
8
+ // with all configuration code inline and fully documented. Copy this file into your
9
+ // project and customize it to match your needs.
10
+
11
+ // MARK: - Configuration
12
+
13
+ /// A composable Design Editor configuration.
14
+ public final class DesignEditorConfiguration: EditorConfiguration {
15
+ // MARK: - EditorConfiguration — Settings
16
+
17
+ /// The zoom padding for the canvas.
18
+ override public var zoomPadding: CGFloat? { 16 }
19
+
20
+ // MARK: - EditorConfiguration — Callbacks
21
+
22
+ /// The `onCreate` handler.
23
+ override public var onCreate: OnCreate.Handler? { Self.defaultOnCreateHandler }
24
+
25
+ /// The export handler.
26
+ ///
27
+ /// Default: Exports the scene as PDF and opens the system share sheet.
28
+ override public var onExport: OnExport.Handler? { Self.defaultOnExportHandler }
29
+
30
+ // MARK: - EditorConfiguration — UI Components
31
+
32
+ /// The navigation bar configuration.
33
+ override public var navigationBar: NavigationBar.Configuration? { Self.defaultNavigationBar }
34
+
35
+ /// The dock configuration.
36
+ override public var dock: Dock.Configuration? { Self.defaultDock }
37
+
38
+ /// The inspector bar configuration.
39
+ override public var inspectorBar: InspectorBar.Configuration? { Self.defaultInspectorBar }
40
+
41
+ /// The canvas menu configuration.
42
+ override public var canvasMenu: CanvasMenu.Configuration? { Self.defaultCanvasMenu }
43
+ }
@@ -0,0 +1,30 @@
1
+ import IMGLYEditor
2
+ import IMGLYEngine
3
+ import SwiftUI
4
+
5
+ // MARK: - Starter Kit View
6
+
7
+ struct DesignEditorStarterKit: View {
8
+ // Provide `EngineSettings` with your license and an optional userId.
9
+ let settings = EngineSettings(
10
+ license: secrets.licenseKey, // Use nil for evaluation mode with watermark
11
+ userID: "<your unique user id>",
12
+ )
13
+
14
+ // highlight-starter-kit-view
15
+ var body: some View {
16
+ // highlight-starter-kit-composable
17
+ Editor(settings)
18
+ .imgly.configuration {
19
+ DesignEditorConfiguration()
20
+ }
21
+ // highlight-starter-kit-composable
22
+ }
23
+ // highlight-starter-kit-view
24
+ }
25
+
26
+ // MARK: - Preview
27
+
28
+ #Preview {
29
+ DesignEditorStarterKit()
30
+ }
@@ -0,0 +1,131 @@
1
+ import Foundation
2
+ import IMGLYEditor
3
+ import IMGLYEngine
4
+
5
+ // MARK: - Default OnCreate
6
+
7
+ public extension DesignEditorConfiguration {
8
+ /// The default `onCreate` handler.
9
+ internal static var defaultOnCreateHandler: OnCreate.Handler {
10
+ { engine, _ in
11
+ try await defaultOnCreate()(engine)
12
+ }
13
+ }
14
+
15
+ /// Default design editor specific `OnCreate.Callback` implementation with solution specific settings, scene
16
+ /// and editor creation setup.
17
+ /// - Parameters:
18
+ /// - preCreateScene: Callback to do any pre scene loading tasks such as applying settings.
19
+ /// Defaults to `DesignEditorConfiguration.defaultPreCreateScene`.
20
+ /// - createScene: Callback to load/create the scene and load asset sources. Defaults to
21
+ /// `DesignEditorConfiguration.defaultCreateScene`.
22
+ /// - loadAssetSources: Callback to load any asset sources. Defaults to
23
+ /// `DesignEditorConfiguration.defaultLoadAssetSources`.
24
+ /// - postCreateScene: Callback to do any post scene loading tasks. Defaults to
25
+ /// `DesignEditorConfiguration.defaultPostCreateScene`.
26
+ /// - Returns: A composed `OnCreate.Callback`that sequentially executes all three initialization phases.
27
+ static func defaultOnCreate(
28
+ preCreateScene: @escaping OnCreate.Callback = defaultPreCreateScene,
29
+ createScene: @escaping OnCreate.Callback = defaultCreateScene,
30
+ loadAssetSources: @escaping OnCreate.Callback = defaultLoadAssetSources,
31
+ postCreateScene: @escaping OnCreate.Callback = defaultPostCreateScene,
32
+ ) -> OnCreate.Callback {
33
+ { engine in
34
+ try await preCreateScene(engine)
35
+ try await createScene(engine)
36
+ try await loadAssetSources(engine)
37
+ try await postCreateScene(engine)
38
+ }
39
+ }
40
+
41
+ /// Configures engine settings before scene loading.
42
+ ///
43
+ /// Sets editor role, touch gestures, camera clamping, and global scopes.
44
+ static let defaultPreCreateScene: OnCreate.Callback = { engine in
45
+ try engine.editor.setRole("Adopter")
46
+ try engine.editor.setSettingEnum("camera/clamping/overshootMode", value: "Center")
47
+
48
+ let highlightColor: IMGLYEngine.Color = try engine.editor.getSettingColor("highlightColor")
49
+ try engine.editor.setSettingColor("placeholderHighlightColor", color: highlightColor)
50
+
51
+ try engine.editor.setSettingBool("touch/dragStartCanSelect", value: false)
52
+ try engine.editor.setSettingEnum("touch/pinchAction", value: "Zoom")
53
+ try engine.editor.setSettingEnum("touch/rotateAction", value: "None")
54
+
55
+ try ([
56
+ "appearance/adjustments", "appearance/filter", "appearance/effect",
57
+ "appearance/blur", "appearance/shadow",
58
+ "editor/select",
59
+ "fill/change", "fill/changeType",
60
+ "layer/crop", "layer/move", "layer/resize", "layer/rotate", "layer/flip",
61
+ "layer/opacity", "layer/blendMode", "layer/visibility", "layer/clipping",
62
+ "lifecycle/destroy", "lifecycle/duplicate",
63
+ "stroke/change", "shape/change",
64
+ "text/edit", "text/character",
65
+ ]).forEach { scope in
66
+ try engine.editor.setGlobalScope(key: scope, value: .defer)
67
+ }
68
+ }
69
+
70
+ /// Loads the built-in empty design scene.
71
+ static let defaultCreateScene: OnCreate.Callback = { engine in
72
+ // highlight-starter-kit-on-create-scene
73
+ let sceneURL = Bundle(for: DesignEditorConfiguration.self).url(
74
+ forResource: "design-ui-empty",
75
+ withExtension: "scene",
76
+ )!
77
+ try await engine.scene.load(from: sceneURL)
78
+ // highlight-starter-kit-on-create-scene
79
+ }
80
+
81
+ /// Registers all default and demo asset sources, plus text and photo roll sources.
82
+ static let defaultLoadAssetSources: OnCreate.Callback = { engine in
83
+ // highlight-starter-kit-on-load-asset-sources
84
+ let assetSources: [String: URL] = [
85
+ Engine.DefaultAssetSource.sticker.rawValue: Engine.assetBaseURL,
86
+ Engine.DefaultAssetSource.vectorPath.rawValue: Engine.assetBaseURL,
87
+ Engine.DefaultAssetSource.filterLut.rawValue: Engine.assetBaseURL,
88
+ Engine.DefaultAssetSource.filterDuotone.rawValue: Engine.assetBaseURL,
89
+ Engine.DefaultAssetSource.colorsDefaultPalette.rawValue: Engine.assetBaseURL,
90
+ Engine.DefaultAssetSource.effect.rawValue: Engine.assetBaseURL,
91
+ Engine.DefaultAssetSource.blur.rawValue: Engine.assetBaseURL,
92
+ Engine.DefaultAssetSource.typeface.rawValue: Engine.assetBaseURL,
93
+ Engine.DefaultAssetSource.cropPresets.rawValue: Engine.assetBaseURL,
94
+ Engine.DefaultAssetSource.pagePresets.rawValue: Engine.assetBaseURL,
95
+
96
+ Engine.DemoAssetSource.image.rawValue: Engine.assetBaseURL,
97
+ Engine.DemoAssetSource.textComponents.rawValue: Engine.assetBaseURL,
98
+ ]
99
+
100
+ try await withThrowingTaskGroup(of: Void.self) { group in
101
+ for assetSource in assetSources {
102
+ group.addTask {
103
+ try await engine.populateAssetSource(id: assetSource.key, baseURL: assetSource.value)
104
+ }
105
+ }
106
+ try await group.waitForAll()
107
+ }
108
+
109
+ try engine.asset.addLocalSource(
110
+ sourceID: Engine.DemoAssetSource.imageUpload.rawValue,
111
+ supportedMimeTypes: Engine.DemoAssetSource.imageUpload.mimeTypes,
112
+ )
113
+
114
+ try await engine.asset.addSource(TextAssetSource(engine: engine))
115
+ try engine.asset.addSource(PhotoRollAssetSource(engine: engine))
116
+ // highlight-starter-kit-on-load-asset-sources
117
+ }
118
+
119
+ /// Configures stack layout, clears selection, and enables page carousel.
120
+ static let defaultPostCreateScene: OnCreate.Callback = { engine in
121
+ if let stack = try engine.block.find(byType: .stack).first {
122
+ try engine.block.setEnum(stack, property: "stack/axis", value: "Horizontal")
123
+ }
124
+
125
+ try engine.block.findAllSelected().forEach {
126
+ try engine.block.setSelected($0, selected: false)
127
+ }
128
+
129
+ try engine.editor.setSettingBool("features/pageCarouselEnabled", value: true)
130
+ }
131
+ }