@wordpress/image-editor 0.0.0-stage → 0.1.0

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 (255) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/LICENSE.md +788 -0
  3. package/README.md +171 -2
  4. package/build/core/camera.cjs +277 -0
  5. package/build/core/camera.cjs.map +1 -0
  6. package/build/core/constants.cjs +109 -0
  7. package/build/core/constants.cjs.map +1 -0
  8. package/build/core/containment.cjs +289 -0
  9. package/build/core/containment.cjs.map +1 -0
  10. package/build/core/crop-rect.cjs +37 -0
  11. package/build/core/crop-rect.cjs.map +1 -0
  12. package/build/core/export/canvas-renderer.cjs +177 -0
  13. package/build/core/export/canvas-renderer.cjs.map +1 -0
  14. package/build/core/interaction-controller.cjs +591 -0
  15. package/build/core/interaction-controller.cjs.map +1 -0
  16. package/build/core/math/rotation.cjs +32 -0
  17. package/build/core/math/rotation.cjs.map +1 -0
  18. package/build/core/math/sanitize.cjs +136 -0
  19. package/build/core/math/sanitize.cjs.map +1 -0
  20. package/build/core/setter-helpers.cjs +59 -0
  21. package/build/core/setter-helpers.cjs.map +1 -0
  22. package/build/core/source-region.cjs +212 -0
  23. package/build/core/source-region.cjs.map +1 -0
  24. package/build/core/state.cjs +463 -0
  25. package/build/core/state.cjs.map +1 -0
  26. package/build/core/stencil-math.cjs +203 -0
  27. package/build/core/stencil-math.cjs.map +1 -0
  28. package/build/core/transform-style.cjs +43 -0
  29. package/build/core/transform-style.cjs.map +1 -0
  30. package/build/core/transforms/pipeline.cjs +41 -0
  31. package/build/core/transforms/pipeline.cjs.map +1 -0
  32. package/build/core/types.cjs +5 -0
  33. package/build/core/viewport-state.cjs +36 -0
  34. package/build/core/viewport-state.cjs.map +1 -0
  35. package/build/export-image.cjs +35 -0
  36. package/build/export-image.cjs.map +1 -0
  37. package/build/get-image-edit.cjs +101 -0
  38. package/build/get-image-edit.cjs.map +1 -0
  39. package/build/get-output-size.cjs +38 -0
  40. package/build/get-output-size.cjs.map +1 -0
  41. package/build/index.cjs +60 -0
  42. package/build/map-image-edit.cjs +34 -0
  43. package/build/map-image-edit.cjs.map +1 -0
  44. package/build/react/components/image-editor-canvas.cjs +566 -0
  45. package/build/react/components/image-editor-canvas.cjs.map +1 -0
  46. package/build/react/components/index.cjs +12 -0
  47. package/build/react/components/overlays/dimensions-overlay.cjs +147 -0
  48. package/build/react/components/overlays/dimensions-overlay.cjs.map +1 -0
  49. package/build/react/components/overlays/dimming-overlay.cjs +31 -0
  50. package/build/react/components/overlays/dimming-overlay.cjs.map +1 -0
  51. package/build/react/components/overlays/grid-overlay.cjs +61 -0
  52. package/build/react/components/overlays/grid-overlay.cjs.map +1 -0
  53. package/build/react/components/stencils/rectangle-stencil.cjs +367 -0
  54. package/build/react/components/stencils/rectangle-stencil.cjs.map +1 -0
  55. package/build/react/components/viewport-provider.cjs +26 -0
  56. package/build/react/components/viewport-provider.cjs.map +1 -0
  57. package/build/react/hooks/build-image-editor-setters.cjs +72 -0
  58. package/build/react/hooks/build-image-editor-setters.cjs.map +1 -0
  59. package/build/react/hooks/index.cjs +31 -0
  60. package/build/react/hooks/use-aria-announcer.cjs +100 -0
  61. package/build/react/hooks/use-aria-announcer.cjs.map +1 -0
  62. package/build/react/hooks/use-image-editor.cjs +162 -0
  63. package/build/react/hooks/use-image-editor.cjs.map +1 -0
  64. package/build/react/hooks/use-interaction.cjs +187 -0
  65. package/build/react/hooks/use-interaction.cjs.map +1 -0
  66. package/build/react/hooks/use-transform-style.cjs +24 -0
  67. package/build/react/hooks/use-transform-style.cjs.map +1 -0
  68. package/build/react/hooks/use-viewport-state.cjs +40 -0
  69. package/build/react/hooks/use-viewport-state.cjs.map +1 -0
  70. package/build/react/visually-hidden-style.cjs +24 -0
  71. package/build/react/visually-hidden-style.cjs.map +1 -0
  72. package/build-module/core/camera.mjs +265 -0
  73. package/build-module/core/camera.mjs.map +1 -0
  74. package/build-module/core/constants.mjs +92 -0
  75. package/build-module/core/constants.mjs.map +1 -0
  76. package/build-module/core/containment.mjs +281 -0
  77. package/build-module/core/containment.mjs.map +1 -0
  78. package/build-module/core/crop-rect.mjs +32 -0
  79. package/build-module/core/crop-rect.mjs.map +1 -0
  80. package/build-module/core/export/canvas-renderer.mjs +167 -0
  81. package/build-module/core/export/canvas-renderer.mjs.map +1 -0
  82. package/build-module/core/interaction-controller.mjs +586 -0
  83. package/build-module/core/interaction-controller.mjs.map +1 -0
  84. package/build-module/core/math/rotation.mjs +26 -0
  85. package/build-module/core/math/rotation.mjs.map +1 -0
  86. package/build-module/core/math/sanitize.mjs +127 -0
  87. package/build-module/core/math/sanitize.mjs.map +1 -0
  88. package/build-module/core/setter-helpers.mjs +54 -0
  89. package/build-module/core/setter-helpers.mjs.map +1 -0
  90. package/build-module/core/source-region.mjs +205 -0
  91. package/build-module/core/source-region.mjs.map +1 -0
  92. package/build-module/core/state.mjs +453 -0
  93. package/build-module/core/state.mjs.map +1 -0
  94. package/build-module/core/stencil-math.mjs +194 -0
  95. package/build-module/core/stencil-math.mjs.map +1 -0
  96. package/build-module/core/transform-style.mjs +38 -0
  97. package/build-module/core/transform-style.mjs.map +1 -0
  98. package/build-module/core/transforms/pipeline.mjs +35 -0
  99. package/build-module/core/transforms/pipeline.mjs.map +1 -0
  100. package/build-module/core/types.mjs +0 -0
  101. package/build-module/core/viewport-state.mjs +30 -0
  102. package/build-module/core/viewport-state.mjs.map +1 -0
  103. package/build-module/export-image.mjs +30 -0
  104. package/build-module/export-image.mjs.map +1 -0
  105. package/build-module/get-image-edit.mjs +96 -0
  106. package/build-module/get-image-edit.mjs.map +1 -0
  107. package/build-module/get-output-size.mjs +33 -0
  108. package/build-module/get-output-size.mjs.map +1 -0
  109. package/build-module/index.mjs +8 -0
  110. package/build-module/map-image-edit.mjs +29 -0
  111. package/build-module/map-image-edit.mjs.map +1 -0
  112. package/build-module/react/components/image-editor-canvas.mjs +539 -0
  113. package/build-module/react/components/image-editor-canvas.mjs.map +1 -0
  114. package/build-module/react/components/index.mjs +1 -0
  115. package/build-module/react/components/overlays/dimensions-overlay.mjs +142 -0
  116. package/build-module/react/components/overlays/dimensions-overlay.mjs.map +1 -0
  117. package/build-module/react/components/overlays/dimming-overlay.mjs +26 -0
  118. package/build-module/react/components/overlays/dimming-overlay.mjs.map +1 -0
  119. package/build-module/react/components/overlays/grid-overlay.mjs +56 -0
  120. package/build-module/react/components/overlays/grid-overlay.mjs.map +1 -0
  121. package/build-module/react/components/stencils/rectangle-stencil.mjs +362 -0
  122. package/build-module/react/components/stencils/rectangle-stencil.mjs.map +1 -0
  123. package/build-module/react/components/viewport-provider.mjs +20 -0
  124. package/build-module/react/components/viewport-provider.mjs.map +1 -0
  125. package/build-module/react/hooks/build-image-editor-setters.mjs +67 -0
  126. package/build-module/react/hooks/build-image-editor-setters.mjs.map +1 -0
  127. package/build-module/react/hooks/index.mjs +3 -0
  128. package/build-module/react/hooks/use-aria-announcer.mjs +95 -0
  129. package/build-module/react/hooks/use-aria-announcer.mjs.map +1 -0
  130. package/build-module/react/hooks/use-image-editor.mjs +155 -0
  131. package/build-module/react/hooks/use-image-editor.mjs.map +1 -0
  132. package/build-module/react/hooks/use-interaction.mjs +182 -0
  133. package/build-module/react/hooks/use-interaction.mjs.map +1 -0
  134. package/build-module/react/hooks/use-transform-style.mjs +19 -0
  135. package/build-module/react/hooks/use-transform-style.mjs.map +1 -0
  136. package/build-module/react/hooks/use-viewport-state.mjs +35 -0
  137. package/build-module/react/hooks/use-viewport-state.mjs.map +1 -0
  138. package/build-module/react/visually-hidden-style.mjs +19 -0
  139. package/build-module/react/visually-hidden-style.mjs.map +1 -0
  140. package/build-style/style-rtl.css +186 -0
  141. package/build-style/style.css +189 -0
  142. package/build-types/core/camera.d.ts +128 -0
  143. package/build-types/core/camera.d.ts.map +1 -0
  144. package/build-types/core/constants.d.ts +66 -0
  145. package/build-types/core/constants.d.ts.map +1 -0
  146. package/build-types/core/containment.d.ts +72 -0
  147. package/build-types/core/containment.d.ts.map +1 -0
  148. package/build-types/core/crop-rect.d.ts +16 -0
  149. package/build-types/core/crop-rect.d.ts.map +1 -0
  150. package/build-types/core/export/canvas-renderer.d.ts +87 -0
  151. package/build-types/core/export/canvas-renderer.d.ts.map +1 -0
  152. package/build-types/core/interaction-controller.d.ts +191 -0
  153. package/build-types/core/interaction-controller.d.ts.map +1 -0
  154. package/build-types/core/math/rotation.d.ts +18 -0
  155. package/build-types/core/math/rotation.d.ts.map +1 -0
  156. package/build-types/core/math/sanitize.d.ts +67 -0
  157. package/build-types/core/math/sanitize.d.ts.map +1 -0
  158. package/build-types/core/setter-helpers.d.ts +19 -0
  159. package/build-types/core/setter-helpers.d.ts.map +1 -0
  160. package/build-types/core/source-region.d.ts +74 -0
  161. package/build-types/core/source-region.d.ts.map +1 -0
  162. package/build-types/core/state.d.ts +72 -0
  163. package/build-types/core/state.d.ts.map +1 -0
  164. package/build-types/core/stencil-math.d.ts +102 -0
  165. package/build-types/core/stencil-math.d.ts.map +1 -0
  166. package/build-types/core/transform-style.d.ts +20 -0
  167. package/build-types/core/transform-style.d.ts.map +1 -0
  168. package/build-types/core/transforms/pipeline.d.ts +24 -0
  169. package/build-types/core/transforms/pipeline.d.ts.map +1 -0
  170. package/build-types/core/types.d.ts +325 -0
  171. package/build-types/core/types.d.ts.map +1 -0
  172. package/build-types/core/viewport-state.d.ts +4 -0
  173. package/build-types/core/viewport-state.d.ts.map +1 -0
  174. package/build-types/export-image.d.ts +32 -0
  175. package/build-types/export-image.d.ts.map +1 -0
  176. package/build-types/get-image-edit.d.ts +63 -0
  177. package/build-types/get-image-edit.d.ts.map +1 -0
  178. package/build-types/get-output-size.d.ts +15 -0
  179. package/build-types/get-output-size.d.ts.map +1 -0
  180. package/build-types/index.d.ts +17 -0
  181. package/build-types/index.d.ts.map +1 -0
  182. package/build-types/map-image-edit.d.ts +26 -0
  183. package/build-types/map-image-edit.d.ts.map +1 -0
  184. package/build-types/react/components/image-editor-canvas.d.ts +49 -0
  185. package/build-types/react/components/image-editor-canvas.d.ts.map +1 -0
  186. package/build-types/react/components/index.d.ts +3 -0
  187. package/build-types/react/components/index.d.ts.map +1 -0
  188. package/build-types/react/components/overlays/dimensions-overlay.d.ts +33 -0
  189. package/build-types/react/components/overlays/dimensions-overlay.d.ts.map +1 -0
  190. package/build-types/react/components/overlays/dimming-overlay.d.ts +17 -0
  191. package/build-types/react/components/overlays/dimming-overlay.d.ts.map +1 -0
  192. package/build-types/react/components/overlays/grid-overlay.d.ts +27 -0
  193. package/build-types/react/components/overlays/grid-overlay.d.ts.map +1 -0
  194. package/build-types/react/components/stencils/rectangle-stencil.d.ts +33 -0
  195. package/build-types/react/components/stencils/rectangle-stencil.d.ts.map +1 -0
  196. package/build-types/react/components/viewport-provider.d.ts +6 -0
  197. package/build-types/react/components/viewport-provider.d.ts.map +1 -0
  198. package/build-types/react/hooks/build-image-editor-setters.d.ts +39 -0
  199. package/build-types/react/hooks/build-image-editor-setters.d.ts.map +1 -0
  200. package/build-types/react/hooks/index.d.ts +5 -0
  201. package/build-types/react/hooks/index.d.ts.map +1 -0
  202. package/build-types/react/hooks/use-aria-announcer.d.ts +14 -0
  203. package/build-types/react/hooks/use-aria-announcer.d.ts.map +1 -0
  204. package/build-types/react/hooks/use-image-editor.d.ts +173 -0
  205. package/build-types/react/hooks/use-image-editor.d.ts.map +1 -0
  206. package/build-types/react/hooks/use-interaction.d.ts +65 -0
  207. package/build-types/react/hooks/use-interaction.d.ts.map +1 -0
  208. package/build-types/react/hooks/use-transform-style.d.ts +13 -0
  209. package/build-types/react/hooks/use-transform-style.d.ts.map +1 -0
  210. package/build-types/react/hooks/use-viewport-state.d.ts +16 -0
  211. package/build-types/react/hooks/use-viewport-state.d.ts.map +1 -0
  212. package/build-types/react/visually-hidden-style.d.ts +6 -0
  213. package/build-types/react/visually-hidden-style.d.ts.map +1 -0
  214. package/docs/architecture.md +81 -0
  215. package/docs/recipes.md +234 -0
  216. package/docs/toc.json +14 -0
  217. package/package.json +85 -5
  218. package/src/core/camera.ts +429 -0
  219. package/src/core/constants.ts +103 -0
  220. package/src/core/containment.ts +469 -0
  221. package/src/core/crop-rect.ts +42 -0
  222. package/src/core/export/canvas-renderer.ts +255 -0
  223. package/src/core/interaction-controller.ts +976 -0
  224. package/src/core/math/rotation.ts +26 -0
  225. package/src/core/math/sanitize.ts +157 -0
  226. package/src/core/setter-helpers.ts +65 -0
  227. package/src/core/source-region.ts +331 -0
  228. package/src/core/state.ts +740 -0
  229. package/src/core/stencil-math.ts +379 -0
  230. package/src/core/transform-style.ts +56 -0
  231. package/src/core/transforms/pipeline.ts +43 -0
  232. package/src/core/types.ts +280 -0
  233. package/src/core/viewport-state.ts +30 -0
  234. package/src/export-image.ts +52 -0
  235. package/src/get-image-edit.ts +147 -0
  236. package/src/get-output-size.ts +42 -0
  237. package/src/index.ts +32 -0
  238. package/src/map-image-edit.ts +41 -0
  239. package/src/react/components/image-editor-canvas.scss +265 -0
  240. package/src/react/components/image-editor-canvas.tsx +1040 -0
  241. package/src/react/components/index.ts +2 -0
  242. package/src/react/components/overlays/dimensions-overlay.tsx +262 -0
  243. package/src/react/components/overlays/dimming-overlay.tsx +55 -0
  244. package/src/react/components/overlays/grid-overlay.tsx +77 -0
  245. package/src/react/components/stencils/rectangle-stencil.tsx +623 -0
  246. package/src/react/components/viewport-provider.tsx +32 -0
  247. package/src/react/hooks/build-image-editor-setters.ts +95 -0
  248. package/src/react/hooks/index.ts +14 -0
  249. package/src/react/hooks/use-aria-announcer.ts +190 -0
  250. package/src/react/hooks/use-image-editor.ts +421 -0
  251. package/src/react/hooks/use-interaction.ts +294 -0
  252. package/src/react/hooks/use-transform-style.ts +23 -0
  253. package/src/react/hooks/use-viewport-state.ts +41 -0
  254. package/src/react/visually-hidden-style.ts +15 -0
  255. package/src/style.scss +1 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,27 @@
1
+ <!-- Learn how to maintain this file at https://github.com/WordPress/gutenberg/tree/HEAD/packages#maintaining-changelogs. -->
2
+
3
+ ## Unreleased
4
+
5
+ ## 0.1.0 (2026-11-18)
6
+
7
+ Initial release ([#86223](https://github.com/WordPress/gutenberg/pull/86223)).
8
+
9
+ ### Enhancements
10
+
11
+ - Follow WordPress Design System colours and spacing by default when its tokens are present, while keeping standalone defaults and consumer overrides ([#86402](https://github.com/WordPress/gutenberg/pull/86402)).
12
+ - Allow consumers to theme the canvas through CSS custom properties ([#86340](https://github.com/WordPress/gutenberg/pull/86340)).
13
+ - Add `exportImage( state, options? )`, which exports the edited image as a `Blob` in the browser ([#86405](https://github.com/WordPress/gutenberg/pull/86405)).
14
+ - Describe the edit to apply when saving as one `ImageEdit` record, returned by `getImageEdit( state )` ([#86630](https://github.com/WordPress/gutenberg/pull/86630)).
15
+ - Add `mapImageEdit( edit, handlers )`, which turns each part of an `ImageEdit` into the consumer's own format in the order the parts apply ([#86704](https://github.com/WordPress/gutenberg/pull/86704)).
16
+
17
+ ### Bug Fixes
18
+
19
+ - Compare only the public edit fields when checking whether two image editor states are equal ([#86286](https://github.com/WordPress/gutenberg/pull/86286)).
20
+ - Fit a supplied crop to its locked ratio before `useImageEditor` exposes it or applies an edit ([#86286](https://github.com/WordPress/gutenberg/pull/86286)).
21
+ - Restore maximum locked crops and panned positions through quarter turns ([#86286](https://github.com/WordPress/gutenberg/pull/86286)).
22
+ - Announce the crop size that the resize tooltip shows, so the two agree on a nearly full crop ([#86487](https://github.com/WordPress/gutenberg/pull/86487)).
23
+
24
+ ### Internal
25
+
26
+ - Update the Storybook development dependencies to 10.6.6 ([#86507](https://github.com/WordPress/gutenberg/pull/86507)).
27
+ - Update the Vitest development dependency to 5.1.0 ([#86509](https://github.com/WordPress/gutenberg/pull/86509)).