# cloudinary-react

> This is a legacy package, please find latest at https://www.npmjs.com/package/@cloudinary/react

Latest version **1.8.1** (published 2022-07-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install cloudinary-react
pnpm add cloudinary-react
yarn add cloudinary-react
bun add cloudinary-react
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.8.1 |
| Published | 2022-07-21 |
| First published | 2016-11-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 106 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 499 |
| Author | Cloudinary |
| Maintainers | cloudinary |

## Links

- npm: https://www.npmjs.com/package/cloudinary-react
- Repository: https://github.com/cloudinary/cloudinary-react
- Homepage: https://github.com/cloudinary/cloudinary-react#readme
- Issues: https://github.com/cloudinary/cloudinary-react/issues
- npm.io page: https://npm.io/package/cloudinary-react

## Dependencies (2)

- [prop-types](https://npm.io/package/prop-types.md) ^15.8.1
- [cloudinary-core](https://npm.io/package/cloudinary-core.md) ^2.13.0

## Recent versions

- 1.8.1 (latest) — 2022-07-21
- 1.0.0 (edge) — 2020-11-17
- 1.8.0 — 2022-06-27
- 1.7.2 — 2022-03-24
- 1.7.1 — 2022-01-25
- 1.7.0 — 2021-02-28
- 1.6.8 — 2020-11-16
- 1.6.7 — 2020-10-04
- 1.6.6 — 2020-07-27
- 1.6.5 — 2020-07-26
- 1.6.4 — 2020-07-26
- 1.6.3 — 2020-07-26
- 1.6.2 — 2020-07-16
- 1.6.1 — 2020-07-11
- 1.6.0 — 2020-07-06
- … 21 more at https://npm.io/package/cloudinary-react/versions

## 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
    <Image cloudName="demo" publicId="sample">
      <Transformation crop="scale" width="200" angle="10" />
    </Image>
    ```

    ```jsx
    // 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](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.

---
_Source: https://npm.io/package/cloudinary-react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
