Giter VIP home page Giter VIP logo

react-preload's Introduction

React Preload

npm version

A React component to preload images. It renders a passed component during the loader phase, and renders it's children once the images have been successfully fetched.

Installation

npm

npm install react-preload --save

Usage

var Preload = require('react-preload').Preload;
var loadingIndicator = (<div>Loading...</div>)
var images = [];

<Preload
  loadingIndicator={loadingIndicator}
  images={images}
  autoResolveDelay={3000}
  onError={this._handleImageLoadError}
  onSuccess={this._handleImageLoadSuccess}
  resolveOnError={true}
  mountChildren={true}
  >
	{/* content to be rendered once loading is complete*/}
</Preload>

Prop types

   propTypes: {
		//Rendered on success
		children: React.PropTypes.node.isRequired,

		//Rendered during load
		loadingIndicator: React.PropTypes.node.isRequired,

		//Array of image urls to be preloaded
		images: React.PropTypes.array,

		//If set, the preloader will automatically show
		//the children content after this amount of time
		autoResolveDelay: React.PropTypes.number,

		//Error callback. Is passed the error
		onError: React.PropTypes.func,

		//Success callback
		onSuccess: React.PropTypes.func,

		//Whether or not we should still show the content
		//even if there is a preloading error
		resolveOnError: React.PropTypes.bool

        //Whether or not we should mount the child content after
        //images have finished loading (or after autoResolveDelay)
        mountChildren: React.PropTypes.bool
    }

Additional Details

This module also exposes ImageCache and ImageHelper which can be used to preload images directly, and can be accessed via require('react-preload').ImageCache and require('react-preload').ImageHelper respectively.

License

MIT

react-preload's People

Contributors

sambernard avatar sumeetr avatar claus avatar anhulife avatar

Stargazers

Roman O avatar  avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.