react-timed-image
v1.2.5
Published
React image component that re-renders at timed intervals. Includes optional cache busting.
Downloads
263
Maintainers
Readme
Documentation
Read the official documentation.
👁️ Live Demo
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, likesrc
andalt
.
- Use all the props an
Donate
If this project helped you, please consider buying me a coffee or sponsoring me. Your support is much appreciated!
Table of Contents
- Documentation
- Overview
- Donate
- Table of Contents
- Installation
- Quick Start
- TypeScript
- Icon Attribution
- Contributing
- ⭐ Found It Helpful? Star It!
- License
Installation
npm i react-timed-image
Quick Start
import { TimedImage } from "react-timed-image";
<TimedImage src="https://loremflickr.com/220/140" interval={3000} />
This will render the image at the src
provided every three seconds.
See TimedImage for additional options and a live 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.