Skip to content

imagekit-developer/imagekit-next

Repository files navigation

ImageKit.io

ImageKit.io Next.js SDK

Node CI npm version License: MIT Twitter Follow

Introduction

ImageKit Next.js SDK provides a simple way to integrate ImageKit.io with your Next.js 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.
  • Provide utility functions for uploading files.

Installation

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

npm install @imagekit/next

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 for more details on how to use the SDK.