react-imgr-development
v1.1.2-alpha.0
Published
react-imgr is an <img> tag replacement for react
Maintainers
Readme
react-imgr
Progressive Image component for React.
TODO
[] remove deprecated lifecycle methods
Installation
// with npm with react-compounds
$ npm install @react-compounds/dropdown --save
// with yarn with react-compounds
$ yarn add @react-compounds/dropdown
// with npm
$ npm install react-imgr --save
// with yarn
$ yarn add react-imgrUsage
This is the basic usage of react-dropdown
import Image from 'react-imgr';
<Image
src='image.jpg'
preloadSrc='preloadimage.jpg'
containerStyle={{
width: '100%',
height: 280
}}
initialBlur
alt='alt tag added here'
scale
placeholder='placeholder.jpg'
/>Props
| Name | Type | Required | Description |
| -------------- | --------- | -------- | -------------------------------- |
| src | string | true | the src of image |
| preloadSrc | string | false | the src image preload src |
| containerStyle | object | false | container css styles |
| initialBlur | boolean | true | the src initial state |
| alt | string | true | the src alt tag |
| scale | boolean | false | scale the src image |
| placeholder | string | true | the src of the placeholder image |
TODO
- [x] Production Level
- [ ] CSS Polishing and Transitions
- [ ] Documentation
Run example
$ npm startLicense
Apache 2.0
