Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c4ec6de
commit 96437f9
Showing
3 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
/src/** | ||
/node_modules/** | ||
/dev/** | ||
/.vscode | ||
.DS_Store | ||
.babelrc | ||
.eslintrc | ||
ts*.* | ||
/test/** | ||
/__mocks__/** | ||
!index.d.ts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2016 Ajai | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# React Pan & Zoom | ||
|
||
A simple pan and zoom for canvas like elements in react. | ||
|
||
A demo can be found here - [React Pan Zoom]() | ||
|
||
## Installation | ||
|
||
``` | ||
> yarn add react-pan-zoom | ||
``` | ||
|
||
## Usage | ||
|
||
```typescript | ||
import ReactPanZoom from "react-pan-zoom"; | ||
class MyComponent extends React.PureComponent { | ||
|
||
public render() { | ||
return ( | ||
<ReactPanZoom> | ||
<img src="some/src/for/image.png" /> | ||
</ReactPanZoom> | ||
); | ||
} | ||
} | ||
``` | ||
|
||
## Props | ||
|
||
- `zoom` : Provide zoom level for the cavnas'ish element. `1` by default | ||
- `dx` : Provide the initial x co-ordinate to pan the underlying element to be. `0` by default | ||
- `dy` : Provide the initial y co-ordinate to pan the underlying element to be. `0` by default | ||
|
||
For more information on what `dx` and `dy` mean please [refer here](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function/matrix) | ||
`(tx == dx and ty == dy)`. | ||
|