Skip to content

eberhara/react-interval-renderer

Repository files navigation

react-interval-renderer

build status Coverage Status NPM version

React component that renders its children every x milliseconds

This is a react component that renders its children every x milliseconds! Please take a look at its props:

  • interval: Milliseconds to rerender (default 1000)
  • shouldComponentRerender: Callback function to return a boolean value (optional)
  • componentDidRerender: Callback function after the component finished each render (optional)

Besides thos props, it also expects valid React elements as its children. See it working at eberhara.github.io/react-interval-renderer.

Installation

npm i --save react-interval-renderer

Usage

import IntervalRenderer from 'react-interval-renderer';

...

render() {
	return (
		<IntervalRenderer
			interval={100}						
			shouldComponentRerender={() => true}
			componentDidRerender={() => ()}
		>
			// ... here goes your children components
		</IntervalRenderer>
	);
}

Take a look at examples folder for a complete example.

License

MIT License

Copyright (c) 2017 Andre Eberhardt

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Rendering react components every x milliseconds

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published