0.0.5 • Published 7 years ago

react-background-image-loader v0.0.5

Weekly downloads
149
License
ISC
Repository
github
Last release
7 years ago

react-background-image-loader

Allows you display a placeholder image while the actual background image loads

Installation

npm install react-background-image-loader --save

In order to build / modify the component locally just run npm watch.

Usage

  import React from 'react';
  import BackgroundImage from 'react-background-image-loader';

  export default (props) => {
    const {source, ...otherProps} = props;
    const localImage = '/path/to/local/asset';

    return(
      <BackgroundImage src={source} placeholder={localImage} {...otherProps}>
        <div className="something-else">
          Some more markup
        </div>
        <SomeOtherReactComponent />
      </BackgroundImage>
    );
  }

Props

proptypenotes
srcstringRemote image to be loaded
placeholderstringLocal image to be immediately displayed

License

MIT License