Commit fe8a7719 authored by Antoine Rousseau's avatar Antoine Rousseau

improve README / fix #74

parent ec7f7746
## Release Notes
### 0.9.3
adds support for Brand information e.g. apple, htc, etc
### 0.9.1
adds support for the iPhone SE and new iPad Pro
### 0.9.0
adds support for device country and changes the iOS device name to match Apple branding
### 0.8.4
don't use destructuring
### 0.8.3
removes the default bluetooth permission
### 0.8.2
change deployment target to iOS 8
### 0.8.1
removes unnecessary peerDependencies
### 0.8.0
tweaks how device locale works on Android. If it's available it will use the toLanguageTag that is more inline with iOS. (See #14)
### 0.7.0
adds two new parameters, Device Locale and User Agent.
### 0.5.0
adds a new parameter; Device Id. On iOS this is the hardware string for the current device (e.g. "iPhone7,2"). On Android we use the BOARD field which is the name of the underlying board, e.g. "goldfish". The way that the module gets the device model on iOS has also changed to be based on the Device Id; now instead of getting a generic product family e.g. "iPhone", it will return the specific model e.g. "iPhone 6".
## react-native-device-info
# react-native-device-info
[![npm version](https://badge.fury.io/js/react-native-device-info@2x.png)](http://badge.fury.io/js/react-native-device-info)
Device Information for react-native
Device Information for [React Native](https://github.com/facebook/react-native)
## Installation via [`rnpm`](https://github.com/rnpm/rnpm)
## Install
```shell
rnpm install react-native-device-info
npm install --save react-native-device-info
```
`rnpm` will install (--save) this module then linking for react-native, so you don't have to link for each platforms manually as the following.
## Automatically link
## Installation
#### With React Native 0.27+
First you need to install react-native-device-info:
```shell
react-native link react-native-device-info
```
#### With older versions of React Native
You need [`rnpm`](https://github.com/rnpm/rnpm) (`npm install -g rnpm`)
```javascript
npm install react-native-device-info --save
```shell
rnpm link react-native-device-info
```
### Installation (iOS)
## Manually link
#### Installing via Cocoa Pods
### iOS (via Cocoa Pods)
Add the following line to your build targets in your `Podfile`
`pod 'RNDeviceInfo', :path => '../node_modules/react-native-device-info'`
Then run `pod install`
#### Installing manually
### iOS (without Cocoa Pods)
In XCode, in the project navigator:
- Right click Libraries
- Add Files to [your project's name]
- Go to node_modules/react-native-device-info
- Add the .xcodeproj file
- Right click _Libraries_
- Add Files to _[your project's name]_
- Go to `node_modules/react-native-device-info`
- Add the `.xcodeproj` file
In XCode, in the project navigator, select your project.
- Add the libRNDeviceInfo.a from the deviceinfo project to your project's Build Phases ➜ Link Binary With Libraries
- Click .xcodeproj file you added before in the project navigator and go the Build Settings tab. Make sure 'All' is toggled on (instead of 'Basic').
- Look for Header Search Paths and make sure it contains both $(SRCROOT)/../react-native/React and $(SRCROOT)/../../React - mark both as recursive. (Should be OK by default.)
- Add the `libRNDeviceInfo.a` from the _deviceinfo_ project to your project's _Build Phases ➜ Link Binary With Libraries_
- Click `.xcodeproj` file you added before in the project navigator and go the _Build Settings_ tab. Make sure _All_ is toggled on (instead of _Basic_).
- Look for _Header Search Paths_ and make sure it contains both `$(SRCROOT)/../react-native/React` and `$(SRCROOT)/../../React`
- Mark both as recursive (should be OK by default).
Run your project (Cmd+R)
(Thanks to @brysgo for writing the instructions)
### Installation (Android)
* Add Gradle configuration changes
Run `react-native link react-native-device-info` in your project root.
* register module
### Android
On React Native 0.29+:
#### With React Native 0.29+
in MainApplication.java:
- in `MainApplication.java`:
```java
import com.learnium.RNDeviceInfo.RNDeviceInfo; // <--- import
```diff
+ import com.learnium.RNDeviceInfo.RNDeviceInfo;
public class MainApplication extends Application implements ReactApplication {
......
public class MainApplication extends Application implements ReactApplication {
//......
@Override
protected List<ReactPackage> getPackages() {
return Arrays.<ReactPackage>asList(
new RNDeviceInfo(), // <---- add here
+ new RNDeviceInfo(),
new MainReactPackage()
);
}
......
}
}
```
#### With older versions of React Native:
On React Native 0.18-0.28:
- in `MainActivity.java`:
in MainActivity.java:
```diff
+ import com.learnium.RNDeviceInfo.RNDeviceInfo;
```java
import com.learnium.RNDeviceInfo.RNDeviceInfo; // <--- import
public class MainActivity extends ReactActivity {
public class MainActivity extends ReactActivity {
......
/**
* A list of packages used by the app. If the app uses additional views
* or modules besides the default ones, add more packages here.
*/
@Override
protected List<ReactPackage> getPackages() {
return Arrays.<ReactPackage>asList(
new RNDeviceInfo(), // <------ add here
new MainReactPackage());
+ new RNDeviceInfo(),
new MainReactPackage()
);
}
}
}
```
(Thanks to @chirag04 for writing the instructions)
* If you want to get the device name in Android add this to your AndroidManifest.xml (optional)
## Device Name
If you want to get the device name in Android add this to your `AndroidManifest.xml` (optional):
```xml
...
......@@ -110,16 +109,8 @@ public class MainActivity extends ReactActivity {
```
## Release Notes
* 0.9.3 adds support for Brand information e.g. apple, htc, etc
* 0.9.1 adds support for the iPhone SE and new iPad Pro
* 0.9.0 adds support for device country and changes the iOS device name to match Apple branding
* 0.8.4 don't use destructuring
* 0.8.3 removes the default bluetooth permission
* 0.8.2 change deployment target to iOS 8
* 0.8.1 removes unnecessary peerDependencies
* 0.8.0 tweaks how device locale works on Android. If it's available it will use the toLanguageTag that is more inline with iOS. (See #14)
* 0.7.0 adds two new parameters, Device Locale and User Agent.
* 0.5.0 adds a new parameter; Device Id. On iOS this is the hardware string for the current device (e.g. "iPhone7,2"). On Android we use the BOARD field which is the name of the underlying board, e.g. "goldfish". The way that the module gets the device model on iOS has also changed to be based on the Device Id; now instead of getting a generic product family e.g. "iPhone", it will return the specific model e.g. "iPhone 6".
See [CHANGELOG.md](https://github.com/rebeccahughes/react-native-device-info/blob/master/CHANGELOG.md)
## Example
......@@ -137,11 +128,11 @@ console.log("Device Model", DeviceInfo.getModel()); // e.g. iPhone 6
console.log("Device ID", DeviceInfo.getDeviceId()); // e.g. iPhone7,2 / or the board on Android e.g. goldfish
console.log("Device Name", DeviceInfo.getSystemName()); // e.g. iPhone OS
console.log("System Name", DeviceInfo.getSystemName()); // e.g. iPhone OS
console.log("Device Version", DeviceInfo.getSystemVersion()); // e.g. 9.0
console.log("System Version", DeviceInfo.getSystemVersion()); // e.g. 9.0
console.log("Bundle Id", DeviceInfo.getBundleId()); // e.g. com.learnium.mobile
console.log("Bundle ID", DeviceInfo.getBundleId()); // e.g. com.learnium.mobile
console.log("Build Number", DeviceInfo.getBuildNumber()); // e.g. 89
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment