Skip to content

Repository files navigation

Cloudinary React SDK

About

NOTE-IMPORTANT: This is a legacy package, please find latest at https://github.com/cloudinary/frontend-frameworks/tree/master/packages/react

The Cloudinary React SDK allows you to quickly and easily integrate your application with Cloudinary. Effortlessly optimize and transform your cloud's assets.

Note

This Readme provides basic installation and usage information. For the complete documentation, see the React SDK Guide.

Table of Contents

Key Features

Version Support

SDK VersionReact 15.3React 16.2React 16.3React 17React 18
1.6.8 & upXXVVV
1.2.0 - 1.6.7XXVXX
1.0.5 - 1.1.4XVXXX
1.0.0 - 1.0.4VXXXX

Installation

Install using your favorite package manager (yarn, npm)

npm install cloudinary-react

Or

yarn add cloudinary-react

Usage

Setup

importReactfrom'react';import{Image,Video,Transformation}from'cloudinary-react';

Transform and Optimize Assets

  • See full documentation

    // Apply a single transformation<ImagecloudName="demo"publicId="sample"><Transformationcrop="scale"width="200"angle="10"/></Image>
    // Chain (compose) multiple transformations<ImagecloudName="demo"publicId="sample"><Transformationangle="-45"/><Transformationeffect="trim"angle="45"crop="scale"width="600"/><Transformationoverlay="text:Arial_100:Hello"/></Image>

Generate Image and Video HTML Tags

- Use <Image> to generate image tags
- Use <Video> to generate video tags

File upload

This SDK does not provide file upload functionality, however there are several methods of uploading from the client side.

Contributions

  • Ensure tests run locally (npm run test)
  • Open a PR and ensure Travis tests pass

Get Help

If you run into an issue or have a question, you can either:

About Cloudinary

Cloudinary is a powerful media API for websites and mobile apps alike, Cloudinary enables developers to efficiently manage, transform, optimize, and deliver images and videos through multiple CDNs. Ultimately, viewers enjoy responsive and personalized visual-media experiences—irrespective of the viewing device.

Additional Resources

Licence

Released under the MIT license.

Releases

Packages

Used by

Contributors

Languages