A <LinearGradient /> component for react-native
Latest commit 7179ed1 Nov 16, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
BVLinearGradient.xcodeproj Update to recommended Xcode 9.4 settings Sep 17, 2018
BVLinearGradient Added angled gradient support Nov 5, 2018
Examples AnimatedGradientTransition example Jun 28, 2018
android Added angled gradient support Nov 5, 2018
images move images into subdirectory Jan 19, 2016
windows Adding shared project reference to WPF project Apr 11, 2017
.DS_Store update example to rn 44, fix View.propTypes warning May 12, 2017
.flowconfig Add a .flowconfig, remove more unnecessary code Apr 14, 2015
.gitattributes initial implementation for wpf - needs RNW node module Dec 28, 2016
.gitignore Add Android example, update example to 0.16.0, fix 0.16.0 Android compat Dec 7, 2015
.npmignore ignore the images/ folder from the npm package Aug 11, 2018
BVLinearGradient.podspec Correct framework types Jun 21, 2018
CHANGELOG.md Update changelog & package.json Nov 16, 2018
LICENSE Add LICENSE file in the repository Aug 24, 2016
README.md Update README.md Nov 5, 2018
index.android.js Added angled gradient support Nov 5, 2018
index.d.ts Added TS definitions Nov 5, 2018
index.ios.js Added angled gradient support Nov 5, 2018
index.js Add index.js to save everyone fiddling with their eslint and/or flow … May 31, 2017
index.windows.js initial implementation for wpf - needs RNW node module Dec 28, 2016
nativeLinearGradient.js fix error for RN >= 49 Mar 20, 2018
package.json v2.4.4 Nov 16, 2018

README.md

Version NPM

react-native-linear-gradient

A <LinearGradient> component for react-native, as seen in react-native-login.

Version 2.0 supports react-native >= 0.40.0

Add it to your project

You can try linking the project automatically:

$ react-native link react-native-linear-gradient

or do it manually as described below:

iOS

  • Run npm install react-native-linear-gradient --save

Then either:

Cocoapods

add the following line to your Podfile:

pod 'React', :path => '../node_modules/react-native'
pod 'BVLinearGradient', :path => '../node_modules/react-native-linear-gradient'

or:

Manually
  1. Open your project in XCode, right click on Libraries and click Add Files to "Your Project Name" Look under node_modules/react-native-linear-gradient and add BVLinearGradient.xcodeproj. (Screenshot).
  2. Add libBVLinearGradient.a to Build Phases -> Link Binary With Libraries (Screenshot).
  3. Click on BVLinearGradient.xcodeproj in Libraries and go the Build Settings tab. Double click the text to the right of Header Search Paths and verify that it has $(SRCROOT)/../react-native/React - if it isn't, then add it. This is so XCode is able to find the headers that the BVLinearGradient source files are referring to by pointing to the header files installed within the react-native node_modules directory. (Screenshot).

Then:

  • Whenever you want to use it within React code now you can: import LinearGradient from 'react-native-linear-gradient';

If you're having trouble, you can point your package.json at github to see if the issue has been fixed. Simply change the dependency

"react-native-linear-gradient": "react-native-community/react-native-linear-gradient",

to get the data right from github instead of npm and then npm install

For instance the podspec file does not contain the right data (author attributes etc..) in npm while it does in the github repo.

Android

  • Run npm install react-native-linear-gradient --save

Then:

  1. in android/settings.gradle
...
include ':react-native-linear-gradient'
project(':react-native-linear-gradient').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-linear-gradient/android')
  1. in android/app/build.gradle add:
dependencies {
    ...
    compile project(':react-native-linear-gradient')
}
  1. and finally, in android/app/src/main/java/com/{YOUR_APP_NAME}/MainActivity.java for react-native < 0.29, or android/app/src/main/java/com/{YOUR_APP_NAME}/MainApplication.java for react-native >= 0.29 add:
//...
import com.BV.LinearGradient.LinearGradientPackage; // <--- This!
//...
@Override
protected List<ReactPackage> getPackages() {
  return Arrays.<ReactPackage>asList(
    new MainReactPackage(),
    new LinearGradientPackage() // <---- and This!
  );
}

Windows (WPF)

  1. in windows/MyApp.sln Add -> Existing Project: node_modules/react-native-linear-gradient/windows/LinearGradientWPF/LinearGradientWPF.csproj

  2. in windows/MyApp/MyAppWPF/MyAppWPF.csproj Add -> Reference -> LinearGradientWPF

  3. in windows/MyApp/MyAppWPF/AppReactPage.cs add: using LinearGradient; and

public override List<IReactPackage> Packages => new List<IReactPackage>
{
  ...
  new LinearGradientPackage()
}

Examples

Simple

The following code will produce something like this:

Example code result

import LinearGradient from 'react-native-linear-gradient';

// Within your render function
<LinearGradient colors={['#4c669f', '#3b5998', '#192f6a']} style={styles.linearGradient}>
  <Text style={styles.buttonText}>
    Sign in with Facebook
  </Text>
</LinearGradient>

// Later on in your styles..
var styles = StyleSheet.create({
  linearGradient: {
    flex: 1,
    paddingLeft: 15,
    paddingRight: 15,
    borderRadius: 5
  },
  buttonText: {
    fontSize: 18,
    fontFamily: 'Gill Sans',
    textAlign: 'center',
    margin: 10,
    color: '#ffffff',
    backgroundColor: 'transparent',
  },
});

Horizontal gradient

Using the styles from above, set start and end like this to make the gradient go from left to right, instead of from top to bottom:

<LinearGradient start={{x: 0, y: 0}} end={{x: 1, y: 0}} colors={['#4c669f', '#3b5998', '#192f6a']} style={styles.linearGradient}>
  <Text style={styles.buttonText}>
    Sign in with Facebook
  </Text>
</LinearGradient>

Additional props

In addition to regular View props, you can also provide additional props to customize your gradient look:

colors

An array of at least two color values that represent gradient colors. Example: ['red', 'blue'] sets gradient from red to blue.

start

An optional object of the following type: { x: number, y: number }. Coordinates declare the position that the gradient starts at, as a fraction of the overall size of the gradient, starting from the top left corner. Example: { x: 0.1, y: 0.1 } means that the gradient will start 10% from the top and 10% from the left.

end

Same as start, but for the end of the gradient.

locations

An optional array of numbers defining the location of each gradient color stop, mapping to the color with the same index in colors prop. Example: [0.1, 0.75, 1] means that first color will take 0% - 10%, second color will take 10% - 75% and finally third color will occupy 75% - 100%.

<LinearGradient
  start={{x: 0.0, y: 0.25}} end={{x: 0.5, y: 1.0}}
  locations={[0,0.5,0.6]}
  colors={['#4c669f', '#3b5998', '#192f6a']}
  style={styles.linearGradient}>
  <Text style={styles.buttonText}>
    Sign in with Facebook
  </Text>
</LinearGradient>

Example with extra props

useAngle / angle / angleCenter

You may want to achieve an angled gradient effect, similar to those in image editors like Photoshop.
One issue is that you have to calculate the angle based on the view's size, which only happens asynchronously and will cause unwanted flickr.

In order to do that correctly you can set { useAngle: true, angle: 45, angleCenter: { x: 0.5, y: 0.5} }, to achieve a gradient with a 45 degrees angle, with its center positioned in the view's exact center.

useAngle is used to turn on/off angle based calculation (as opposed to start/end).
angle is the angle in degrees.
angleCenter is the center point of the angle (will control the weight and stretch of the gradient like it does in photoshop.

Updating the values for fun

Check out Examples/AnimatedGradient (git clone this project, cd into it, npm install, open in XCode and run) to see how this is done:

Example with extra props

This gif was created using licecap - a great piece of free OSS

An example app

You can see this component in action in brentvatne/react-native-login.

Other platforms

License

License is MIT