npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mythologi/react-native-blur

v4.0.2

Published

React Native Blur component

Downloads

17

Readme

Mythologi-XR/react-native-blur

npm version

A component for UIVisualEffectView's blur and vibrancy effect on iOS, and BlurView on Android.

Content

Installation

  1. Install the library using either Yarn:
yarn add @react-native-community/blur

or npm:

npm install --save @react-native-community/blur
  1. React-Native 0.59 and below only: Link your native dependencies:
react-native link @react-native-community/blur
  1. (iOS only) Install to Xcode:
npx pod-install

Or, if you already have installed Cocoapods on your system:

cd ios && pod install
  1. (Android only, optional) If you've defined project-wide properties (recommended) in your root build.gradle, this library will detect the presence of the following properties:
buildscript {...}
allprojects {...}

/**
  + Project-wide Gradle configuration properties
  */
ext {
    compileSdkVersion   = 27
    targetSdkVersion    = 27
    buildToolsVersion   = "27.0.3"
}
  1. Include the library in your code:
import { BlurView, VibrancyView } from '@react-native-community/blur'
  1. Compile and have fun!

BlurView

Properties:

  • blurType (String)
    • xlight - extra light blur type
    • light - light blur type
    • dark - dark blur type
    • extraDark - extra dark blur type (tvOS only)
    • regular - regular blur type (iOS 10+ and tvOS only)
    • prominent - prominent blur type (iOS 10+ and tvOS only)
    • iOS 13 only Blur types:
      • chromeMaterial - An adaptable blur effect that creates the appearance of the system chrome.
      • material - An adaptable blur effect that creates the appearance of a material with normal thickness.
      • thickMaterial - An adaptable blur effect that creates the appearance of a material that is thicker than normal.
      • thinMaterial - An adaptable blur effect that creates the appearance of an ultra-thin material.
      • ultraThinMaterial - An adaptable blur effect that creates the appearance of an ultra-thin material.
      • chromeMaterialDark - A blur effect that creates the appearance of an ultra-thin material and is always dark.
      • materialDark - A blur effect that creates the appearance of a thin material and is always dark.
      • thickMaterialDark - A blur effect that creates the appearance of a material with normal thickness and is always dark.
      • thinMaterialDark - A blur effect that creates the appearance of a material that is thicker than normal and is always dark.
      • ultraThinMaterialDark - A blur effect that creates the appearance of the system chrome and is always dark.
      • chromeMaterialLight - An adaptable blur effect that creates the appearance of the system chrome.
      • materialLight - An adaptable blur effect that creates the appearance of a material with normal thickness.
      • thickMaterialLight - An adaptable blur effect that creates the appearance of a material that is thicker than normal.
      • thinMaterialLight - An adaptable blur effect that creates the appearance of a thin material.
      • ultraThinMaterialLight - An adaptable blur effect that creates the appearance of an ultra-thin material.
  • blurAmount (Default: 10, Number)
    • 0-100 - Adjusts blur intensity
  • reducedTransparencyFallbackColor (Color) (iOS only)
    • black, white, #rrggbb, etc - background color to use if accessibility setting ReduceTransparency is enabled

Note: The maximum blurAmount on Android is 32, so higher values will be clamped to 32.

Complete usage example that works on iOS and Android:

import React, { Component } from 'react'
import { View, Image, Text, StyleSheet } from 'react-native'
import { BlurView } from '@react-native-community/blur'

export default class Menu extends Component {
  render() {
    return (
      <View style={styles.container}>
        <Image key={'blurryImage'} source={{ uri }} style={styles.absolute} />
        <Text style={styles.absolute}>Hi, I am some blurred text</Text>
        {/* in terms of positioning and zIndex-ing everything before the BlurView will be blurred */}
        <BlurView
          style={styles.absolute}
          blurType="light"
          blurAmount={10}
          reducedTransparencyFallbackColor="white"
        />
        <Text>I'm the non blurred text because I got rendered on top of the BlurView</Text>
      </View>
    )
  }
}

const styles = StyleSheet.create({
  container: {
    justifyContent: 'center',
    alignItems: 'center',
  },
  absolute: {
    position: 'absolute',
    top: 0,
    left: 0,
    bottom: 0,
    right: 0,
  },
})

In this example, the Image component will be blurred, because the BlurView in positioned on top. But the Text will stay unblurred.

If the accessibility setting Reduce Transparency is enabled the BlurView will use reducedTransparencyFallbackColor as it's background color rather than blurring. If no reducedTransparencyFallbackColor is provided, theBlurViewwill use the default fallback color (white, black, or grey depending on blurType)

VibrancyView

Uses the same properties as BlurView (blurType, blurAmount, and reducedTransparencyFallbackColor).

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

(Note: VibrancyView is only supported on iOS. Also note that the VibrancyView must contain nested views.)

import { VibrancyView } from '@react-native-community/blur'

export default class Menu extends Component {
  render() {
    return (
      <Image source={{ uri }} style={styles.absolute}>
        <VibrancyView blurType="light" style={styles.flex}>
          <Text>Hi, I am some vibrant text.</Text>
        </VibrancyView>
      </Image>
    )
  }
}

Android

Android uses the BlurView.

If you only need to support iOS, then you can safely ignore these limitations.

In addition to blurType and blurAmount, Android has some extra props that can be used to override the default behavior (or configure Android-specific behavior):

  • blurRadius (Number - between 0 and 25) - Manually adjust the blur radius. (Default: matches iOS blurAmount)
  • downsampleFactor (Number - between 0 and 25) - Scales down the image before blurring (Default: matches iOS blurAmount)
  • overlayColor (Color) - Set a custom overlay color (Default color based on iOS blurType)

Example React Native App

This project includes an example React Native app, which was used to make the GIF in this README. You can run the apps by following these steps:

  1. Clone the repository
git clone https://github.com/Mythologi-XR/react-native-blur.git
  1. cd to example
cd react-native-blur/example
  1. Install dependencies
npm install
  1. Run the apps:

Run the iOS app

react-native run-ios

Run the Android app

react-native run-android

Questions?

Feel free to create an issue.