You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-5Lines changed: 20 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ And include it in your HTML:
61
61
62
62
## Initialization
63
63
64
-
Initialize the SDK with your URL endpoint. For URL generation:
64
+
Initialize the SDK by specifying your URL endpoint. You can obtain your URL endpoint from [https://imagekit.io/dashboard/url-endpoints](https://imagekit.io/dashboard/url-endpoints) and your public API key from [https://imagekit.io/dashboard/developer/api-keys](https://imagekit.io/dashboard/developer/api-keys). For URL generation:
@@ -201,16 +201,20 @@ var imageURL = imagekit.url({
201
201
202
202
### Supported Transformations
203
203
204
-
The SDK supports various transformations which are translated to URL parameters as follows:
204
+
The SDK gives a name to each transformation parameter e.g. height for h and width for w parameter. It makes your code more readable. If the property does not match any of the following supported options, it is added as it is.
205
+
206
+
If you want to generate transformations in your application and add them to the URL as it is, use the raw parameter.
207
+
208
+
Check ImageKit [transformation documentation](https://imagekit.io/docs/transformations) for more details.
| aiRemoveBackgroundExternal | e-removedotbg (Using third party)|
214
218
| aiUpscale | e-upscale |
215
219
| aiRetouch | e-retouch |
216
220
| aiVariation | e-genvar |
@@ -246,6 +250,7 @@ The SDK supports various transformations which are translated to URL parameters
246
250
| sharpen | e-sharpen |
247
251
| unsharpMask | e-usm |
248
252
| gradient | e-gradient |
253
+
| flip | fl |
249
254
| opacity | o |
250
255
| zoom | z |
251
256
| page | pg |
@@ -254,12 +259,22 @@ The SDK supports various transformations which are translated to URL parameters
254
259
| duration | du |
255
260
| streamingResolutions | sr |
256
261
| raw | The string provided in raw will be added in the URL as it is. |
257
-
| flip | fl |
258
262
259
263
### Handling Unsupported Transformations
260
264
261
265
If you specify a transformation parameter that is not explicitly supported by the SDK, it is added “as-is” in the generated URL. This provides flexibility for using new or custom transformations without waiting for an SDK update.
0 commit comments