An easy and simple to use React Native component to render a custom masonry layout for remote/local images and displayed on a custom interactive image viewer. Includes animations and support for both iOS and Android. Free and made possible along with costly maintenance and updates by Lue Hang (the author).

Check out the docs for a complete documentation.

• Supports large lists rendering.
• Efficiently add more images without re-rendering.
• Smart algorithm for eveningly laying out images.
• Swipe up and down to close images.
• Can be use with many fieldnames. source, source.uri, uri, URI, url or URL.
• Support for rendering all local and remote images with no missing images.
• Support for dynamic device rotation.
• Includes guestures and important event listeners for pan, pinch, single tap and double tap.
• Includes zoom mode.
• Pull to Refresh.
• Scroll loading.
• Easily customizable.
• Intelligent scroll detection to cushion rough swipe guestures.
• Supports iOS and Android.

:information_source: Learn more about React Native with project examples along with Cyber Security and Ethical Hacking at LueHsoft.

Built with react-native-gallery-swiper & react-native-smart-gallery.

:open_file_folder: Index

1. Install

2. Usage Example

3. API

4. :books: Props

5. Example Project

6. Author

7. Contribute

8. License

:gem: Install

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

$ npm install --save react-native-image-layout

or

$ yarn add react-native-image-layout

:tada: Usage Example

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

If you like react-native-image-layout, please be sure to give it a star at GitHub. Thanks.

import ImageLayout from "react-native-image-layout";

//...
render() {
    return (
        <ImageLayout
            images={[
                // Version *3.0.0 update (or greater versions): 
                // Can be used with different image object fieldnames.
                // Ex. source, source.uri, uri, URI, url, URL
                { uri: "https://luehangs.site/pic-chat-app-images/beautiful-blond-blonde-hair-478544.jpg" },
                // IMPORTANT: It is REQUIRED for LOCAL IMAGES
                // to include a dimensions field with the
                // actual width and height of the image or
                // it will throw an error.
                // { source: require("yourApp/image.png"),
                //     dimensions: { width: 1080, height: 1920 }
                // },
                // "width" & "height" is an alternative to the dimensions
                // field that will also be acceptable.
                // { source: require("yourApp/image.png"),
                //     width: 1080,
                //     height: 1920 },
                { source: { uri: "https://luehangs.site/pic-chat-app-images/beautiful-beautiful-women-beauty-40901.jpg" } },
                { uri: "https://luehangs.site/pic-chat-app-images/animals-avian-beach-760984.jpg",
                    // Optional: Adding a dimensions field with
                    // the actual width and height for REMOTE IMAGES
                    // will help improve performance.
                    dimensions: { width: 1080, height: 1920 } },
                { URI: "https://luehangs.site/pic-chat-app-images/beautiful-blond-fishnet-stockings-48134.jpg",
                    // Version *2.0.0 update (or greater versions):
                    // Optional: Does not require an id for each
                    // image object, but is for best practices and
                    // can be better for performance with the API.
                    id: "blpccx4cn" },
                { url: "https://luehangs.site/pic-chat-app-images/beautiful-beautiful-woman-beauty-9763.jpg" },
                { URL: "https://luehangs.site/pic-chat-app-images/attractive-balance-beautiful-186263.jpg" },
            ]}
            // Version *5.7.0 update
            // onEndReached={() => {
            //     // add more images when scroll reaches end
            // }}
        />
    );
}
//...

Android Note: Remote debugger should be turned off on Android.

:tada: Efficiently Add More Images

Version *5.2.0 update: Without rerendering the images.

import ImageLayout from "react-native-image-layout";

//...
/**
 * Example method to add more images.
 *
 * @method addMoreImages
 */
addMoreImages(newImages) {
    this.setState({
        images: this.state.images.concat(newImages)
    });
}

render() {
    return (
        <ImageLayout
            images={this.state.images}
            {/* Version *5.7.0 update */}
            onEndReached={() => {
                this.addMoreImages(moreImages);
            }}
        />
    );
}
//...

:tada: Add New Images

Version *5.2.0 update: Rerendering the images.

import ImageLayout from "react-native-image-layout";

//...
/**
 * Example method to add new images.
 *
 * @method addNewImages
 * @config Set react-native-image-layout's "rerender" prop to true.
 */
addNewImages(newImages) {
    this.setState({
        images: newImages
    });
}

render() {
    return (
        <ImageLayout
            rerender={true}
            images={this.state.images}
        />
    );
}
//...

:nut_and_bolt: API

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

:books: Props

:information_source: *Version 2.0.0 update (or greater versions): Props changes that may not be compatible with lower versions.

:small_blue_diamond: Image Layout Props of <ImageLayout />

If you like react-native-image-layout, please be sure to give it a star at GitHub. Thanks.

:small_blue_diamond: Gallery Props of <ImageLayout />

If you like react-native-image-layout, please be sure to give it a star at GitHub. Thanks.

:clapper: Example Project

Perform steps 1-2 to run locally:

$ git clone https://github.com/Luehang/react-native-image-layout.git react-native-image-layout

$ cd react-native-image-layout/example/

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

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

:santa: Author

Free and made possible along with costly maintenance and updates by Lue Hang (the author).

:clap: Contribute

Pull requests are welcomed.

:tophat: Contributors

Contributors will be posted here.

:baby: Beginners

Not sure where to start, or a beginner? Take a look at the issues page.

:page_facing_up: License

MIT © Lue Hang, as found in the LICENSE file.