⏳ React Timed Renderer
React component that re-renders at the interval provided.
## Documentation
Read the **[official documentation](https://justinmahar.github.io/react-timed-renderer/)**.
[](https://justinmahar.github.io/react-timed-renderer/?path=/story/docs-timedrenderer--docs#example)
👁️ **[Live Demo](https://justinmahar.github.io/react-timed-renderer/?path=/story/docs-timedrenderer--docs#example)**
## 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 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-renderer
```
## Quick Start
```jsx
import { TimedRenderer } from "react-timed-renderer";
```
```jsx
Rendered at: {time}
}
/>
```
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](https://justinmahar.github.io/react-timed-renderer/?path=/story/docs-timedrenderer--docs#example) for an example using CSS transitions.
## 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-renderer/stargazers)
If you found this project helpful, let the community know by giving it a [star](https://github.com/justinmahar/react-timed-renderer/stargazers): [👉⭐](https://github.com/justinmahar/react-timed-renderer/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-renderer/?path=/docs/license--docs).