Skip to content

Commit 821f697

Browse files
authored
Layered Syntax Notification
1 parent fea3e21 commit 821f697

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,22 @@ If you want to generate transformations in your application and add them to the
255255
| raw | The string provided in raw will be added in the URL as it is. |
256256

257257

258+
##### Deprecation notice
259+
260+
The old overlay syntax will be deprecated on 31st Oct 2023 and will start returning errors when used in URLs. Please migrate to the new Layers syntax that supports overlay nesting, provides better positional control, and allows more transformations at the layer level. You can start with [examples](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#examples) to learn quickly.
261+
262+
If you are creating overlay transformations using the JavaScript SDK, you can migrate to the new Layers syntax using the raw parameter:
263+
264+
transformation : [
265+
{
266+
"width" : 300,
267+
"height" : 300
268+
},
269+
{
270+
"raw": "l-image,i-logo.png,w-10,rt-90,l-end"
271+
}]
272+
273+
258274
### File Upload
259275

260276
The SDK provides a simple interface using the `.upload()` method to upload files to the ImageKit Media Library.

0 commit comments

Comments
 (0)