79a8ab4aed | ||
---|---|---|
examples/Basic | ||
ios | ||
node_modules/react-native/React/Views | ||
src | ||
.eslintrc | ||
.flowconfig | ||
.gitignore | ||
.npmignore | ||
.watchmanconfig | ||
README.md | ||
index.js | ||
package.json |
README.md
React Native Blur
Component implementation for UIVisualEffectView's blur and vibrancy effect.
Check the roadmap here
Content
Installation
npm install react-native-blur
- In the XCode's "Project navigator", right click on project's
Libraries
folder ➜Add Files to <...>
- Go to
node_modules/react-native-blur/ios
➜ selectRNBlur
and click "add" - Inside your code include JS part by adding
const { BlurView, VibrancyView } = require('react-native-blur');
- Compile and have fun!
Usage example
First of all, if you don't want to read it, you can just clone the repo and go into examples/basic
folder to try out working example.
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" 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 effectxlight
- extra light blur typelight
- light blur typedark
- dark blur type
Questions?
Feel free to contact me in twitter or create an issue