Skip to content

cloudinary/cloudinary-react

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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 Version React 15.3 React 16.2 React 16.3 React 17 React 18
1.6.8 & up X X V V V
1.2.0 - 1.6.7 X X V X X
1.0.5 - 1.1.4 X V X X X
1.0.0 - 1.0.4 V X X X X

Installation

Install using your favorite package manager (yarn, npm)

npm install cloudinary-react

Or

yarn add cloudinary-react

Usage

Setup

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

Transform and Optimize Assets

  • See full documentation

     // Apply a single transformation
     <Image cloudName="demo" publicId="sample">
       <Transformation crop="scale" width="200" angle="10" />
     </Image>
    // Chain (compose) multiple transformations
    <Image cloudName="demo" publicId="sample">
          <Transformation angle="-45" />
          <Transformation effect="trim" angle="45" crop="scale" width="600" />
          <Transformation overlay="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.