Skip to content

Commit 1efbd25

Browse files
authored
Merge pull request #78 from ashishleo10/patch-1
Layered Syntax
2 parents 45aca40 + 246d4fe commit 1efbd25

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,15 @@ See the complete list of transformations supported in ImageKit [here](https://do
181181

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

184+
<br/>
185+
186+
> #### Deprecation notice
187+
> 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.
188+
> If you create overlay transformations using the Node.js SDK, you can migrate to the new Layers syntax using the `raw` transformation parameter, as given in the example below.
189+
> `transformation : [{ "width" : 300, "height" : 300 },{ "raw": "l-image,i-logo.png,w-10,rt-90,l-end" }]`
190+
191+
<br/>
192+
184193
| Supported Transformation Name | Translates to parameter |
185194
|-------------------------------|-------------------------|
186195
| height | h |

0 commit comments

Comments
 (0)