|
8 | 8 | [](https://opensource.org/licenses/MIT)
|
9 | 9 | [](https://twitter.com/ImagekitIo)
|
10 | 10 |
|
11 |
| -ImageKit React SDK allows you to resize, optimize, deliver and upload images and videos in your react application. |
| 11 | +ImageKit React SDK allows you to resize, optimize, deliver, and upload images and videos in your React application. |
12 | 12 |
|
13 | 13 | ImageKit is a complete media storage, optimization, and transformation solution that comes with an image and video CDN. It can be integrated with your existing infrastructure - storage like AWS S3, web servers, your CDN, and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes.
|
14 | 14 |
|
15 | 15 | ## Changelog - SDK Version 3.0.0
|
16 | 16 | ### Breaking changes
|
17 | 17 | **1. Authentication Process Update:**
|
18 |
| -* Previously, when using this SDK, we had to pass `authenticationEndpoint` which is used by SDK internally for fetching security parameters i.e `signature`, `token`, and `expire`. |
19 | 18 | * In version 3.0.0, we have deprecated the use of the `authenticationEndpoint` parameter. Instead, the SDK now introduces a new parameter named `authenticator`. This parameter expects an asynchronous function that resolves with an object containing the necessary security parameters i.e `signature`, `token`, and `expire`.
|
20 |
| -* Now `ref` needs to passed instead of `inputRef` in IKUpload component |
| 19 | +* Now `ref` needs to be passed instead of `inputRef` in the IKUpload component |
21 | 20 |
|
22 |
| -Example implementation for `authenticator` using `Fetch API`. |
| 21 | +An example implementation for `authenticator` using `Fetch API`. |
23 | 22 |
|
24 | 23 | ``` javascript
|
25 | 24 |
|
26 | 25 | const authenticator = async () => {
|
27 | 26 | try {
|
28 | 27 |
|
29 |
| - // You can pass headers as well and later validate the request source in the backend, or you can use headers for any other use case. |
| 28 | + // You can also pass headers and validate the request source in the backend, or you can use headers for any other use case. |
30 | 29 | const headers = {
|
31 |
| - 'Authorization': 'Bearer your-access-token', |
32 | 30 | 'CustomHeader': 'CustomValue'
|
33 | 31 | };
|
34 | 32 |
|
@@ -135,7 +133,7 @@ import { IKImage, IKVideo, IKContext, IKUpload } from 'imagekitio-react'
|
135 | 133 | lqip={{ active: true, quality: 20, blur: 10 }}
|
136 | 134 | />
|
137 | 135 |
|
138 |
| - // Low-quality image placeholder and lazy loading original image in the background |
| 136 | + // Low-quality image placeholder and lazy loading of original image in the background |
139 | 137 | <IKImage
|
140 | 138 | path="/default-image.jpg"
|
141 | 139 | transformation={[{
|
|
0 commit comments