react-quick-image
v1.0.2
Published
A simple way to get relevant placeholder images from Unsplash.
Downloads
4
Maintainers
Readme
A React Component that gives you simple, relevant placeholder images
This package integrates with Unsplash and gives you a React Component that allows you to add tailored placeholder images anywhere in your project.
Instead of a random image or a grayed out block, you'll get a photo that not only corresponds with your use case, but is also sized perfectly for your needs.
It includes linting with ESLint and testing with Mocha, Enzyme and JSDOM.
Installation
While inside your project, you can install the package with NPM:
npm install --save react-quick-image
Or Yarn:
yarn add react-quick-image
Usage
- Import the QuickImage Component into your current file.
- Create a new instance of the component.
- Use the width and height props to define the size of the image. (Defaults to 800x600)
- Use the find prop to enter a keyword for your desired image. (Defaults to undefined)
- Open up your browser and enjoy a customized placeholder image.
Examples
import React from 'react';
import QuickImage from 'react-quick-image';
// Stateless Functional Component
const CoverPhoto = (props) => (
<div>
<QuickImage width="600" height="400" find="code" />
</div>
);
/* ES6 Class Components
When no values are passed to width and height, values default to 800 x 600.*/
class ProfilePicture extends React.Component {
constructor(props) {
super(props);
}
render() {
return (
<div>
<QuickImage find="cats" />
</div>
);
}
}
Live Example:
Planned Features
- [ ] Create functionality for customizing placeholder images (i.e. darken, blur, greyscale)
- [ ] Ability to easily move to permanent image sources in production, while retaining current functionality
License
MIT