README.md

React Image Webp

Features

• Rendering image in WebP format if browser supports.
• Server-side rendering using React Context
• Written on Typescript

Note: as of January, 2019 only 72.59% supports WebP format (caniuse.com)

Installation

Using npm:

npm i react-img-webp

Usage

For runtime webp checking:

import { Image, canUseWebP } from "react-img-webp";

const jpg = "https://cdn.horatius.pro/image.jpg";
const webP = "https://cdn.horatius.pro/image.webp";

export const Component = (
    <Image src={jpg} webP={webP} />
);

const isBrowserSupportWebP = canUseWebP(); // if you want to detect webP support in other places

Server-side rendering

Library supports rendering webP on server-side. All you need to pass Accept header value to context controller.

import { Context } from "react-img-webp";

// it may be any http request
const request = {
    headers: {
        Accept: "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8"
    }
}

const jpg = "https://cdn.horatius.pro/image.jpg";
const webP = "https://cdn.horatius.pro/image.webp";

export const Component = () => {
    return (
        <Context.WebPController accept={request.headers.Accept}>
            <Context.Image src={jpg} webP={webP} />
        </Context.WebPController>
    )
}

For inline styles (background-image etc.)

You may use context manually to render any element instead of <img>:

import * as React from "react";
import { Context } from "react-img-webp";

const img = {
    src: require("icon.png"),
    webP: require("icon.webp"),
};

export const Icon: React.FunctionComponent = () => (
    <Context.WebP.Consumer>
        {(value) =>
            <i
                className="icon"
                style={{
                    backgroundImage: `url(${value.supportWebP ? img.webP : img.src})`,
                }}
            />
        }
    </Context.WebP.Consumer>
);

Contributors

• Alexander Letnikow

License

MIT