React Native Blur component
Objective-C Java JavaScript Ruby
Latest commit 36c128f Jan 8, 2017 @Kureev Kureev committed on GitHub Merge pull request #139 from morelazers/update-readme-for-android
Update README.md

README.md

npm version

React Native Blur

Component implementation for UIVisualEffectView's blur and vibrancy effect.
Check the roadmap here

Content

Installation

  1. Install package via npm:

    npm install react-native-blur
    
  2. Link your native dependencies:

    react-native link react-native-blur
    
  3. (Android only) Add the following to your android/app/build.gradle

    android {
        ...
        defaultConfig {
            ...
            renderscriptTargetApi 20
            renderscriptSupportModeEnabled true
        }
    }
    
    repositories {
        maven { url 'https://github.com/500px/500px-android-blur/raw/master/releases/' }
    }
    
    dependencies {
        ...
        compile project(':react-native-blur')
    }
    
      buildscript {
          repositories {
              maven { url 'https://github.com/500px/500px-android-blur/raw/master/releases/' }
          }
          dependencies {
              classpath 'com.fivehundredpx:blurringview:1.0.0'
          }
      }
    
  4. Inside your code include JS part by adding

    const { BlurView, VibrancyView } = require('react-native-blur');
  5. Compile and have fun!

Usage example

You can run built-in example via few simple steps: 1. Clone repository 2. Go to examples/Basic 3. Run npm install && open Basic.xcodeproj 4. Hit "Run"(cmd+R) button on XCode panel

Blur View

To use blur view, you need to require BlurView to your module and insert <BlurView> tag inside render function as it's done below:

const { BlurView } = require('react-native-blur');

const Menu = React.createClass({
  render() {
    return (
      <Image source={{uri}} style={styles.menu}>
        <BlurView blurType="light" blurAmount={10} style={styles.blur}>
          <Text>Hi, I am a tiny menu item</Text>
        </BlurView>
      </Image>
    );
  }
});

In this example, Image component will be blurred, a BlurView content will stay untouched.

Vibrancy View

The vibrancy effect lets the content underneath a blurred view show through more vibrantly

const { VibrancyView } = require('react-native-blur');

const Menu = React.createClass({
  render() {
    return (
      <Image source={{uri}} style={styles.menu}>
        <VibrancyView blurType="light" style={styles.blur}>
          <Text>Hi, I am a tiny menu item</Text>
        </VibrancyView>
      </Image>
    );
  }
});

Component properties

  • blurType (String) - blur type effect
    • xlight - extra light blur type
    • light - light blur type
    • dark - dark blur type
  • blurAmount (Default: 10, Number) - blur amount effect
    • 0-100 - Adjusts blur intensity

Note: blurAmount does not refresh with Hot Reloading. You must a refresh the app to view the results of the changes

Android

Android support uses an external library which has slightly different properties and setup requirements. This is why extra code must be added manually to the android/app/build.gradle file as documented above.

The android BlurView works by blurring an existing referenced view, so you must wait till the view you want to blur is rendered and then provide the reference to the BlurView as the viewRef prop. Take a look at the example to see how it works.

It has the following props:

  • viewRef (Number) - a reference to the existing view you want to blur
  • blurRadius (Number)
  • downsampleFactor (Number)
  • overlayColor (Color)

Troubleshooting

On older instances of react-native, BlurView package does not get added into the MainActivity/MainApplication classes where you would see Warning: Native component for 'BlurView' does not exist in RN YellowBox or console.

To rectify this, you can add the BlurViewPackage manually in MainActivity/MainApplication classes

...
import com.cmcewen.blurview.BlurViewPackage;
...

public class MainApplication extends Application implements ReactApplication {
...
    @Override
    protected List<ReactPackage> getPackages() {
      return Arrays.<ReactPackage>asList(
          new MainReactPackage(),
          new BlurViewPackage()
      );
    }
...
}

Questions?

Feel free to contact me in twitter or create an issue