react-native-health-connect

Records returned in upsertionChanges are serialized in the same format as readRecords results. This means unit-bearing fields use the *Result variant (providing multiple unit conversions) rather than a simple { value, unit } object.

For example, a Weight record will provide fields like inKilograms, inGrams, etc. To access specific values, you should check the recordType and then access the corresponding unit field.

Example: Extracting Weight in Kilograms

const weightsInKilograms = upsertionChanges.flatMap(({ record }) =>
  record.recordType === 'Weight' ? [record.weight.inKilograms] : []
);

// Example of the data structure returned for a Weight record
{
  "recordType": "Weight",
  "weight": {
    "inGrams": 75000,
    "inKilograms": 75,
    "inMilligrams": 75000000,
    "inMicrograms": 75000000000,
    "inOunces": 2645.5474378402178,
    "inPounds": 165.3466966386582
  }
}

This package cannot be used in the Expo Go app; it requires a custom development build. As of v4, Expo integration is built into react-native-health-connect.

1. Install the package and expo-build-properties:

npm install react-native-health-connect
npm install expo-build-properties --save-dev

2. Add the config plugins to your app.json or app.config.js. Note that minSdkVersion must be at least 26.

3. Run npx expo prebuild and rebuild your app (e.g., yarn android).

4. Create a new EAS development build:

eas build --profile development --platform android

{
  "expo": {
    "plugins": [
      "react-native-health-connect",
      [
        "expo-build-properties",
        {
          "android": {
            "compileSdkVersion": 36,
            "targetSdkVersion": 36,
            "minSdkVersion": 26
          }
        }
      ]
    ]
   }
}

To access Health Connect data in a React Native CLI project, you must configure the Android manifest to include specific permissions and handle permission rationale activities for different Android versions.

1. Add permissions to android/src/main/AndroidManifest.xml using the android.permission.health.* format.
2. Create a Rationale Activity: For Android versions up to 13, you must implement a PermissionRationaleActivity.kt to show users why you need access when they click privacy policy links.
3. Configure Intent Filters:
   • Add androidx.health.ACTION_SHOW_PERMISSIONS_RATIONALE to your MainActivity intent filter (for Android 13 and below).
   • Add a new PermissionsRationaleActivity with the same action.
   • For Android 14+, add an <activity-alias> named ViewPermissionUsageActivity targeting your MainActivity with the android.permission.START_VIEW_PERMISSION_USAGE permission.

<!-- Example permissions in AndroidManifest.xml -->
<uses-permission android:name="android.permission.health.READ_HEART_RATE"/>
<uses-permission android:name="android.permission.health.WRITE_HEART_RATE"/>

<!-- Activity for rationale (Android 13 and below) -->
<activity
  android:name=".PermissionsRationaleActivity"
  android:exported="true">
  <intent-filter>
    <action android:name="androidx.health.ACTION_SHOW_PERMISSIONS_RATIONALE" />
  </intent-filter>
</activity>

<!-- Activity alias (Android 14+) -->
<activity-alias
  android:name="ViewPermissionUsageActivity"
  android:exported="true"
  android:targetActivity=".MainActivity"
  android:permission="android.permission.START_VIEW_PERMISSION_USAGE">
  <intent-filter>
    <action android:name="android.intent.action.VIEW_PERMISSION_USAGE" />
    <category android:name="android.intent.category.HEALTH_PERMISSIONS" />
  </intent-filter>
</activity-alias>

To allow your app to read health data while running in the background (e.g., for continuous fitness tracking), you must perform a two-step setup: declaring the permission in your Android manifest and requesting it via the library API.

1. Android Manifest Declaration

Add the following permission to your android/app/src/main/AndroidManifest.xml file:

<uses-permission android:name="android.permission.health.READ_HEALTH_DATA_IN_BACKGROUND"/>

2. Requesting Permission in Code

Include the BackgroundAccessPermission in your requestPermission call. You must specify the accessType as 'read' and the recordType as 'BackgroundAccessPermission'.

import { requestPermission } from 'react-native-health-connect';

const requestPermissions = () => {
  requestPermission([
    {
      accessType: 'read',
      recordType: 'BackgroundAccessPermission',
    },
    // Other permissions...
  ]).then((permissions) => {
    console.log('Granted permissions ', { permissions });
  });
};