Skip to content

Commit efdc8b9

Browse files
committed
Add type to propTypes, update readme
1 parent a1b4b34 commit efdc8b9

File tree

8 files changed

+20
-6
lines changed

8 files changed

+20
-6
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Compares images, inspired by Github's [image diff view modes](https://github.com/blog/817-behold-image-view-modes).
44

5+
![](public/img/demo-fade.gif)
6+
![](public/img/demo-swipe.gif)
7+
58
## Installation
69

710
```
@@ -12,7 +15,7 @@ npm install react-image-diff
1215

1316
http://cezary.github.io/react-image-diff/
1417

15-
## Example
18+
## Usage
1619

1720
```javascript
1821
import React from 'react';
@@ -27,6 +30,15 @@ class Component extends React.Component {
2730
}
2831
```
2932

33+
### Props
34+
35+
* after: string - url to after image
36+
* before: string - url to before image
37+
* height: number - height in pixels
38+
* width: number - width in pixels
39+
* type: string - type of image comparison (difference, fade, or swipe)
40+
* value: number - decimal fraction used to compute transition between before and after images
41+
3042
## License
3143

3244
MIT

dist/react-image-diff.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ return /******/ (function(modules) { // webpackBootstrap
8787
after: _react2['default'].PropTypes.string.isRequired,
8888
before: _react2['default'].PropTypes.string.isRequired,
8989
height: _react2['default'].PropTypes.number,
90+
type: _react2['default'].PropTypes.string.isRequired,
9091
value: _react2['default'].PropTypes.number,
9192
width: _react2['default'].PropTypes.number
9293
},

index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,16 +115,16 @@ <h1>react-image-diff</h1>
115115
/>
116116
<br/>
117117
<label>
118-
<input name='type' type='radio' value='difference' onChange={this.handleRadioChange} />
119-
difference
118+
<input name='type' type='radio' value='swipe' onChange={this.handleRadioChange} />
119+
swipe
120120
</label>
121121
<label>
122122
<input name='type' type='radio' value='fade' onChange={this.handleRadioChange} defaultChecked />
123123
fade
124124
</label>
125125
<label>
126-
<input name='type' type='radio' value='swipe' onChange={this.handleRadioChange} />
127-
swipe
126+
<input name='type' type='radio' value='difference' onChange={this.handleRadioChange} />
127+
difference
128128
</label>
129129
</div>
130130
);

lib/bg.png

-962 Bytes
Binary file not shown.

lib/react-image-diff.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ export default class ImageDiff extends Component {
88
after: React.PropTypes.string.isRequired,
99
before: React.PropTypes.string.isRequired,
1010
height: React.PropTypes.number,
11+
type: React.PropTypes.string.isRequired,
1112
value: React.PropTypes.number,
1213
width: React.PropTypes.number
1314
};

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-image-diff",
3-
"version": "0.0.3",
3+
"version": "0.0.4",
44
"description": "Highlight differences between images",
55
"main": "dist/react-image-diff.js",
66
"scripts": {

public/img/demo-fade.gif

621 KB
Loading

public/img/demo-swipe.gif

155 KB
Loading

0 commit comments

Comments
 (0)