### React Native Blur
Component implementation for UIVisualEffectView's blur and vibrancy effect.
Check the [roadmap here](https://github.com/Kureev/react-native-blur/issues/1)
### Content
- [Installation](#installation)
- [Usage example](#usage-example)
- [Blur view](#blur-view)
- [Vibrancy view](#vibrancy-view)
- [Component properties](#component-properties)
- [Questions?](#questions)
### Installation
1. Install package via npm:
```
npm install react-native-blur
```
2. Link `RNBlur` library from `node_modules/react-native-blur/ios` folder like it's [described here](http://facebook.github.io/react-native/docs/linking-libraries-ios.html). Don't forget to add it to `Build Phases` of your project!
3. Inside your code include JS part by adding
```javascript
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 `` tag inside render function as it's done below:
```javascript
const { BlurView } = require('react-native-blur');
const Menu = React.createClass({
render() {
return (
Hi, I am a tiny menu item
);
}
});
```
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
```javascript
const { VibrancyView } = require('react-native-blur');
const Menu = React.createClass({
render() {
return (
Hi, I am a tiny menu item
);
}
});
```
### Component properties
- `blurType` (String) - blur type effect
- `xlight` - extra light blur type
- `light` - light blur type
- `dark` - dark blur type
### Questions?
Feel free to contact me in [twitter](https://twitter.com/kureevalexey) or [create an issue](https://github.com/Kureev/react-native-blur/issues/new)