🎆 React Timed Image
React image component that re-renders at timed intervals. Includes optional cache busting.
## Documentation
Read the **[official documentation](https://justinmahar.github.io/react-timed-image/)**.
[](https://justinmahar.github.io/react-timed-image/?path=/story/components-timedimage--docs#usage)
👁️ **[Live Demo](https://justinmahar.github.io/react-timed-image/?path=/story/components-timedimage--docs#usage)**
## Overview
A TimedImage repeatedly renders an image at a timed interval.
Features optional client-side cache busting so the image reloads on every render.
### Features include:
- **⏱️ Render at timed intervals**
- Re-render your image at the interval you specify.
- **🐣 New image every time using cache-busting**
- Uses client-side cache-busting to prevent old, cached images from being shown.
- **🖼️ Use just like an `img`**
- Use all the props an `img` supports, like `src` and `alt`.
## 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-timed-image
```
## Quick Start
```jsx
import { TimedImage } from "react-timed-image";
```
```jsx
```
This will render the image at the `src` provided every three seconds.
See [TimedImage](https://justinmahar.github.io/react-timed-image/?path=/story/components-timedimage--docs) for additional options and a live 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-timed-image/stargazers)
If you found this project helpful, let the community know by giving it a [star](https://github.com/justinmahar/react-timed-image/stargazers): [👉⭐](https://github.com/justinmahar/react-timed-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-timed-image/?path=/docs/license--docs).