react-fancy-image/README.md
2018-05-30 22:02:19 -06:00

36 lines
859 B
Markdown

# Introduction
> This module extends **React Js**
This FancyImage React component creates an animation on image change and can be used as nice and material headline design with image.
# Installation
`npm install --save react-fancy-image`
# Usage
Add following line at the beginning of your document:
`import ReactFancyImage from 'react-fancy-image'`
Use the ReactFancyImage component:
```jsx
<ReactFancyImage img={require(imgUrl)} headlineA="" headlineB="" />
//The image is displayed 'absolute'.
//To embed it into your website it is recommended to use a parent div
//to be able to move and style the image. Like so:
<div style={{position: 'relative'}}>
<ReactFancyImage img={require(imgUrl)} headlineA="" headlineB="" />
</div>
```
# Contact
**Github:** https://github.com/aleabodo
**Wesite:** https://alexbell.de
**Email:** mail@alexbell.de