README.md 3.25 KB
Newer Older
Greg Wilson's avatar
Greg Wilson committed
1
# react-native-apple-healthkit
Greg Wilson's avatar
Greg Wilson committed
2 3
A React Native bridge module for interacting with [Apple HealthKit] data. 

Greg Wilson's avatar
Greg Wilson committed
4
![Alt text](https://devimages.apple.com.edgekey.net/assets/elements/icons/healthkit/healthkit-64x64.png "Apple HealthKit")
Greg Wilson's avatar
Greg Wilson committed
5 6 7 8 9 10 11 12 13
## Getting started

###  Installation (xcode)

1. `npm install react-native-apple-healthkit@https://github.com/GregWilson/react-native-apple-healthkit.git --save`
2. In XCode, in the project navigator, right click `Libraries``Add Files to [your project's name]`
3. Go to `node_modules``react-native-apple-healthkit` and add `RCTAppleHealthKit.xcodeproj`
4. In XCode, in the project navigator, select your project. Add `libRCTAppleHealthKit.a` to your project's `Build Phases``Link Binary With Libraries`
5. Click `RCTAppleHealthKit.xcodeproj` in the project navigator and go the `Build Settings` tab. Make sure 'All' is toggled on (instead of 'Basic'). In the `Search Paths` section, look for `Header Search Paths` and make sure it contains both `$(SRCROOT)/../../react-native/React` and `$(SRCROOT)/../../../React` - mark both as `recursive`.
Greg Wilson's avatar
Greg Wilson committed
14
5. Compile and have fun
Greg Wilson's avatar
Greg Wilson committed
15

Greg Wilson's avatar
Greg Wilson committed
16
### Usage
Greg Wilson's avatar
Greg Wilson committed
17

Greg Wilson's avatar
Greg Wilson committed
18 19 20
Just `require` the `react-native-apple-healthkit` module and you're ready to go!
```javascript
var AppleHealthKit = require('react-native-apple-healthkit');
Greg Wilson's avatar
Greg Wilson committed
21

Greg Wilson's avatar
Greg Wilson committed
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
...

let healthKitOptions = {
    permissions: {
        read: ["Height", "Weight", "Steps", "DateOfBirth", "BodyMassIndex"],
        write: ["Weight", "Steps"]
    }
};

AppleHealthKit.initHealthKit(healthKitOptions, (err, res) => {
    if(err) {
        console.log("error initializing healthkit: ", err);
        return;
    }
    console.log("HEALTHKIT INITIALIZED!");
    // ...
});


```

Greg Wilson's avatar
Greg Wilson committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
When the module has been successfully initialized you can read and write HealthKit data

```javascript
var AppleHealthKit = require('react-native-apple-healthkit');
var _ = require('lodash');

...

AppleHealthKit.getCurrentWeight(null, (err, weight) => {
    if(err){
        console.log("error getting current weight: ", err);
        return;
    }
    weight = _.round(weight,1);
    // do something with the weight...
});

...

let myWeight = 200;
AppleHealthKit.saveWeight({weight:myWeight}, (err, res) => {
    if(err){
        console.log("error saving weight to healthkit: ", err);
        return;
    }
    // weight successfully saved
});


```
Greg Wilson's avatar
Greg Wilson committed
73 74


Greg Wilson's avatar
Greg Wilson committed
75 76 77 78 79 80

## Documentation

### Methods

**`isAvailable`** : check if HealthKit is available on the device
Greg Wilson's avatar
Greg Wilson committed
81 82 83 84 85 86 87
```javascript
AppleHealthKit.isAvailable((err: string, available: bool) => {
    if(available){
        // ...
    }
});
```
Greg Wilson's avatar
Greg Wilson committed
88
___
Greg Wilson's avatar
Greg Wilson committed
89 90 91 92 93 94 95

**`initHealthKit`** : check if HealthKit is available on the device

`initHealthKit` requires an options object with HealthKit permission settings.
```javascript
let healthKitOptions = {
    permissions: {
Greg Wilson's avatar
Greg Wilson committed
96 97 98 99 100 101 102 103 104 105
        read: [
            "Height", 
            "Weight", 
            "Steps", 
            "DateOfBirth", 
            "BodyMassIndex"
        ],
        write: [
            "Weight"
        ]
Greg Wilson's avatar
Greg Wilson committed
106 107
    }
};
Greg Wilson's avatar
Greg Wilson committed
108
```
Greg Wilson's avatar
Greg Wilson committed
109

Greg Wilson's avatar
Greg Wilson committed
110
```javascript
Greg Wilson's avatar
Greg Wilson committed
111 112 113 114 115 116 117 118 119 120
AppleHealthKit.initHealthKit(healthKitOptions: object, (err: string, res: object) => {
    if(err) {
        console.log("error initializing healthkit: ", err);
        return;
    }
    // healthkit is initialized...
    // now safe to read and write healthkit data...
});
```

Greg Wilson's avatar
Greg Wilson committed
121

Greg Wilson's avatar
Greg Wilson committed
122
[Apple HealthKit]: https://developer.apple.com/healthkit/