An open API service indexing awesome lists of open source software.

https://github.com/imagekit-developer/imagekit-react

React SDK for using ImageKit.io
https://github.com/imagekit-developer/imagekit-react

image-manipulation image-optimization imagekit sdk

Last synced: about 2 months ago
JSON representation

React SDK for using ImageKit.io

Awesome Lists containing this project

README

          

[ImageKit.io](https://imagekit.io)

# ImageKit.io React SDK

![Node CI](https://github.com/imagekit-developer/imagekit-react/workflows/Node%20CI/badge.svg)
[![npm version](https://img.shields.io/npm/v/@imagekit/react)](https://www.npmjs.com/package/@imagekit/react)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?label=Follow&style=social)](https://twitter.com/ImagekitIo)

## Introduction

ImageKit React SDK provides a simple way to integrate ImageKit.io with your React applications. It allows you to easily:
- Render images and video with automatic optimization and responsive sizes.
- Apply transformations to images and videos using URL parameters.
- Apply powerful AI-powered image transformations e.g. background removal, generative fill, object cropping, and more.

## Installation

You can install the SDK in your project using npm or yarn.

```bash
npm install @imagekit/react
```

## TypeScript support

The SDK is written in TypeScript, offering first-class TypeScript support. Enjoy excellent type safety and IntelliSense in your IDE. You can use it in your TypeScript projects without any additional configuration.

To enable type checking in JavaScript projects, add `//@ts-check` at the top of your JavaScript files. This will activate type checking in your IDE.

## Documentation

Refer to the ImageKit [official documentation](https://imagekit.io/docs/integration/react) for more details on how to use the SDK.