@unimodules/core

@unimodules/core

This library contains the core Unimodule infrastructure and a collection of Unimodules and interfaces that are commonly depended on by other Unimodules. You will need to install this before using libraries from Foundation, like expo-camera, expo-media-library, and others.

Installation

The easiest way to do this is to initialize a "custom" project with expo-cli. If you have an existing app, you can follow these steps instead. This project requires that you use Cocoapods on iOS, to set iot up see this gist, or relevant parts of the this guide.

Install the package

npm install @unimodules/core

Configure iOS

• Go back to the ios directory and open your Podfile, make your Podfile look like this one.
  • If you need to customize the path to node_modules, for example because you are using yarn workspaces, then you can pass in a param for this: use_unimodules!(node_modules_path: '../../../node_modules')
• Run pod install again
• Update your AppDelegate.h and AppDelegate.m according to this diff.

Add permission usage description keys to Info.plist

In order to submit your app to the App Store, you will need to eventually add these keys to your Info.plist. Even if you don't use the APIs described, you need to include the keys because code related to asking the permission will be bundled regardless, and Apple's static analysis tools will detect it and reject your app if the key isn't present. Including the key without using it has no impact to your users. Replace (YOUR APP NAME) with your app name below.

<key>NSCalendarsUsageDescription</key>
<string>Allow (YOUR APP NAME) to access your calendar</string>
<key>NSCameraUsageDescription</key>
<string>Allow (YOUR APP NAME) to use the camera</string>
<key>NSContactsUsageDescription</key>
<string>Allow (YOUR APP NAME) experiences to access your contacts</string>
<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>Allow (YOUR APP NAME) to use your location</string>
<key>NSLocationAlwaysUsageDescription</key>
<string>Allow (YOUR APP NAME) to use your location</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>Allow (YOUR APP NAME) to use your location</string>
<key>NSMicrophoneUsageDescription</key>
<string>Allow (YOUR APP NAME) to access your microphone</string>
<key>NSMotionUsageDescription</key>
<string>Allow (YOUR APP NAME) to access your device's accelerometer</string>
<key>NSPhotoLibraryAddUsageDescription</key>
<string>Give (YOUR APP NAME) periences permission to save photos</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>Give (YOUR APP NAME) periences permission to access your photos</string>
<key>NSRemindersUsageDescription</key>
<string>Allow (YOUR APP NAME) to access your reminders</string>

Configure Android

• Add apply from: '../node_modules/@unimodules/core/settings.gradle' and then useUnimodules.apply() to the top of android/settings.gradle
  • If you need to customize the path to node_modules, for example because you are using yarn workspaces, then you can pass in a param for this: useUnimodules.apply(nodeModulesPath: "../../../node_modules")
• Add apply from: '../../node_modules/@unimodules/core/build.gradle' anywhere in android/app/build.gradle
• Update minSdkVersion in android/build.gradle to 21
• Update your MainApplication.java to according to this diff.

API

It's possible that you will not have to use any of the code provided by this package directly, it may be used only by other Unimodules that you install.

But it's likely that you will want to use something like FileSystem or Permissions, and to do that you can import the following modules like so:

import {
  Asset,
  Constants,
  FileSystem,
  Permissions,
} from '@unimodules/core';

You can import them directly from the specific Unimodule packag if you like, but your linter may complain for import a transitive dependency.

import * as Permissions from 'expo-permissions';