Skip to content

justinmahar/react-uncached-image

Repository files navigation

πŸŒ… React Uncached Image

React image component that bypasses caching using query param cache busting.

npm VersionΒ  View project on GitHubΒ  Deploy Status

Buy me a coffeeΒ Sponsor

Documentation

Read the official documentation.

πŸ‘οΈ Live Demo

Overview

An UncachedImage adds a cache-busting query param to your image src to ensure the browser requests the image from the server on every render.

Features include:

  • 🐣 Fresh image every time
    • Ensure the image is fetched from the server on every render.
  • πŸ–ΌοΈ Renders as an img
    • Use all the props an img supports, like src and alt.
  • πŸ”€ Custom cache buster option
    • Provide your own cache buster if you'd like.

Donate

If this project helped you, please consider buying me a coffee or sponsoring me. Your support is much appreciated!

Buy me a coffeeΒ Sponsor

Table of Contents

Installation

npm i react-uncached-image

Quick Start

import { UncachedImage } from "react-uncached-image";

Use just like you would a normal img tag in React:

<UncachedImage src="https://loremflickr.com/320/240" />

Now this image will be fetched from the server on every render.

See UncachedImage for more information and a live, interactive example.

TypeScript

Type definitions have been included for TypeScript support.

Icon Attribution

Favicon by Twemoji.

Contributing

Open source software is awesome and so are you. 😎

Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.

For major changes, open an issue first to discuss what you'd like to change.

⭐ Found It Helpful? Star It!

If you found this project helpful, let the community know by giving it a star: πŸ‘‰β­

License

See LICENSE.md.

About

πŸŒ… React image component that bypasses caching using query param cache busting.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published