Skip to content

Layered Syntax Notification #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 7, 2023
Merged

Layered Syntax Notification #79

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
821f697
Layered Syntax Notification
ashishleo10 Sep 5, 2023
1f19f83
Update README.md
imagekitio Sep 7, 2023
0880bf8
Merge branch 'master' into patch-1
imagekitio Sep 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,14 @@ See the complete list of transformations supported in ImageKit [here](https://do

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

<br/>

> #### Deprecation notice
> 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.
> 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.
> `transformation : [{ "width" : 300, "height" : 300 },{ "raw": "l-image,i-logo.png,w-10,rt-90,l-end" }]`
<br/>

| Supported Transformation Name | Translates to parameter |
|-------------------------------|-------------------------|
| height | h |
Expand Down Expand Up @@ -425,4 +433,4 @@ try {
// {'content-type': 'application/json', 'x-request-id': 'ee560df4-d44f-455e-a48e-29dfda49aec5'}
console.log(response.$ResponseMetadata.headers);
}
```
```