react-timed-image
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

🎆 React Timed Image

React image component that re-renders at timed intervals. Includes optional cache busting.

npm Version  View project on GitHub  Deploy Status  Sponsor

Documentation

Read the official documentation.

Demo

👁️ 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, like src and alt.

Donate

I hope this project makes your life a little easier! If it does and you'd like to show your appreciation, consider supporting the project with a coffee or sponsorship.

Your support helps keep the project going and will earn you some serious virtual high fives. Maybe even a virtual fist bump if you're feeling extra cool.

Sponsor via GitHub Buy me a coffee Buy me 3 coffees Buy me 5 coffees

Table of Contents

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.

Package Sidebar

Install

npm i react-timed-image

Weekly Downloads

29

Version

1.1.1

License

MIT

Unpacked Size

191 kB

Total Files

24

Last publish

Collaborators

  • justinmahar