React SDK v2 (Beta)

Important
The React frontend framework library is currently in BETA. There may be minor changes to parameter names or other implementation details before the general access release. We invite you to try it out. We would appreciate any feedback via our support team.

  • Video rendering is not supported in this release.

Quick start

If you're ready to get coding, jump straight to our Quickstart guide. Otherwise, keep reading to get a more in-depth understanding of the React frontend framework library.

Overview

Cloudinary's React frontend framework library provides image rendering capabilities and plugins that you can implement using code that integrates seamlessly with your existing React application.

Related topics
This guide relates to the latest released version of the Cloudinary React library, released from the frontend-frameworks GitHub repository.

For details on all new features and fixes from previous versions, see the CHANGELOG.

Architecture

The React frontend framework library must be used in conjunction with the Cloudinary JavaScript SDK v2 Base library to provide all of Cloudinary's transformation and optimization functionality.

Javascript Architecture

Two GitHub repositories provide all the functionality:

  • cloudinary-js-base contains all the functionality required to create delivery URLs for your Cloudinary assets based on the configuration and transformation actions that you specify. All the cloudinary-js-base functionality is installed through @cloudinary/base.
  • frontend-frameworks contains the framework libraries and plugins that can be used to render images and videos on your site. There are different installation packages for each framework, so for example, React is installed through @cloudinary/react, and Angular is installed through @cloudinary/angular.

Full example

This example shows a transformation URL being created using the cloudinary-js-base library, and rendered using React. It demonstrates the use of tree shaking to reduce the bundle size, which explains why there are so many import statements.

Copy to clipboard
import React from 'react'
import {AdvancedImage} from '@cloudinary/react';
import {Cloudinary} from "@cloudinary/base";
import {Transformation} from "@cloudinary/base";

// Import required actions.
import {thumbnail, scale} from "@cloudinary/base/actions/resize";
import {byRadius} from "@cloudinary/base/actions/roundCorners";
import {sepia} from "@cloudinary/base/actions/effect";
import {source} from "@cloudinary/base/actions/overlay";
import {opacity,brightness} from "@cloudinary/base/actions/adjust";
import {byAngle} from "@cloudinary/base/actions/rotate"
import {format} from "@cloudinary/base/actions/delivery";

// Import required qualifiers.
import {face} from "@cloudinary/base/qualifiers/focusOn";
import {focusOn} from "@cloudinary/base/qualifiers/gravity";
import {image} from "@cloudinary/base/qualifiers/source";
import {Position} from "@cloudinary/base/qualifiers/position";
import {southEast} from "@cloudinary/base/qualifiers/compass";
import {compass} from "@cloudinary/base/qualifiers/gravity";
import {png} from "@cloudinary/base/qualifiers/format";

const App = () => {

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

  // Use the image with public ID, 'front_face'.
  const myImage = cld.image('front_face');

  // Apply the transformation.
  myImage
  .resize(thumbnail().width(150).height(150).gravity(focusOn(face())))  // Crop the image.
  .roundCorners(byRadius(20))    // Round the corners.
  .effect(sepia())  // Apply a sepia effect.
  .overlay(   // Overlay the Cloudinary logo.
    source(
      image('cloudinary_icon_blue')
        .transformation(new Transformation()
        .resize(scale(50)) // Resize the logo.
          .adjust(opacity(60))  // Adjust the opacity of the logo.
        .adjust(brightness(200)))  // Adjust the brightness of the logo.       
    )
    .position(new Position().gravity(compass(southEast())).offsetX(5).offsetY(5))   // Position the logo.
  )
  .rotate(byAngle(10))  // Rotate the result.
  .delivery(format(png()));   // Deliver as PNG. */

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

sample transformation

This code creates the URL required to deliver the front_face.jpg image with the following transformations applied:

  • Crop to a 150x150 thumbnail using face-detection gravity to automatically determine the location for the crop
  • Round the corners with a 20 pixel radius
  • Apply a sepia effect
  • Overlay the Cloudinary logo on the southeast corner of the image (with a slight offset). The logo is scaled down to a 50 pixel width, with increased brightness and partial transparency (opacity = 60%)
  • Rotate the resulting image (including the overlay) by 10 degrees
  • Convert and deliver the image in PNG format (the originally uploaded image was a JPG)

And here's the URL that is generated from the above code:

Getting started with React

Installation

Install both the JavaScript SDK v2 Base and React packages using the NPM package manager:

Copy to clipboard
npm i @cloudinary/base @cloudinary/react

Configuration

You can specify the configuration parameters that are used to create the delivery URLs, either using a Cloudinary instance or per image/video.

Note
Specify the configuration parameters in camelCase, for example cloudName.

Cloudinary instance configuration

If you want to use the same configuration to deliver all your media assets, it's best to set up the configuration through a Cloudinary instance, for example:

Copy to clipboard
import React from 'react'
import {AdvancedImage} from '@cloudinary/react';
import {Cloudinary} from "@cloudinary/base";

const App = () => {

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

  // cld.image returns a CloudinaryImage with the configuration set.
  const myImage = cld.image('sample');

  // The URL of the image is: https://res.cloudinary.com/demo/image/upload/sample

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

You can set other configuration parameters related to your cloud and URL as required, for example, if you have your own custom domain name, and want to generate a secure URL (HTTPS):

Copy to clipboard
// Create a Cloudinary instance, setting some Cloud and URL configuration parameters.
const cld = new Cloudinary({
  cloud: {
    cloudName: 'demo'
  },
  url: {
    secureDistribution: 'www.example.com', 
    secure: true 
  }
});

// This creates a URL of the form: https://www.example.com/demo/image/upload/sample

Asset instance configuration

If you need to specify different configurations to deliver your media assets, you can specify the configuration per image/video instance, for example:

Copy to clipboard
import React from 'react'
import {AdvancedImage} from '@cloudinary/react';
import {CloudinaryImage} from "@cloudinary/base/assets/CloudinaryImage";
import URLConfig from "@cloudinary/base/config/URLConfig";
import CloudConfig from "@cloudinary/base/config/CloudConfig";

const App = () => {

  // Set the Cloud configuration and URL configuration
  let cloudConfig = new CloudConfig({cloudName: 'demo'});
  let urlConfig = new URLConfig({secure: true});

  // Instantiate and configure a CloudinaryImage object.
  let myImage = new CloudinaryImage('sample', cloudConfig, urlConfig);

  // The URL of the image is: https://res.cloudinary.com/demo/image/upload/sample

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

Transformations

To transform a media asset, use the cloudinary-js-base library to create the transformation, then pass the transformed image or video object to the cldImg attribute in your AdvancedImage component to render the media on your site. For example:

Copy to clipboard
import React from 'react'
import {AdvancedImage} from '@cloudinary/react';
import {Cloudinary} from "@cloudinary/base";
import {Transformation} from "@cloudinary/base";

// Import required actions.
import {thumbnail} from "@cloudinary/base/actions/resize";
import {byRadius} from "@cloudinary/base/actions/roundCorners";

// Import required qualifiers.
import {face} from "@cloudinary/base/qualifiers/focusOn";
import {focusOn} from "@cloudinary/base/qualifiers/gravity";

const App = () => {

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

  // Use the image with public ID, 'front_face'.
  const myImage = cld.image('front_face');

  // Apply the transformation.
  myImage
  .resize(thumbnail().width(150).height(150).gravity(focusOn(face())))  // Crop the image, focusing on the face.
  .roundCorners(byRadius(20));    // Round the corners.

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

Here, the front_face image is cropped to a 150 x 150 pixel thumbnail with rounded corners, focusing on the face, resulting in this URL:

Transformed face

To find out more about transforming your assets using the cloudinary-js-base library, see:

Plugins

The Cloudinary React library provides plugins to render the media on your site in the most optimal way and improve your user's experience:

  • Lazy Loading to delay loading images if they are not yet visible on the screen.
  • Responsive images to resize your images automatically based on the viewport size.
  • Image accessibility to make your images more accessible to your users with visual disabilities.
  • Image placeholders to display a lightweight version of an image while the target image is downloading.

Both lazy loading and image placeholders are great techniques for helping to optimize your page load times and, in turn, improve your metrics related to Core Web Vitals.

In this example, the responsive and accessibility plugins are applied:

Copy to clipboard
import React from 'react'
import {Cloudinary} from "@cloudinary/base";

// Import plugins
import {AdvancedImage, lazyload, accessibility, responsive, placeholder} from '@cloudinary/react';

 const App = () => {

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

  // Use the image with public ID, 'sample'.
  const myImage = cld.image('sample');

  // Use the responsive and accessibility plugins
  return (
    <div>
      <AdvancedImage cldImg={myImage} plugins={[responsive(), accessibility()]}/>
    </div>
  )
};

Plugin order

We recommend the following order when using our plugins to achieve the best results (omitting any you don't need):

Copy to clipboard
plugins={[lazyload(), responsive(), accessibility(), placeholder()]}

Lazy loading

Lazy loading tells the browser not to download images that are not yet visible on the user's screen, and wait until the user scrolls to that image. This feature can potentially save bandwidth for images that are not actually viewed, and decrease the time needed to load a page.

This video shows lazy loading in action. See how the GET request is triggered only when the image is starting to come into the viewport:

To enable the lazy loading feature for a particular image, use the lazyload() plugin. This allows you to specify parameters that control when the image loads. For syntax details, see the reference.

Example: Set root margin and threshold

Load an image when 25% of it is visible. Specify a bounding box around the root element with margins, top: 10px, right: 20px, bottom: 10px, left: 30px:

Copy to clipboard
<AdvancedImage cldImg={myImage} plugins={[lazyload('10px 20px 10px 30px', 0.25)]}/>

Responsive images

You can make your images responsive, so that they automatically resize based on the viewport size. If the viewport is small, then a small image is requested, saving bytes and reducing page load times.

This video shows responsive image behavior in action. See how a new image is requested when the browser is resized, based on the configured step size:

To enable the responsive images feature for a particular image, use the responsive() plugin. You can either specify the step size or a set of image sizes. For syntax details, see the reference.

Example 1: Set step size

Set the step size to 200 pixels:

Copy to clipboard
<AdvancedImage cldImg={myImage} plugins={[responsive(200)]} />

Example 2: Specify a set of image sizes to use

Specify a set of image sizes (800, 1000 and 1400 pixels):

Copy to clipboard
<AdvancedImage cldImg={myImage} plugins={[responsive([800, 1000, 1400])]} />

Image accessibility

This feature makes an image more accessible to users by specifying one of the following modes:

Mode Transformation applied
monochrome Reduces the image to use only one color.
darkmode (default) Adds a dark tinting effect to the image.
brightmode Adds a bright tinting effect to the image.
colorblind Adds an effect to differentiate between colors that are similar.
Monochrome image monochrome Dark mode image darkmode Bright mode image brightmode Colorblind assisted image colorblind

To enable the accessibility feature for a particular image, use the accessibility() plugin. For syntax details, see the reference.

Example: Apply an accessibility transformation

Help color blind users by using the colorblind mode:

Copy to clipboard
<AdvancedImage cldImg={myImage} plugins={[accessibility('colorblind')]}/>

Image placeholders

An image placeholder is a lightweight version of a target image that can be downloaded quickly, and will occupy the same location as the intended target image, while the target image is still downloading. Once the target image download has been completed the placeholder is replaced with the final image. This feature is especially useful together with large images.

Placeholder images offer the following features:

  • The page loads quickly without blank locations.
  • No page content 'jumping' as the elements dynamically adjust to add downloaded images.

You can specify four different types of placeholder:

Placeholder type Transformation for the placeholder image
blur (default) A low quality, blurred version of the target image.
pixelate A low quality, pixelated version of the target image.
vectorize A low quality, vectorized version of the target image.
predominant A solid, single color image - the predominant color in the target image.

image placeholders

To add a placeholder for a particular image, use the placeholder() plugin. For syntax details, see the reference.

Example 1: Apply a placeholder transformation

Use a blurred placeholder image while waiting for the full quality image to download:

Copy to clipboard
<AdvancedImage cldImg={myImage} plugins={[placeholder('blur')]}/>

Example 2: Combine lazy loading with a placeholder

You can also combine placeholder images with the lazy loading feature. In this case, when the user scrolls to the image location, the placeholder image is downloaded followed by the target image.

For example, to use a solid, single-color placeholder image and the lazy loading feature:

Copy to clipboard
<AdvancedImage cldImg={myImage} plugins={[lazyload(), placeholder('predominant-color')]}/>

In this video you can see all the different placeholder types combined with lazy loading:

Sample projects

View these sample projects for complete code examples:

✔️ Feedback sent!

Rate this page: