Skip to content

Commit 020cd51

Browse files
authored
Merge pull request #79 from ashishleo10/patch-1
Layered Syntax Notification
2 parents bef98fe + 0880bf8 commit 020cd51

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,14 @@ See the complete list of transformations supported in ImageKit [here](https://do
199199

200200
If you want to generate transformations in your application and add them to the URL as it is, use the `raw` parameter.
201201

202+
<br/>
203+
204+
> #### Deprecation notice
205+
> The list below mentions the old overlay syntax parameters such as `oi`, `ot`, `obg`, and more. These parameters 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.
206+
> If you create overlay transformations using the JavaScript SDK, you can migrate to the new Layers syntax using the `raw` transformation parameter, as given in the example below.
207+
> `transformation : [{ "width" : 300, "height" : 300 },{ "raw": "l-image,i-logo.png,w-10,rt-90,l-end" }]`
208+
<br/>
209+
202210
| Supported Transformation Name | Translates to parameter |
203211
|-------------------------------|-------------------------|
204212
| height | h |
@@ -425,4 +433,4 @@ try {
425433
// {'content-type': 'application/json', 'x-request-id': 'ee560df4-d44f-455e-a48e-29dfda49aec5'}
426434
console.log(response.$ResponseMetadata.headers);
427435
}
428-
```
436+
```

0 commit comments

Comments
 (0)