0.3.1 • Published 2 years ago

react-native-shimmer-kit v0.3.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

React Native Shimmer Kit

A JavaScript library used for creating shimmer effect in React Native.

npm

Get Started

Install library

Using Yarn

yarn add react-native-shimmer-kit

Or using NPM

npm install react-native-shimmer-kit --save

Install dependencies

For React Native CLI:

Using Yarn

yarn add react-native-linear-gradient

Or using NPM

npm install react-native-linear-gradient --save

Note: checkout react-native-linear-gradient for more information.

For Expo Go:

expo install expo-linear-gradient

Note: checkout expo-linear-gradient for more information.

Configure for iOS

Run cd ios && pod install

Configure for Android

No additional set up necessary.

Usage

React Native CLI:

import Shimmer from 'react-native-shimmer-kit';

const YourShimmer = () => (
  <Shimmer
    width={120}
    height={120}
    borderRadius={60}
    duration={3000}
    colors={['#93C5FD', '#BFDBFE', '#BFDBFE', '#93C5FD']}
  />
);

Expo Go:

import {LinearGradient as ExpoLinearGradient} from 'expo-linear-gradient';
import Shimmer from 'react-native-shimmer-kit';

const YourShimmer = () => (
  <Shimmer
    width={120}
    height={120}
    borderRadius={60}
    duration={3000}
    colors={['#93C5FD', '#BFDBFE', '#BFDBFE', '#93C5FD']}
    LinearGradientComponent={ExpoLinearGradient} // <~ required this for expo project
  />
);

Props

PropDescriptionRequiredTypeDefault
widthwidth of shimmer:white_check_mark:numberundefined
heightheight of shimmer:white_check_mark:numberundefined
borderRadiusthe radius of the shimmer's corners:white_large_square:number0
marginVerticalthe top-bottom margin of shimmer:white_large_square:number0
marginHorizontalthe left-right margin of shimmer:white_large_square:number0
marginTopthe right margin of shimmer:white_large_square:number0
marginBottomthe bottom margin of shimmer:white_large_square:number0
marginLeftthe left margin of shimmer:white_large_square:number0
marginRightthe right margin of shimmer:white_large_square:number0
colorsarray of colors for gradient background:white_large_square:string[]'#E6E6E6', '#f5f5f5', '#f5f5f5', '#E6E6E6'
durationduration of shimmer over a row:white_large_square:number1500
isloopedloop the animation:white_large_square:booleantrue
isReversedreverse direction of the animation:white_large_square:booleanfalse
customStylecustom style for shimmer:white_large_square:ViewStyleundefined
LinearGradientComponentLinearGradient components ('react-native-linear-gradient' or 'expo-linear-gradient'):white_large_square:React componentreact-native-linear-gradient