React quick start

This quick start is intended to let you quickly try using several common Cloudinary features. It doesn't necessarily employ coding best practices and the code you create here isn't intended for production.

You can perform this quick start in a code sandbox or in a clean project in the dev environment of your choice.

You can also view the completed code of this quick start in a GitHub repo and code explorer.

Two libraries are required:

• frontend-frameworks for rendering media using the React framework.
• js-url-gen for building transformations.

Prerequisites

To perform the steps in this quick start, you'll need:

• A Cloudinary account. If you don't have one yet, you can quickly register for free.
• Your product environment credentials. You can find your credentials in the Dashboard page of your Cloudinary Console.
• A working React development environment with a supported version of React.

1. Set up and configure the SDK

Install the packages

Install the required packages using the NPM package manager:

npm i @cloudinary/url-gen @cloudinary/react

Configure Cloudinary

Create a basic React app, and in App.js copy and paste the following:

import React from 'react'
import {Cloudinary} from "@cloudinary/url-gen";

const App = () => {

  // Create a Cloudinary instance and set your cloud name.
  const cld = new Cloudinary({
    cloud: {
      cloudName: 'demo'
    }
  });
};

2. Upload an image

If you changed the cloud name in the previous step, you need to use an image in your Cloudinary product environment for the next steps. All new accounts come with sample images, so you can use one of those, or, if you want to use the same image as us, save this image locally, then for the purposes of this quick start, the simplest way to upload it is as follows:

1. Log into your Cloudinary Console.
2. Select Media Library from the left panel.
3. Click Upload to open the Upload Widget, then click Advanced and type "docs/models" into the Public ID field.
4. Click Browse to find the image to upload. Once uploaded, you can click Recently Uploaded at the top of the Media Library to see your uploaded image.
   

In the next step, you'll need the public ID of whichever image you use (in our case, we set the public ID on upload to docs/models). If using one of the sample images, you can double-click the image in your Media Library and copy the public ID (between the version number and the extension):

3. Transform and deliver the image

Copy and paste these import statements below the existing ones:

import {AdvancedImage} from '@cloudinary/react';
import {fill} from "@cloudinary/url-gen/actions/resize";

Copy and paste the following code in the App function, under the configuration code:

  // Instantiate a CloudinaryImage object for the image with the public ID, 'docs/models'.
  const myImage = cld.image('docs/models'); 

  // Resize to 250 x 250 pixels using the 'fill' crop mode.
  myImage.resize(fill().width(250).height(250));

  // Render the image in a React component.
  return (
    <div>
      <AdvancedImage cldImg={myImage} />
    </div>
  )

4. Run your code

Run the code to see the transformed image.

View the completed code

Here's the full example:

This code is also available in GitHub.