Skip to content

πŸš€ Tiny and fast animated image gallery for react-native

License

Notifications You must be signed in to change notification settings

vivek-jm/react-native-animated-gallery

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

React Native Animated Gallery

npm npm

πŸš€ Tiny and fast animated image gallery for react-native

Β Β Β Β Β Β Β Β Β Β Β 

Getting started

npm i react-native-animated-gallery --save

or

yarn add react-native-animated-gallery

iOS

No additional step is required.

Android

No additional step is required.

Usage

First of all, import the component.

import AnimatedGallery from "react-native-animated-gallery";

Then use it like this.

import * as React from "react";
import { Text, View } from "react-native";
import AnimatedGallery from "react-native-animated-gallery";

export default () => {
  const images = [
    {
      id: 1,
      url: "https://images.pexels.com/photos/2347011/pexels-photo-2347011.jpeg?auto=compress&cs=tinysrgb&fit=crop&h=1200&w=800",
    },
    {
      id: 2,
      url: "https://images.pexels.com/photos/2387877/pexels-photo-2387877.jpeg?auto=compress&cs=tinysrgb&fit=crop&h=1200&w=800",
    },
    {
      id: 3,
      url: "https://images.pexels.com/photos/1624360/pexels-photo-1624360.jpeg?auto=compress&cs=tinysrgb&fit=crop&h=1200&w=800",
    },
  ];

  const Loader = () => {
    return (
      <View style={{ justifyContent: "center", alignItems: "center", flex: 1 }}>
        <Text>Custom Loader..</Text>
      </View>
    );
  };

  return (
    <View style={{ flex: 1, backgroundColor: "#fff" }}>
      <AnimatedGallery
        imageUrls={images}
        renderLoader={<Loader />}
        disablefullScreen={false}
        thumpBorderWidth={3}
        thumpBorderColor={"white"}
        spacing={8}
        imageSize={90}
        backgroundColor={"#0000"}
        onEndReached={() => {
          console.log("End reached");
        }}
        invertThumpDirection={false}
        invertGalleryDirection={false}
      />
    </View>
  );
};

Props


Reference

Props

imageUrls

Provides Data to the component

Type Required
Array yes

renderLoader

Custom loader for component

Type Required
ReactElement no

imageSize

Set the size of the thump nail to square proprtion

Type Required
imageSize number

spacing

Set the sapcing between thump nail.

Type Required
spacing number

thumpBorderWidth

Set the border width for thump nail.

Type Required
number No

thumpBorderColor

Set the border color for thump nail

Type Required
string No

disablefullScreen

Disable the fullscreen view of image

Type Required
boolean No

backgroundColor

Set the backgroundColor for gallery when not in fullscreen mode

Type Required
string No

onEndReached

Called when all rows have been rendered and the list has been scrolled to within onEndReachedThreshold of the bottom. The native scroll event is provided.

Type Required
function No

invertThumpDirection

Reverses the direction of scroll. Uses scale transforms of -1.

Type Required
boolean No

invertThumpDirection

Reverses the direction of scroll of gallery. Uses scale transforms of -1.

Type Required
boolean No

About

πŸš€ Tiny and fast animated image gallery for react-native

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 40.1%
  • Java 29.0%
  • Objective-C 21.0%
  • JavaScript 3.6%
  • Ruby 3.5%
  • Starlark 2.8%