Reference version

Expo Constants

GitHub

npm

An API that provides system information that remains constant throughout the lifetime of your app's installation.

Android
iOS
tvOS
Web

expo-constants provides system information that remains constant throughout the lifetime of your app's installation.

Installation

Terminal
npx expo install expo-constants

If you are installing this in an existing React Native app (bare workflow), start by installing expo in your project. Then, follow the additional instructions as mentioned by library's README under "Installation in bare React Native projects" section.

API

import Constants from 'expo-constants';

Interfaces

AndroidManifest

AndroidManifest Properties

NameTypeDescription
versionCodenumber

Deprecated Use expo-application's Application.nativeBuildVersion.

The version code set by android.versionCode in app.json. The value is set to null in case you run your app in Expo Go.


IOSManifest

IOSManifest Properties

NameTypeDescription
buildNumbernull | string

The build number specified in the embedded Info.plist value for CFBundleVersion in this app. In a standalone app, you can set this with the ios.buildNumber value in app.json. This may differ from the value in Constants.expoConfig.ios.buildNumber because the manifest can be updated, whereas this value will never change for a given native binary. The value is set to null in case you run your app in Expo Go.

modelnull | string

Deprecated Moved to expo-device as Device.modelName.

The human-readable model name of this device, e.g. "iPhone 7 Plus" if it can be determined, otherwise will be null.

platformstring

Deprecated Use expo-device's Device.modelId.

The Apple internal model identifier for this device, e.g. iPhone1,1.

systemVersionstring

Deprecated Use expo-device's Device.osVersion.

The version of iOS running on this device, e.g. 10.3.

userInterfaceIdiomUserInterfaceIdiom

Deprecated Use expo-device's Device.getDeviceTypeAsync().

The user interface idiom of this device, i.e. whether the app is running on an iPhone, iPad, Mac or Apple TV.


NativeConstants

NativeConstants Properties

NameTypeDescription
appOwnershipnull | Expo

Returns expo when running in Expo Go, otherwise null.

debugModeboolean-
deviceName
(optional)
string

A human-readable name for the device type.

deviceYearClassnull | number

Deprecated Moved to expo-device as Device.deviceYearClass.

The device year class of this device.

easConfignull | EASConfig

The standard EAS config object populated when using EAS.

executionEnvironmentExecutionEnvironment-
experienceUrlstring-
expoConfignull | ExpoConfig & { hostUri: string }

The standard Expo config object defined in app.json and app.config.js files. For both classic and modern manifests, whether they are embedded or remote.

expoGoConfignull | ExpoGoConfig

The standard Expo Go config object populated when running in Expo Go.

expoRuntimeVersionnull | string-
expoVersionnull | string

The version string of the Expo Go app currently running. Returns null in bare workflow and web.

getWebViewUserAgentAsync() => Promise<null | string>

Gets the user agent string which would be included in requests sent by a web view running on this device. This is probably not the same user agent you might be providing in your JS fetch requests.

intentUri
(optional)
string-
isDetached
(optional)
boolean-
isHeadlessboolean-
linkingUristring-
manifest2null | ExpoUpdatesManifest

Manifest for Expo apps using modern Expo Updates from a remote source, such as apps that use EAS Update. Constants.expoConfig should be used for accessing the Expo config object.

platform
(optional)
PlatformManifest-
sessionIdstring

A string that is unique to the current session of your app. It is different across apps and across multiple launches of the same app.

statusBarHeightnumber

The default status bar height for the device. Does not factor in changes when location tracking is in use or a phone call is active.

systemFontsstring[]

A list of the system font names available on the current device.

systemVersion
(optional)
number-

PlatformManifest

PlatformManifest Properties

NameTypeDescription
android
(optional)
AndroidManifest-
detach
(optional)
{ scheme: string }-
developer
(optional)
string-
hostUri
(optional)
string-
ios
(optional)
IOSManifest-
scheme
(optional)
string-
web
(optional)
WebManifest-

Types

ClientScopingConfig

Type: ClientScopingConfigForReExport

EASConfig

Type: ManifestsEASConfig

ExpoGoConfig

Type: ManifestsExpoGoConfig

ExpoGoPackagerOpts

Type: ExpoGoPackagerOptsForReExport

Manifest

Type: ExpoUpdatesManifest

ManifestAsset

Type: ManifestAssetForReExport

ManifestExtra

Type: ManifestExtraForReExport

Enums

AppOwnership

AppOwnership Values

Expo

AppOwnership.Expo = "expo"

The experience is running inside of the Expo Go app.

ExecutionEnvironment

ExecutionEnvironment Values

Bare

ExecutionEnvironment.Bare = "bare"

Standalone

ExecutionEnvironment.Standalone = "standalone"

StoreClient

ExecutionEnvironment.StoreClient = "storeClient"

UserInterfaceIdiom

Current supported values are handset, tablet, desktop and tv. CarPlay will show up as unsupported.

UserInterfaceIdiom Values

Desktop

UserInterfaceIdiom.Desktop = "desktop"

Handset

UserInterfaceIdiom.Handset = "handset"

Tablet

UserInterfaceIdiom.Tablet = "tablet"

TV

UserInterfaceIdiom.TV = "tv"

Unsupported

UserInterfaceIdiom.Unsupported = "unsupported"