Documentation

Read the official documentation.

👁️ Live Demo

Overview

A component that re-renders at regular intervals.

Just provide the interval in milliseconds and a render prop.

Features include:

• 🙌 Simple and easy
  • Render components at timed intervals with ease.
• 🎯 Straightforward
  • Dead simple and straightforward timed component.
• 🧰 Versatile
  • A useful tool to have in your React toolkit.

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
  • Features include:
• Donate
• Table of Contents
• Installation
• Quick Start
• TypeScript
• Icon Attribution
• Contributing
• ⭐ Found It Helpful? Star It!
• License

Installation

npm i react-timed-renderer

Quick Start

import { TimedRenderer } from "react-timed-renderer";

<TimedRenderer
  interval={1000}
  render={(time) => <div>Rendered at: {time}</div>}
/>

Provide an interval in milliseconds and a render prop.

The render prop receives a single argument, which is the time (in Unix milliseconds) at which the render occurred, in case that's useful to you.

See the demo for an example using CSS transitions.

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.