1.0.5 • Published 7 years ago
react-image-overlay v1.0.5
Warning, WIP.
Please do not use this package in production, yet. Breaking changes are on its way.
react-image-overlay
Overlay images with watermarks or additional layer with transparency (i.e.
.png). Image orientation on iOS devices is auto-corrected.
Install
With npm:
npm install --save react-image-overlayWith yarn:
yarn add react-image-overlayTo do
- styling props for image and overlay
Usage
import React, { Component } from 'react'
import Overlay from 'react-image-overlay'
class Foo extends Component {
render () {
return (
<Overlay
url='https://placeimg.com/250/250/any' // required
overlayUrl='https://placeimg.com/50/50/any' // required
imageHeight={100}
position={'bottomRight'}
overlayWidth={50}
overlayHeight={50}
overlayPadding={10}
watermark={false}
/>
);
}
};Prop-types
| prop | type | |
|---|---|---|
| url | string | required |
| overlayUrl | string | required |
| imageHeight | number | optional |
| imageWidth | number | optional |
| overlayHeight | number | optional |
| overlayWidth | number | optional |
| position | number | possible values: 'bottomLeft', 'center', 'bottomRight', 'topLeft', 'topRight' |
| overlayPadding | number | the amount of padding for the overlay, calculated from the edge of the main image |
| watermark | true/false | use this option if you want the overlay to be applied as a watermark |
Important Note: Enabling watermark renders the image and overlay to a single canvas, preventing site users from downloading images separately.
License
MIT © saintograph