Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ascoders/react-native-image-viewer
🚀 tiny & fast lib for react native image viewer pan and zoom
https://github.com/ascoders/react-native-image-viewer
image-viewer react-component react-native
Last synced: 16 days ago
JSON representation
🚀 tiny & fast lib for react native image viewer pan and zoom
- Host: GitHub
- URL: https://github.com/ascoders/react-native-image-viewer
- Owner: ascoders
- License: mit
- Archived: true
- Created: 2016-09-13T13:43:44.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-09-20T21:30:31.000Z (almost 3 years ago)
- Last Synced: 2024-06-07T09:13:17.407Z (25 days ago)
- Topics: image-viewer, react-component, react-native
- Language: TypeScript
- Homepage:
- Size: 2.38 MB
- Stars: 2,437
- Watchers: 23
- Forks: 576
- Open Issues: 195
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-react-native - react-native-image-viewer - 🚀 tiny & fast lib for react native image viewer pan and zoom.  (Components / Viewer/Swiper/Carousel)
- awesome-react-native - react-native-image-zoom-viewer
- awesome-stars-coconut - ascoders/react-native-image-viewer - 🚀 tiny & fast lib for react native image viewer pan and zoom (TypeScript)
README
## Show Cases
**Swiper image**
**Zoom while sliding**
**Swipe down**
## Getting Started
### Installation
```bash
npm i react-native-image-zoom-viewer --save
```
### Basic Usage
- Install create-react-native-app first
```bash
$ npm install -g create-react-native-app
```
- Initialization of a react-native project
```bash
$ create-react-native-app AwesomeProject
```
- Then, edit `AwesomeProject/App.js`, like this:
```typescript
import { Modal } from 'react-native';
import ImageViewer from 'react-native-image-zoom-viewer';
const images = [{
// Simplest usage.
url: 'https://avatars2.githubusercontent.com/u/7970947?v=3&s=460',
// width: number
// height: number
// Optional, if you know the image size, you can set the optimization performance
// You can pass props to .
props: {
// headers: ...
}
}, {
url: '',
props: {
// Or you can set source directory.
source: require('../background.png')
}
}]
export default class App extends React.Component {
render: function() {
return (
)
}
}
```
### Props
| parameter | type | required | description | default |
| :--------------------- | :------------------------------------------------------------------------------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------- |
| imageUrls | array | yes | Image Source | |
| enableImageZoom | boolean | no | Enable image zoom | `true` |
| onShowModal | function
`(content?: JSX.Element) => void` | no | The callback for show modal | `() => {}` |
| onCancel | function
`() => void` | no | The callback for cancel modal | `() => {}` |
| flipThreshold | number | no | Swipe threshold of the next page | `80` |
| maxOverflow | number | no | The X position maximum, that current page can slide to the next page | `300` |
| index | number | no | Init index of images | `0` |
| failImageSource | string, object
`{url: string}` | no | placeholder for fail | `''` |
| loadingRender | function
`() => React.ReactElement` | no | placeholder for loading | `() => null` |
| onSaveToCamera | function
`(index?: number => void` | no | The callback for save to camera | `() => {}` |
| onChange | function
`(index?: number => void` | no | When the image changed | `() => {}` |
| onMove | ( position: [IOnMove](https://github.com/ascoders/react-native-image-zoom/blob/master/src/image-zoom/image-zoom.type.ts) )=>void | reports movement position data (helpful to build overlays) | ()=> {} |
| saveToLocalByLongPress | boolean | no | Enable save to camera when long press | `true` |
| onClick | function
`(onCancel?: function) => void` | no | Onclick | `(onCancel) => {onCancel()}` |
| onDoubleClick | function
`(onCancel?: function) => void` | no | OnDoubleClick | `(onCancel) => {onCancel()}` |
| onSave | function
`(url: string) => void` | no | The picture is saved to the local method, if you write this method will not call the system default method for Android does not support saveToCameraRoll remote picture, you can call this callback in Android call native interface | |
| renderHeader | function
`(currentIndex?: number) => React.ReactElement` | no | Custom header | `() => null` |
| renderFooter | function
`(currentIndex?: number) => React.ReactElement` | no | Custom footer | `() => null` |
| renderIndicator | function
`(currentIndex?: number, allSize?) => React.ReactElement`: number | no | Custom indicator | `(currentIndex, allSize) => currentIndex + "/" + allSize` |
| renderImage | function
`(props: any) => React.ReactElement` | no | Custom image component | `(props) => ` |
| renderArrowLeft | function
`() => React.ReactElement` | no | Custom left arrow | `() => null` |
| renderArrowRight | function
`() => React.ReactElement` | no | Custom right arrow | `() => null` |
| onSwipeDown | function
`() => void` | no | Callback for swipe down | `() => null` |
| footerContainerStyle | object
`{someStyle: someValue}` | no | custom style props for container that will be holding your footer that you pass | `bottom: 0, position: "absolute", zIndex: 9999` |
| backgroundColor | string
`white` | no | Component background color | `black` |
| enableSwipeDown | boolean | no | Enable swipe down to close image viewer. When swipe down, will trigger onCancel. | `false` |
| swipeDownThreshold | number | no | Threshold for firing swipe down function | |
| doubleClickInterval | number | no | Double click interval. | |
| pageAnimateTime | number | no | Set the animation time for page flipping. | `100` |
| enablePreload | boolean | no | Preload the next image | `false` |
| useNativeDriver | boolean | no | Whether to animate using [`useNativeDriver`](https://reactnative.dev/docs/animations#using-the-native-driver) | `false` |
| menus | function
`({cancel,saveToLocal}) => React.ReactElement` | no | Custom menus, with 2 methods:`cancel` to hide menus and `saveToLocal` to save image to camera
| menuContext | object
`{someKey: someValue}` | no | Custom menu context. | `{ saveToLocal: 'save to the album', cancel: 'cancel' }`
## Development pattern
### Step 1, run TS listener
After clone this repo, then:
```bash
npm install
npm start
```
### Step 2, run demo
```bash
cd demo
npm install
npm start
```
Then, scan the QR, use your [expo app](https://expo.io./).
### Dependence
Depend on `react-native-image-pan-zoom`: https://github.com/ascoders/react-native-image-zoom