https://github.com/cloudinary/cloudinary-react
React components that utilize Cloudinary functionality
https://github.com/cloudinary/cloudinary-react
cloudinary cloudinary-sdk cloudinary-sdks image-manipulation javascript react-components reactjs sdk-js video-manipulation web-development
Last synced: 5 months ago
JSON representation
React components that utilize Cloudinary functionality
- Host: GitHub
- URL: https://github.com/cloudinary/cloudinary-react
- Owner: cloudinary
- License: mit
- Created: 2016-08-30T10:56:20.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-05T11:37:52.000Z (about 2 years ago)
- Last Synced: 2025-05-04T11:03:12.756Z (6 months ago)
- Topics: cloudinary, cloudinary-sdk, cloudinary-sdks, image-manipulation, javascript, react-components, reactjs, sdk-js, video-manipulation, web-development
- Language: JavaScript
- Homepage:
- Size: 4.12 MB
- Stars: 502
- Watchers: 34
- Forks: 219
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://cloudinary.com/documentation/react1_integration).
## Table of Contents
- [Key Features](#key-features)
- [Version Support](#Version-Support)
- [Installation](#installation)
- [Usage](#usage)
- [Setup](#Setup)
- [Transform and Optimize Assets](#Transform-and-Optimize-Assets)
- [Generate Image and HTML Tags](#Generate-Image-and-Video-HTML-Tags)
## Key Features
- [Transform](https://cloudinary.com/documentation/react1_video_manipulation#video_transformation_examples) and [optimize](https://cloudinary.com/documentation/react1_image_manipulation#image_optimizations) assets.
- Generate [image](https://cloudinary.com/documentation/react1_image_manipulation#deliver_and_transform_images) and [video](https://cloudinary.com/documentation/react1_video_manipulation#video_element) tags.
## 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)
```bash
npm install cloudinary-react
```
Or
```bash
yarn add cloudinary-react
```
## Usage
### Setup
```javascript
import React from 'react';
import {Image, Video, Transformation} from 'cloudinary-react';
```
### Transform and Optimize Assets
- [See full documentation](https://cloudinary.com/documentation/react1_image_manipulation)
```jsx
// Apply a single transformation
```
```jsx
// Chain (compose) multiple transformations
```
### Generate Image and Video HTML Tags
- Use to generate image tags
- Use 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](https://cloudinary.com/documentation/react1_image_and_video_upload).
## 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:
- [Open a Github issue](https://github.com/CloudinaryLtd/cloudinary-react/issues) (for issues related to the SDK)
- [Open a support ticket](https://cloudinary.com/contact) (for issues related to your account)
## 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
- [Cloudinary Transformation and REST API References](https://cloudinary.com/documentation/cloudinary_references): Comprehensive references, including syntax and examples for all SDKs.
- [MediaJams.dev](https://mediajams.dev/): Bite-size use-case tutorials written by and for Cloudinary Developers
- [DevJams](https://www.youtube.com/playlist?list=PL8dVGjLA2oMr09amgERARsZyrOz_sPvqw): Cloudinary developer podcasts on YouTube.
- [Cloudinary Academy](https://training.cloudinary.com/): Free self-paced courses, instructor-led virtual courses, and on-site courses.
- [Code Explorers and Feature Demos](https://cloudinary.com/documentation/code_explorers_demos_index): A one-stop shop for all code explorers, Postman collections, and feature demos found in the docs.
- [Cloudinary Roadmap](https://cloudinary.com/roadmap): Your chance to follow, vote, or suggest what Cloudinary should develop next.
- [Cloudinary Facebook Community](https://www.facebook.com/groups/CloudinaryCommunity): Learn from and offer help to other Cloudinary developers.
- [Cloudinary Account Registration](https://cloudinary.com/users/register/free): Free Cloudinary account registration.
- [Cloudinary Website](https://cloudinary.com): Learn about Cloudinary's products, partners, customers, pricing, and more.
## Licence
Released under the MIT license.