Skip to content

Latest commit

 

History

History
138 lines (98 loc) · 5.26 KB

README.md

File metadata and controls

138 lines (98 loc) · 5.26 KB
Raw

react-native-gallery-swiper

An easy and simple to use React Native component to render an image gallery with common gestures like pan, pinch and double tap. Supporting both iOS and Android.

react-native-gallery-swiper

Learn more about React Native with project examples along with Cyber Security and Ethical Hacking at LH BLOG.

Index

Improved and changed on top of react-native-image-gallery.

Install

Type in the following to the command line to install the dependency.

$ npm install --save react-native-gallery-swiper

or

$ yarn add react-native-gallery-swiper

Usage Example

Add an import to the top of the file. At minimal, declare the GallerySwiper component in the render() method providing an array of data for the images prop.

import GallerySwiper from "react-native-gallery-swiper";

//...
render() {
    return (
        <GallerySwiper
            style={{ flex: 1, backgroundColor: "black" }}
            images={[
                { source: require("yourApp/image.png"), dimensions: { width: 1080, height: 1920 } },
                { uri: "https://luehangs.site/pic-chat-app-images/animals-avian-beach-760984.jpg",
                    dimensions: { width: 1080, height: 1920 } },
                { uri: "https://luehangs.site/pic-chat-app-images/beautiful-blond-blonde-hair-478544.jpg"},
                { uri: "https://luehangs.site/pic-chat-app-images/beautiful-beautiful-women-beauty-40901.jpg"},
                { uri: "https://luehangs.site/pic-chat-app-images/beautiful-blond-fishnet-stockings-48134.jpg"},
                { uri: "https://luehangs.site/pic-chat-app-images/beautiful-beautiful-woman-beauty-9763.jpg"},
                { uri: "https://luehangs.site/pic-chat-app-images/attractive-balance-beautiful-186263.jpg"},
            ]}
        />
    );
}
//...

API

<GallerySwiper /> component accepts the following props...

Props

Props Description Type Default
images An array of objects. uri or source is a required field. EX. [{ source: require("yourApp/image.png"), dimensions: { width: 1080, height: 1920 } }, { uri: "https://luehangs.site/pic-chat-app-images/animals-avian-beach-760984.jpg", dimensions: { width: 1080, height: 1920 } }, { uri: "https://luehangs.site/pic-chat-app-images/beautiful-blond-blonde-hair-478544.jpg"}] Array Required
initialPage Index of image to be displayed first. number 0
imageComponent Custom function to render your images. 1st param is the image props and 2nd is its dimensions. Function <Image/> component
errorComponent Custom function to render the page of an image that couldn't be displayed. Function A <View/> with a stylized error
flatListProps Props to be passed to the underlying FlatList. object {windowSize: 3}
pageMargin Blank margin space to show between images. number 0
onPageSelected Fired with the index of page that has been selected. Function
onPageScrollStateChanged Called when page scrolling state has changed, see scroll state and events. Function
onPageScroll Scroll event, see scroll state and events. Function
scrollViewStyle Custom style for the FlatList component. Object {}
onSingleTapConfirmed Executed after a single tap. Function
onLongPress Executed after a long press. Function

Scroll state and events

  • onPageScroll : (event) => {}.

    The event object carries following data:

    • position: index of first page from the left that is currently visible.
    • offset: value from range [0,1) describing stage between page transitions.
    • fraction: means that (1 - x) fraction of the page at "position" index is visible, and x fraction of the next page is visible.

  • onPageScrollStateChanged : (state) => {}.

    Called when the page scrolling state has changed. The page scrolling state can be in 3 states:

    • 'idle': there is no interaction with the page scroller happening at the time.
    • 'dragging': there is currently an interaction with the page scroller.
    • 'settling': there was an interaction with the page scroller, and the page scroller is now finishing its closing or opening animation.

Example Project

Perform steps 1-2 to run locally:

  1. Clone the Repo
  2. Install and Run

1. Clone the Repo

Clone react-native-gallery-swiper locally. In a terminal, run:

$ git clone https://github.com/Luehang/react-native-gallery-swiper.git react-native-gallery-swiper

2. Install and Run

$ cd react-native-gallery-swiper/example/

iOS - Mac - Install & Run

1. check out the code
2. npm install
3. npm run ios

Android - Mac - Install & Run

1. check out the code
2. npm install
3. emulator running in separate terminal
4. npm run android

License

MIT licensed, as found in the LICENSE file.