Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including react-native-shimmer with all npm packages installed. Try it out:

var reactNativeShimmer = require("react-native-shimmer")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

react-native-shimmer v0.3.1

Simple shimmering effect in React Native

react-native-shimmer

Simple shimmering effect in React Native. Based on Shimmer/shimmer-android.

Shimmer

Installation

$ yarn add react-native-shimmer

Option: With react-native link

$ react-native link react-native-shimmer

Option: Manually

iOS

Add ios/RNShimmer.xcodeproj to Libraries and add libRNShimmer.a to Link Binary With Libraries under Build Phases. More info and screenshots about how to do this is available in the React Native documentation.

Android

  • Edit android/settings.gradle to look like this (without the +):
rootProject.name = 'MyApp'

include ':app'

+ include ':react-native-shimmer'
+ project(':react-native-shimmer').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-shimmer/android')
  • Edit android/app/build.gradle (note: app folder) to look like this:
apply plugin: 'com.android.application'

android {
  ...
}

dependencies {
  compile fileTree(dir: 'libs', include: ['*.jar'])
  compile "com.android.support:appcompat-v7:23.0.1"
  compile "com.facebook.react:react-native:+"  // From node_modules
+ compile project(':react-native-shimmer')
}
  • Edit your MainApplication.java (deep in android/app/src/main/java/...) to look like this (note two places to edit):
package com.myapp;

+ import com.oblador.shimmer.RNShimmerPackage;

....

  @Override
  protected List<ReactPackage> getPackages() {
    return Arrays.<ReactPackage>asList(
      new MainReactPackage()
+   , new RNShimmerPackage()
    );
  }

}

Option: With CocoaPods

Add the following to your Podfile and run pod update:

pod 'react-native-shimmer', :path => 'node_modules/react-native-shimmer'

Usage

NOTE: Shimmer may only have one child.

import Shimmer from 'react-native-shimmer';

<Shimmer>
  <Text>Loading...</Text>
</Shimmer>

Properties

PropDescriptionDefault
animatingWhether or not to show shimmering effect.true
directionThe direction of shimmering animation, valid values are up, down, left, right.right
durationThe shimmering animation duration in milliseconds.1000
pauseDurationThe time interval between shimmerings in milliseconds.400
animationOpacityThe opacity of the content while it is shimmering.1
opacityThe opacity of the content before it is shimmering. iOS only0.5
highlightLengthThe highlight length of shimmering. Range of 0–1. iOS only1
beginFadeDurationThe duration of the fade used when shimmer begins. iOS only0
endFadeDurationThe duration of the fade used when shimmer ends. iOS only0
tiltThe tilt angle of the highlight, in degrees. Android only0
intensityThe intensity of the highlight mask. Range of 0–1. Android only0

License

MIT License. Shimmer is under BSD license. © Joel Arvidsson 2016 - present

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free