react-cloudimage-responsive

powered by Cloudimage (Watch the video here)

Cloudimage React Plugin

Cloudimage Responsive plugin will resize, compress and accelerate images across the World in your React application. It leverages the HTML5 element to deliver the right image size based on the client's screen size and pixel ratio (retina vs non-retina).

NOTE: Your original (master) images should be stored on a server or storage bucket (S3, Google Cloud, Azure Blob...) reachable over HTTP or HTTPS by Cloudimage. If you want to upload your master images to Cloudimage, contact us at [e-mail].

Demo

To see the Cloudimage Responsive plugin in action, please check out the Demo page. Play with your browser's viewport size and observe your Inspector's Network tab to see how Cloudimage delivers the optimal image size to your browser, hence accelerating the overall page loading time.

Installation

$ npm install --save react-cloudimage-responsive

Simple Usage

import React from 'react';
import { render } from 'react-dom';
import Img, { CloudimageProvider } from 'react-cloudimage-responsive';

const cloudimageConfig = {
  token: 'demo',
  baseUrl: 'https://jolipage.airstore.io/'
};

const App = () => {
  return (
    <CloudimageProvider config={cloudimageConfig}>
      <h1>Simple demo of react-cloudimage-responsive</h1>
      <Img src="img.jpg" alt="Demo image" ratio={1.5}/>
    </CloudimageProvider>
  );
};

render(<App />, document.body);

Requirements

To use the Cloudimage Responsive plugin, you will need a Cloudimage token. Don't worry, it only takes seconds to get one by registering here. Once your token is created, you can configure it as described below. This token allows you to use 25GB of image cache and 25GB of worldwide CDN traffic per month for free.

Config

token

Type: String | Default: "demo" | required

Your Cloudimage customer token. Subscribe for a Cloudimage account to get one. The subscription takes less than a minute and is totally free

lazyLoading

Type: Bool | Default: true

Only load images close to the viewport

imgLoadingAnimation

Type: Bool | Default: true

Nice effect for preview transition

lazyLoadOffset

Type: Number | Default: 100

Preload an image even if it's e.g. 100px below the viewport (user have to scroll 100px more to see this image)

filters

Type: String | Default: 'n'

Parameters like fcontrast, fpixelate, fgaussian, backtransparent, rotation to apply filters on your images by default

placeholderBackground

Type: String | Default: '#f4f4f4'

Parameters like fcontrast, fpixelate, fgaussian, backtransparent, rotation to apply filters on your image by default

baseUrl

Type: String | Default: "/"

Your image folder on server.

Image properties

src

Type: String | Default: undefined

Original image hosted on your web server.

ratio

Type: Number | Default: none

When lazyLoading: true, it is recommended to set ratio of an image to prevent page layout jumping and to leverage visibility checking and thus lazy loading.

operation / o

see doc

Type: String | Default: width

width - to resize with a specific width

height - to resize with a specific height

crop - to crop the image at the center

fit - to resize the image in a box and keeping the proportions of the source image

cover - to resize the image in a box without keeping the proportions of the source image

size / s

Type: String/Object | Default: undefined

Size of an image which is used as a base for creating retina ready and responsive image element.

Examples (PR - stands for your device Pixel Ratio):

[width]: s="250" => width: 250 * PR (px); height: auto;

[width x height]: s="125x200" => width: 125 * PR (px); height: 200 * PR (px);

[Width and height for different screen resolutions]:

s={{ xs: '50x100', sm:'100x125', md: '150x150', lg:'200x175', xl:'300x200' }}

*You can drop some breakpoints, for example s={{ sm:'100x125', xl:'300x200' }}

NOTE: if size is not set (undefined), it's going to use special algorithm to detect the width of image container and set the image size accordingly.

filters / f

see doc

Type: String | Default: none

Filters allow you to modify the image's apperance and can be added on top of the resizing features above.

fgrey - apply a greyscale filter on the image

fgaussian[0..10] - apply a gaussian blur filter on the image

fcontrast[-100..100] - apply a contrast filter on the image

fbright[0..255] - apply a brightness filter on the image

fpixelate[0..100] - apply a pixelate filter on the image

fradius[0..500] - create a radius on the corners

---

To see the full cloudimage documentation click here

Changelog

1.1.1 - 2020-04-16

Added

• separate build without polyfills to support Gatsby