Skip to content

Commit 10aa5a4

Browse files
ANKUR DWIVEDIANKUR DWIVEDI
ANKUR DWIVEDI
authored and
ANKUR DWIVEDI
committed
updated readme
1 parent 719b2c4 commit 10aa5a4

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,17 @@
99

1010
ImageKit Vue.js SDK allows you to use real-time [image resizing](https://docs.imagekit.io/features/image-transformations), [optimization](https://docs.imagekit.io/features/image-optimization), and [file uploading](https://docs.imagekit.io/api-reference/upload-file-api/client-side-file-upload) in client-side.
1111

12-
## Breaking changes - Upgrading from 1.x to 2.x version
12+
## Breaking changes
13+
14+
### Upgrading from 2.x to 3.x version
15+
16+
1. Overlay syntax update
17+
18+
* In version 3.0.0, we've removed the old overlay syntax parameters for transformations, such as `oi`, `ot`, `obg`, and [more](https://docs.imagekit.io/features/image-transformations/overlay). These parameters are deprecated 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.
19+
* You can migrate to the new layers syntax using the `raw` transformation parameter.
20+
21+
### Upgrading from 1.x to 2.x version
22+
1323
2.x version has breaking changes as listed below.
1424

1525
1. In version 2.0.1, three global components, namely `ik-image`, `ik-upload`, and `ik-context`, are no longer supported. Instead, it is recommended to import these components individually.
@@ -192,6 +202,15 @@ import { IKImage, IKUpload, IKContext, IKVideo, } from 'imagekitio-vue'
192202
:ref={uploadRef}
193203
:onError={onError}
194204
:onSuccess={onSuccess}
205+
:transformation="{
206+
pre: 'l-text,i-Imagekit,fs-50,l-end',
207+
post: [
208+
{
209+
type: 'transformation',
210+
value: 'w-100'
211+
}
212+
]
213+
}"
195214
/>
196215
</IKContext>
197216
@@ -612,6 +631,15 @@ Sample file upload:
612631
:onError="onError"
613632
:onSuccess="onSuccess"
614633
customCoordinates="10,10,100,100"
634+
:transformation="{
635+
pre: 'l-text,i-Imagekit,fs-50,l-end',
636+
post: [
637+
{
638+
type: 'transformation',
639+
value: 'w-100'
640+
}
641+
]
642+
}"
615643
/>
616644
</template>
617645

@@ -662,6 +690,15 @@ Example Usage
662690
:onError="onError"
663691
:onSuccess="onSuccess"
664692
customCoordinates="10,10,100,100"
693+
:transformation="{
694+
pre: 'l-text,i-Imagekit,fs-50,l-end',
695+
post: [
696+
{
697+
type: 'transformation',
698+
value: 'w-100'
699+
}
700+
]
701+
}"
665702
/>
666703
<button @click="abortChildUpload">Abort Child Upload</button>
667704
</template>

0 commit comments

Comments
 (0)