🌅 React Uncached Image
React image component that bypasses caching using query param cache busting.
## Documentation
Read the **[official documentation](https://justinmahar.github.io/react-uncached-image/)**.
👁️ **[Live Demo](https://justinmahar.github.io/react-uncached-image/?path=/story/docs-uncachedimage--docs#example)**
## Overview
An [UncachedImage](https://justinmahar.github.io/react-uncached-image/?path=/story/docs-uncachedimage--docs) 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 save you time, please consider buying me a coffee, which powers my development (and life). Your support is much appreciated!
## Table of Contents
- [Documentation](#documentation)
- [Overview](#overview)
- [Features include:](#features-include)
- [Donate](#donate)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [TypeScript](#typescript)
- [Icon Attribution](#icon-attribution)
- [Contributing](#contributing)
- [⭐ Found It Helpful? Star It!](#-found-it-helpful-star-it)
- [License](#license)
## Installation
```
npm i react-uncached-image
```
## Quick Start
```jsx
import { UncachedImage } from "react-uncached-image";
```
Use just like you would a normal `img` tag in React:
```jsx
```
Now this image will be fetched from the server on every render.
See [UncachedImage](https://justinmahar.github.io/react-uncached-image/?path=/story/docs-uncachedimage--docs) for more information and a [live, interactive example](https://justinmahar.github.io/react-uncached-image/?path=/story/docs-uncachedimage--docs#example).
## TypeScript
Type definitions have been included for [TypeScript](https://www.typescriptlang.org/) support.
## Icon Attribution
Favicon by [Twemoji](https://github.com/twitter/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!](https://github.com/justinmahar/react-uncached-image/stargazers)
If you found this project helpful, let the community know by giving it a [star](https://github.com/justinmahar/react-uncached-image/stargazers): [👉⭐](https://github.com/justinmahar/react-uncached-image/stargazers)
Want to support the project? Feel free to grab me a coffee, which is my main source of fuel for development:
## License
See [LICENSE.md](https://justinmahar.github.io/react-uncached-image/?path=/docs/license--docs).