1/** 2 * The standard Expo config object defined in `app.config.js` files. 3 */ 4export interface ExpoConfig { 5 /** 6 * The name of your app as it appears both within Expo Go and on your home screen as a standalone app. 7 */ 8 name: string; 9 /** 10 * A short description of what your app is and why it is great. 11 */ 12 description?: string; 13 /** 14 * The friendly URL name for publishing. For example, `myAppName` will refer to the `expo.dev/@project-owner/myAppName` project. 15 */ 16 slug: string; 17 /** 18 * The name of the Expo account that owns the project. This is useful for teams collaborating on a project. If not provided, the owner defaults to the username of the current user. 19 */ 20 owner?: string; 21 /** 22 * The auto generated Expo account name and slug used for display purposes. It is not meant to be set directly. Formatted like `@username/slug`. When unauthenticated, the username is `@anonymous`. For published projects, this value may change when a project is transferred between accounts or renamed. 23 */ 24 currentFullName?: string; 25 /** 26 * The auto generated Expo account name and slug used for services like Notifications and AuthSession proxy. It is not meant to be set directly. Formatted like `@username/slug`. When unauthenticated, the username is `@anonymous`. For published projects, this value will not change when a project is transferred between accounts or renamed. 27 */ 28 originalFullName?: string; 29 /** 30 * Defaults to `unlisted`. `unlisted` hides the project from search results. `hidden` restricts access to the project page to only the owner and other users that have been granted access. Valid values: `public`, `unlisted`, `hidden`. 31 */ 32 privacy?: 'public' | 'unlisted' | 'hidden'; 33 /** 34 * The Expo sdkVersion to run the project on. This should line up with the version specified in your package.json. 35 */ 36 sdkVersion?: string; 37 /** 38 * **Note: Don't use this property unless you are sure what you're doing** 39 * 40 * The runtime version associated with this manifest. 41 * Set this to `{"policy": "nativeVersion"}` to generate it automatically. 42 */ 43 runtimeVersion?: string | { 44 policy: 'nativeVersion' | 'sdkVersion' | 'appVersion' | 'fingerprintExperimental'; 45 }; 46 /** 47 * Your app version. In addition to this field, you'll also use `ios.buildNumber` and `android.versionCode` — read more about how to version your app [here](https://docs.expo.dev/distribution/app-stores/#versioning-your-app). On iOS this corresponds to `CFBundleShortVersionString`, and on Android, this corresponds to `versionName`. The required format can be found [here](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleshortversionstring). 48 */ 49 version?: string; 50 /** 51 * Platforms that your project explicitly supports. If not specified, it defaults to `["ios", "android"]`. 52 */ 53 platforms?: ('android' | 'ios' | 'web')[]; 54 /** 55 * If you would like to share the source code of your app on Github, enter the URL for the repository here and it will be linked to from your Expo project page. 56 */ 57 githubUrl?: string; 58 /** 59 * Locks your app to a specific orientation with portrait or landscape. Defaults to no lock. Valid values: `default`, `portrait`, `landscape` 60 */ 61 orientation?: 'default' | 'portrait' | 'landscape'; 62 /** 63 * Configuration to force the app to always use the light or dark user-interface appearance, such as "dark mode", or make it automatically adapt to the system preferences. If not provided, defaults to `light`. Requires `expo-system-ui` be installed in your project to work on Android. 64 */ 65 userInterfaceStyle?: 'light' | 'dark' | 'automatic'; 66 /** 67 * The background color for your app, behind any of your React views. This is also known as the root view background color. Requires `expo-system-ui` be installed in your project to work on iOS. 68 */ 69 backgroundColor?: string; 70 /** 71 * On Android, this will determine the color of your app in the multitasker. Currently this is not used on iOS, but it may be used for other purposes in the future. 72 */ 73 primaryColor?: string; 74 /** 75 * Local path or remote URL to an image to use for your app's icon. We recommend that you use a 1024x1024 png file. This icon will appear on the home screen and within the Expo app. 76 */ 77 icon?: string; 78 /** 79 * Configuration for remote (push) notifications. 80 */ 81 notification?: { 82 /** 83 * (Android only) Local path or remote URL to an image to use as the icon for push notifications. 96x96 png grayscale with transparency. We recommend following [Google's design guidelines](https://material.io/design/iconography/product-icons.html#design-principles). If not provided, defaults to your app icon. 84 */ 85 icon?: string; 86 /** 87 * (Android only) Tint color for the push notification image when it appears in the notification tray. Defaults to `#ffffff` 88 */ 89 color?: string; 90 /** 91 * Whether or not to display notifications when the app is in the foreground on iOS. `_displayInForeground` option in the individual push notification message overrides this option. [Learn more.](https://docs.expo.dev/push-notifications/receiving-notifications/#foreground-notification-behavior) Defaults to `false`. 92 */ 93 iosDisplayInForeground?: boolean; 94 /** 95 * Show each push notification individually (`default`) or collapse into one (`collapse`). 96 */ 97 androidMode?: 'default' | 'collapse'; 98 /** 99 * If `androidMode` is set to `collapse`, this title is used for the collapsed notification message. For example, `'#{unread_notifications} new interactions'`. 100 */ 101 androidCollapsedTitle?: string; 102 }; 103 /** 104 * Configuration for the status bar on Android. For more details please navigate to [Configuring StatusBar](https://docs.expo.dev/guides/configuring-statusbar/). 105 */ 106 androidStatusBar?: { 107 /** 108 * Configures the status bar icons to have a light or dark color. Valid values: `light-content`, `dark-content`. Defaults to `dark-content` 109 */ 110 barStyle?: 'light-content' | 'dark-content'; 111 /** 112 * Specifies the background color of the status bar. Defaults to `#00000000` (transparent) for `dark-content` bar style and `#00000088` (semi-transparent black) for `light-content` bar style 113 */ 114 backgroundColor?: string; 115 /** 116 * Instructs the system whether the status bar should be visible or not. Defaults to `false` 117 */ 118 hidden?: boolean; 119 /** 120 * When false, the system status bar pushes the content of your app down (similar to `position: relative`). When true, the status bar floats above the content in your app (similar to `position: absolute`). Defaults to `true` to match the iOS status bar behavior (which can only float above content). Explicitly setting this property to `true` will add `android:windowTranslucentStatus` to `styles.xml` and may cause unexpected keyboard behavior on Android when using the `softwareKeyboardLayoutMode` set to `resize`. In this case you will have to use `KeyboardAvoidingView` to manage the keyboard layout. 121 */ 122 translucent?: boolean; 123 }; 124 /** 125 * Configuration for the bottom navigation bar on Android. Can be used to configure the `expo-navigation-bar` module in EAS Build. 126 */ 127 androidNavigationBar?: { 128 /** 129 * Determines how and when the navigation bar is shown. [Learn more](https://developer.android.com/training/system-ui/immersive). Requires `expo-navigation-bar` be installed in your project. Valid values: `leanback`, `immersive`, `sticky-immersive` 130 * 131 * `leanback` results in the navigation bar being hidden until the first touch gesture is registered. 132 * 133 * `immersive` results in the navigation bar being hidden until the user swipes up from the edge where the navigation bar is hidden. 134 * 135 * `sticky-immersive` is identical to `'immersive'` except that the navigation bar will be semi-transparent and will be hidden again after a short period of time. 136 */ 137 visible?: 'leanback' | 'immersive' | 'sticky-immersive'; 138 /** 139 * Configure the navigation bar icons to have a light or dark color. Supported on Android Oreo and newer. Valid values: `'light-content'`, `'dark-content'` 140 */ 141 barStyle?: 'light-content' | 'dark-content'; 142 /** 143 * Specifies the background color of the navigation bar. 144 */ 145 backgroundColor?: string; 146 }; 147 /** 148 * Settings that apply specifically to running this app in a development client 149 */ 150 developmentClient?: { 151 /** 152 * If true, the app will launch in a development client with no additional dialogs or progress indicators, just like in a standalone app. 153 */ 154 silentLaunch?: boolean; 155 }; 156 /** 157 * URL scheme(s) to link into your app. For example, if we set this to `'demo'`, then demo:// URLs would open your app when tapped. This is a build-time configuration, it has no effect in Expo Go. 158 */ 159 scheme?: string | string[]; 160 /** 161 * Any extra fields you want to pass to your experience. Values are accessible via `Constants.expoConfig.extra` ([Learn more](https://docs.expo.dev/versions/latest/sdk/constants/#constantsmanifest)) 162 */ 163 extra?: { 164 [k: string]: any; 165 }; 166 /** 167 * @deprecated Use a `metro.config.js` file instead. [Learn more](https://docs.expo.dev/guides/customizing-metro/) 168 */ 169 packagerOpts?: { 170 [k: string]: any; 171 }; 172 /** 173 * Configuration for how and when the app should request OTA JavaScript updates 174 */ 175 updates?: { 176 /** 177 * If set to false, your standalone app will never download any code, and will only use code bundled locally on the device. In that case, all updates to your app must be submitted through app store review. Defaults to true. (Note: This will not work out of the box with ExpoKit projects) 178 */ 179 enabled?: boolean; 180 /** 181 * By default, Expo will check for updates every time the app is loaded. Set this to `ON_ERROR_RECOVERY` to disable automatic checking unless recovering from an error. Set this to `NEVER` to completely disable automatic checking. Must be one of `ON_LOAD` (default value), `ON_ERROR_RECOVERY`, `WIFI_ONLY`, or `NEVER` 182 */ 183 checkAutomatically?: 'ON_ERROR_RECOVERY' | 'ON_LOAD' | 'WIFI_ONLY' | 'NEVER'; 184 /** 185 * How long (in ms) to allow for fetching OTA updates before falling back to a cached version of the app. Defaults to 0. Must be between 0 and 300000 (5 minutes). 186 */ 187 fallbackToCacheTimeout?: number; 188 /** 189 * URL from which expo-updates will fetch update manifests 190 */ 191 url?: string; 192 /** 193 * Local path of a PEM-formatted X.509 certificate used for requiring and verifying signed Expo updates 194 */ 195 codeSigningCertificate?: string; 196 /** 197 * Metadata for `codeSigningCertificate` 198 */ 199 codeSigningMetadata?: { 200 /** 201 * Algorithm used to generate manifest code signing signature. 202 */ 203 alg?: 'rsa-v1_5-sha256'; 204 /** 205 * Identifier for the key in the certificate. Used to instruct signing mechanisms when signing or verifying signatures. 206 */ 207 keyid?: string; 208 }; 209 /** 210 * Extra HTTP headers to include in HTTP requests made by `expo-updates`. These may override preset headers. 211 */ 212 requestHeaders?: { 213 [k: string]: any; 214 }; 215 }; 216 /** 217 * Provide overrides by locale for System Dialog prompts like Permissions Boxes 218 */ 219 locales?: { 220 [k: string]: string | { 221 [k: string]: any; 222 }; 223 }; 224 /** 225 * An array of file glob strings which point to assets that will be bundled within your standalone app binary. Read more in the [Offline Support guide](https://docs.expo.dev/guides/offline-support/) 226 */ 227 assetBundlePatterns?: string[]; 228 /** 229 * Config plugins for adding extra functionality to your project. [Learn more](https://docs.expo.dev/guides/config-plugins/). 230 */ 231 plugins?: (string | [] | [string] | [string, any])[]; 232 splash?: Splash; 233 /** 234 * Specifies the JavaScript engine for apps. Supported only on EAS Build. Defaults to `hermes`. Valid values: `hermes`, `jsc`. 235 */ 236 jsEngine?: 'hermes' | 'jsc'; 237 ios?: IOS; 238 android?: Android; 239 web?: Web; 240 /** 241 * Configuration for scripts to run to hook into the publish process 242 */ 243 hooks?: { 244 postPublish?: PublishHook[]; 245 postExport?: PublishHook[]; 246 }; 247 /** 248 * Enable experimental features that may be unstable, unsupported, or removed without deprecation notices. 249 */ 250 experiments?: { 251 /** 252 * Export a website relative to a subpath of a domain. The path will be prepended as-is to links to all bundled resources. Prefix the path with a `/` (recommended) to load all resources relative to the server root. If the path **does not** start with a `/` then resources will be loaded relative to the code that requests them, this could lead to unexpected behavior. Example '/subpath'. Defaults to '' (empty string). 253 */ 254 basePath?: string; 255 /** 256 * If true, indicates that this project does not support tablets or handsets, and only supports Apple TV and Android TV 257 */ 258 supportsTVOnly?: boolean; 259 /** 260 * Enable tsconfig/jsconfig `compilerOptions.paths` and `compilerOptions.baseUrl` support for import aliases in Metro. 261 */ 262 tsconfigPaths?: boolean; 263 /** 264 * Enable support for statically typed links in Expo Router. This feature requires TypeScript be set up in your Expo Router v2 project. 265 */ 266 typedRoutes?: boolean; 267 /** 268 * Enables Turbo Modules, which are a type of native modules that use a different way of communicating between JS and platform code. When installing a Turbo Module you will need to enable this experimental option (the library still needs to be a part of Expo SDK already, like react-native-reanimated v2). Turbo Modules do not support remote debugging and enabling this option will disable remote debugging. 269 */ 270 turboModules?: boolean; 271 }; 272 /** 273 * Internal properties for developer tools 274 */ 275 _internal?: { 276 /** 277 * List of plugins already run on the config 278 */ 279 pluginHistory?: { 280 [k: string]: any; 281 }; 282 [k: string]: any; 283 }; 284} 285/** 286 * Configuration for loading and splash screen for standalone apps. 287 */ 288export interface Splash { 289 /** 290 * Color to fill the loading screen background 291 */ 292 backgroundColor?: string; 293 /** 294 * Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`. 295 */ 296 resizeMode?: 'cover' | 'contain'; 297 /** 298 * Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png. 299 */ 300 image?: string; 301 [k: string]: any; 302} 303/** 304 * Configuration that is specific to the iOS platform. 305 */ 306export interface IOS { 307 /** 308 * The manifest for the iOS version of your app will be written to this path during publish. 309 */ 310 publishManifestPath?: string; 311 /** 312 * The bundle for the iOS version of your app will be written to this path during publish. 313 */ 314 publishBundlePath?: string; 315 /** 316 * The bundle identifier for your iOS standalone app. You make it up, but it needs to be unique on the App Store. See [this StackOverflow question](http://stackoverflow.com/questions/11347470/what-does-bundle-identifier-mean-in-the-ios-project). 317 */ 318 bundleIdentifier?: string; 319 /** 320 * Build number for your iOS standalone app. Corresponds to `CFBundleVersion` and must match Apple's [specified format](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleversion). (Note: Transporter will pull the value for `Version Number` from `expo.version` and NOT from `expo.ios.buildNumber`.) 321 */ 322 buildNumber?: string; 323 /** 324 * The background color for your iOS app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present. Requires `expo-system-ui` be installed in your project to work on iOS. 325 */ 326 backgroundColor?: string; 327 /** 328 * Local path or remote URL to an image to use for your app's icon on iOS. If specified, this overrides the top-level `icon` key. Use a 1024x1024 icon which follows Apple's interface guidelines for icons, including color profile and transparency. 329 * 330 * Expo will generate the other required sizes. This icon will appear on the home screen and within the Expo app. 331 */ 332 icon?: string; 333 /** 334 * URL to your app on the Apple App Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public. 335 */ 336 appStoreUrl?: string; 337 /** 338 * Enable iOS Bitcode optimizations in the native build. Accepts the name of an iOS build configuration to enable for a single configuration and disable for all others, e.g. Debug, Release. Not available in Expo Go. Defaults to `undefined` which uses the template's predefined settings. 339 */ 340 bitcode?: boolean | string; 341 /** 342 * Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private. 343 */ 344 config?: { 345 /** 346 * [Branch](https://branch.io/) key to hook up Branch linking services. 347 */ 348 branch?: { 349 /** 350 * Your Branch API key 351 */ 352 apiKey?: string; 353 }; 354 /** 355 * Sets `ITSAppUsesNonExemptEncryption` in the standalone ipa's Info.plist to the given boolean value. 356 */ 357 usesNonExemptEncryption?: boolean; 358 /** 359 * [Google Maps iOS SDK](https://developers.google.com/maps/documentation/ios-sdk/start) key for your standalone app. 360 */ 361 googleMapsApiKey?: string; 362 /** 363 * [Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID. 364 */ 365 googleMobileAdsAppId?: string; 366 /** 367 * A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Go and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`.](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional) 368 */ 369 googleMobileAdsAutoInit?: boolean; 370 }; 371 /** 372 * [Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase. 373 */ 374 googleServicesFile?: string; 375 /** 376 * Whether your standalone iOS app supports tablet screen sizes. Defaults to `false`. 377 */ 378 supportsTablet?: boolean; 379 /** 380 * If true, indicates that your standalone iOS app does not support handsets, and only supports tablets. 381 */ 382 isTabletOnly?: boolean; 383 /** 384 * If true, indicates that your standalone iOS app does not support Slide Over and Split View on iPad. Defaults to `false` 385 */ 386 requireFullScreen?: boolean; 387 /** 388 * Configuration to force the app to always use the light or dark user-interface appearance, such as "dark mode", or make it automatically adapt to the system preferences. If not provided, defaults to `light`. 389 */ 390 userInterfaceStyle?: 'light' | 'dark' | 'automatic'; 391 /** 392 * Dictionary of arbitrary configuration to add to your standalone app's native Info.plist. Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store. 393 */ 394 infoPlist?: { 395 [k: string]: any; 396 }; 397 /** 398 * Dictionary of arbitrary configuration to add to your standalone app's native *.entitlements (plist). Applied prior to all other Expo-specific configuration. No other validation is performed, so use this at your own risk of rejection from the App Store. 399 */ 400 entitlements?: { 401 [k: string]: any; 402 }; 403 /** 404 * An array that contains Associated Domains for the standalone app. [Learn more](https://developer.apple.com/documentation/safariservices/supporting_associated_domains). 405 */ 406 associatedDomains?: string[]; 407 /** 408 * A boolean indicating if the app uses iCloud Storage for `DocumentPicker`. See `DocumentPicker` docs for details. 409 */ 410 usesIcloudStorage?: boolean; 411 /** 412 * A boolean indicating if the app uses Apple Sign-In. See `AppleAuthentication` docs for details. 413 */ 414 usesAppleSignIn?: boolean; 415 /** 416 * A Boolean value that indicates whether the app may access the notes stored in contacts. You must [receive permission from Apple](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_contacts_notes) before you can submit your app for review with this capability. 417 */ 418 accessesContactNotes?: boolean; 419 /** 420 * Configuration for loading and splash screen for standalone iOS apps. 421 */ 422 splash?: { 423 /** 424 * Color to fill the loading screen background 425 */ 426 backgroundColor?: string; 427 /** 428 * Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`. 429 */ 430 resizeMode?: 'cover' | 'contain'; 431 /** 432 * Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png. 433 */ 434 image?: string; 435 /** 436 * Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png. 437 */ 438 tabletImage?: string; 439 /** 440 * Configuration for loading and splash screen for standalone iOS apps in dark mode. 441 */ 442 dark?: { 443 /** 444 * Color to fill the loading screen background 445 */ 446 backgroundColor?: string; 447 /** 448 * Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`. 449 */ 450 resizeMode?: 'cover' | 'contain'; 451 /** 452 * Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png. 453 */ 454 image?: string; 455 /** 456 * Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png. 457 */ 458 tabletImage?: string; 459 [k: string]: any; 460 }; 461 [k: string]: any; 462 }; 463 /** 464 * Specifies the JavaScript engine for iOS apps. Supported only on EAS Build. Defaults to `hermes`. Valid values: `hermes`, `jsc`. 465 */ 466 jsEngine?: 'hermes' | 'jsc'; 467 /** 468 * **Note: Don't use this property unless you are sure what you're doing** 469 * 470 * The runtime version associated with this manifest for the iOS platform. If provided, this will override the top level runtimeVersion key. 471 * Set this to `{"policy": "nativeVersion"}` to generate it automatically. 472 */ 473 runtimeVersion?: string | { 474 policy: 'nativeVersion' | 'sdkVersion' | 'appVersion' | 'fingerprintExperimental'; 475 }; 476} 477/** 478 * Configuration that is specific to the Android platform. 479 */ 480export interface Android { 481 /** 482 * The manifest for the Android version of your app will be written to this path during publish. 483 */ 484 publishManifestPath?: string; 485 /** 486 * The bundle for the Android version of your app will be written to this path during publish. 487 */ 488 publishBundlePath?: string; 489 /** 490 * The package name for your Android standalone app. You make it up, but it needs to be unique on the Play Store. See [this StackOverflow question](http://stackoverflow.com/questions/6273892/android-package-name-convention). 491 */ 492 package?: string; 493 /** 494 * Version number required by Google Play. Increment by one for each release. Must be a positive integer. [Learn more](https://developer.android.com/studio/publish/versioning.html) 495 */ 496 versionCode?: number; 497 /** 498 * The background color for your Android app, behind any of your React views. Overrides the top-level `backgroundColor` key if it is present. 499 */ 500 backgroundColor?: string; 501 /** 502 * Configuration to force the app to always use the light or dark user-interface appearance, such as "dark mode", or make it automatically adapt to the system preferences. If not provided, defaults to `light`. Requires `expo-system-ui` be installed in your project to work on Android. 503 */ 504 userInterfaceStyle?: 'light' | 'dark' | 'automatic'; 505 /** 506 * Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` key. We recommend that you use a 1024x1024 png file (transparency is recommended for the Google Play Store). This icon will appear on the home screen and within the Expo app. 507 */ 508 icon?: string; 509 /** 510 * Settings for an Adaptive Launcher Icon on Android. [Learn more](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive) 511 */ 512 adaptiveIcon?: { 513 /** 514 * Local path or remote URL to an image to use for your app's icon on Android. If specified, this overrides the top-level `icon` and the `android.icon` keys. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive). This icon will appear on the home screen. 515 */ 516 foregroundImage?: string; 517 /** 518 * Local path or remote URL to an image representing the Android 13+ monochromatic icon. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive). This icon will appear on the home screen when the user enables 'Themed icons' in system settings on a device running Android 13+. 519 */ 520 monochromeImage?: string; 521 /** 522 * Local path or remote URL to a background image for your app's Adaptive Icon on Android. If specified, this overrides the `backgroundColor` key. Must have the same dimensions as `foregroundImage`, and has no effect if `foregroundImage` is not specified. Should follow the [specified guidelines](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive). 523 */ 524 backgroundImage?: string; 525 /** 526 * Color to use as the background for your app's Adaptive Icon on Android. Defaults to white, `#FFFFFF`. Has no effect if `foregroundImage` is not specified. 527 */ 528 backgroundColor?: string; 529 }; 530 /** 531 * URL to your app on the Google Play Store, if you have deployed it there. This is used to link to your store page from your Expo project page if your app is public. 532 */ 533 playStoreUrl?: string; 534 /** 535 * List of permissions used by the standalone app. 536 * 537 * To use ONLY the following minimum necessary permissions and none of the extras supported by Expo in a default managed app, set `permissions` to `[]`. The minimum necessary permissions do not require a Privacy Policy when uploading to Google Play Store and are: 538 * • receive data from Internet 539 * • view network connections 540 * • full network access 541 * • change your audio settings 542 * • prevent device from sleeping 543 * 544 * To use ALL permissions supported by Expo by default, do not specify the `permissions` key. 545 * 546 * To use the minimum necessary permissions ALONG with certain additional permissions, specify those extras in `permissions`, e.g. 547 * 548 * `[ "CAMERA", "ACCESS_FINE_LOCATION" ]`. 549 * 550 * You can specify the following permissions depending on what you need: 551 * 552 * - `ACCESS_COARSE_LOCATION` 553 * - `ACCESS_FINE_LOCATION` 554 * - `ACCESS_BACKGROUND_LOCATION` 555 * - `CAMERA` 556 * - `RECORD_AUDIO` 557 * - `READ_CONTACTS` 558 * - `WRITE_CONTACTS` 559 * - `READ_CALENDAR` 560 * - `WRITE_CALENDAR` 561 * - `READ_EXTERNAL_STORAGE` 562 * - `WRITE_EXTERNAL_STORAGE` 563 * - `USE_FINGERPRINT` 564 * - `USE_BIOMETRIC` 565 * - `WRITE_SETTINGS` 566 * - `VIBRATE` 567 * - `READ_PHONE_STATE` 568 * - `FOREGROUND_SERVICE` 569 * - `WAKE_LOCK` 570 * - `com.anddoes.launcher.permission.UPDATE_COUNT` 571 * - `com.android.launcher.permission.INSTALL_SHORTCUT` 572 * - `com.google.android.c2dm.permission.RECEIVE` 573 * - `com.google.android.gms.permission.ACTIVITY_RECOGNITION` 574 * - `com.google.android.providers.gsf.permission.READ_GSERVICES` 575 * - `com.htc.launcher.permission.READ_SETTINGS` 576 * - `com.htc.launcher.permission.UPDATE_SHORTCUT` 577 * - `com.majeur.launcher.permission.UPDATE_BADGE` 578 * - `com.sec.android.provider.badge.permission.READ` 579 * - `com.sec.android.provider.badge.permission.WRITE` 580 * - `com.sonyericsson.home.permission.BROADCAST_BADGE` 581 * 582 */ 583 permissions?: string[]; 584 /** 585 * List of permissions to block in the final `AndroidManifest.xml`. This is useful for removing permissions that are added by native package `AndroidManifest.xml` files which are merged into the final manifest. Internally this feature uses the `tools:node="remove"` XML attribute to remove permissions. Not available in Expo Go. 586 */ 587 blockedPermissions?: string[]; 588 /** 589 * [Firebase Configuration File](https://support.google.com/firebase/answer/7015592) Location of the `GoogleService-Info.plist` file for configuring Firebase. Including this key automatically enables FCM in your standalone app. 590 */ 591 googleServicesFile?: string; 592 /** 593 * Note: This property key is not included in the production manifest and will evaluate to `undefined`. It is used internally only in the build process, because it contains API keys that some may want to keep private. 594 */ 595 config?: { 596 /** 597 * [Branch](https://branch.io/) key to hook up Branch linking services. 598 */ 599 branch?: { 600 /** 601 * Your Branch API key 602 */ 603 apiKey?: string; 604 }; 605 /** 606 * [Google Maps Android SDK](https://developers.google.com/maps/documentation/android-api/signup) configuration for your standalone app. 607 */ 608 googleMaps?: { 609 /** 610 * Your Google Maps Android SDK API key 611 */ 612 apiKey?: string; 613 }; 614 /** 615 * [Google Mobile Ads App ID](https://support.google.com/admob/answer/6232340) Google AdMob App ID. 616 */ 617 googleMobileAdsAppId?: string; 618 /** 619 * A boolean indicating whether to initialize Google App Measurement and begin sending user-level event data to Google immediately when the app starts. The default in Expo (Client and in standalone apps) is `false`. [Sets the opposite of the given value to the following key in `Info.plist`](https://developers.google.com/admob/ios/eu-consent#delay_app_measurement_optional) 620 */ 621 googleMobileAdsAutoInit?: boolean; 622 }; 623 /** 624 * Configuration for loading and splash screen for managed and standalone Android apps. 625 */ 626 splash?: { 627 /** 628 * Color to fill the loading screen background 629 */ 630 backgroundColor?: string; 631 /** 632 * Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover`, `contain` or `native`, defaults to `contain`. 633 */ 634 resizeMode?: 'cover' | 'contain' | 'native'; 635 /** 636 * Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png. 637 */ 638 image?: string; 639 /** 640 * Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) 641 * 642 * `Natural sized image (baseline)` 643 */ 644 mdpi?: string; 645 /** 646 * Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) 647 * 648 * `Scale 1.5x` 649 */ 650 hdpi?: string; 651 /** 652 * Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) 653 * 654 * `Scale 2x` 655 */ 656 xhdpi?: string; 657 /** 658 * Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) 659 * 660 * `Scale 3x` 661 */ 662 xxhdpi?: string; 663 /** 664 * Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) 665 * 666 * `Scale 4x` 667 */ 668 xxxhdpi?: string; 669 /** 670 * Configuration for loading and splash screen for managed and standalone Android apps in dark mode. 671 */ 672 dark?: { 673 /** 674 * Color to fill the loading screen background 675 */ 676 backgroundColor?: string; 677 /** 678 * Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover`, `contain` or `native`, defaults to `contain`. 679 */ 680 resizeMode?: 'cover' | 'contain' | 'native'; 681 /** 682 * Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png. 683 */ 684 image?: string; 685 /** 686 * Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) 687 * 688 * `Natural sized image (baseline)` 689 */ 690 mdpi?: string; 691 /** 692 * Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) 693 * 694 * `Scale 1.5x` 695 */ 696 hdpi?: string; 697 /** 698 * Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) 699 * 700 * `Scale 2x` 701 */ 702 xhdpi?: string; 703 /** 704 * Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) 705 * 706 * `Scale 3x` 707 */ 708 xxhdpi?: string; 709 /** 710 * Local path or remote URL to an image to fill the background of the loading screen in "native" mode. Image size and aspect ratio are up to you. [Learn more]( https://developer.android.com/training/multiscreen/screendensities) 711 * 712 * `Scale 4x` 713 */ 714 xxxhdpi?: string; 715 [k: string]: any; 716 }; 717 [k: string]: any; 718 }; 719 /** 720 * Configuration for setting an array of custom intent filters in Android manifest. [Learn more](https://developer.android.com/guide/components/intents-filters) 721 */ 722 intentFilters?: { 723 /** 724 * You may also use an intent filter to set your app as the default handler for links (without showing the user a dialog with options). To do so use `true` and then configure your server to serve a JSON file verifying that you own the domain. [Learn more](https://developer.android.com/training/app-links) 725 */ 726 autoVerify?: boolean; 727 action: string; 728 data?: AndroidIntentFiltersData | AndroidIntentFiltersData[]; 729 category?: string | string[]; 730 }[]; 731 /** 732 * Allows your user's app data to be automatically backed up to their Google Drive. If this is set to false, no backup or restore of the application will ever be performed (this is useful if your app deals with sensitive information). Defaults to the Android default, which is `true`. 733 */ 734 allowBackup?: boolean; 735 /** 736 * Determines how the software keyboard will impact the layout of your application. This maps to the `android:windowSoftInputMode` property. Defaults to `resize`. Valid values: `resize`, `pan`. 737 */ 738 softwareKeyboardLayoutMode?: 'resize' | 'pan'; 739 /** 740 * Specifies the JavaScript engine for Android apps. Supported only on EAS Build and in Expo Go. Defaults to `hermes`. Valid values: `hermes`, `jsc`. 741 */ 742 jsEngine?: 'hermes' | 'jsc'; 743 /** 744 * **Note: Don't use this property unless you are sure what you're doing** 745 * 746 * The runtime version associated with this manifest for the Android platform. If provided, this will override the top level runtimeVersion key. 747 * Set this to `{"policy": "nativeVersion"}` to generate it automatically. 748 */ 749 runtimeVersion?: string | { 750 policy: 'nativeVersion' | 'sdkVersion' | 'appVersion' | 'fingerprintExperimental'; 751 }; 752} 753export interface AndroidIntentFiltersData { 754 /** 755 * Scheme of the URL, e.g. `https` 756 */ 757 scheme?: string; 758 /** 759 * Hostname, e.g. `myapp.io` 760 */ 761 host?: string; 762 /** 763 * Port, e.g. `3000` 764 */ 765 port?: string; 766 /** 767 * Exact path for URLs that should be matched by the filter, e.g. `/records` 768 */ 769 path?: string; 770 /** 771 * Pattern for paths that should be matched by the filter, e.g. `.*`. Must begin with `/` 772 */ 773 pathPattern?: string; 774 /** 775 * Prefix for paths that should be matched by the filter, e.g. `/records/` will match `/records/123` 776 */ 777 pathPrefix?: string; 778 /** 779 * MIME type for URLs that should be matched by the filter 780 */ 781 mimeType?: string; 782} 783/** 784 * Configuration that is specific to the web platform. 785 */ 786export interface Web { 787 /** 788 * Sets the rendering method for the web app for both `expo start` and `expo export`. `static` statically renders HTML files for every route in the `app/` directory, which is available only in Expo Router apps. `single` outputs a Single Page Application (SPA), with a single `index.html` in the output folder, and has no statically indexable HTML. Defaults to `single`. 789 */ 790 output?: 'single' | 'static'; 791 /** 792 * Relative path of an image to use for your app's favicon. 793 */ 794 favicon?: string; 795 /** 796 * Defines the title of the document, defaults to the outer level name 797 */ 798 name?: string; 799 /** 800 * A short version of the app's name, 12 characters or fewer. Used in app launcher and new tab pages. Maps to `short_name` in the PWA manifest.json. Defaults to the `name` property. 801 */ 802 shortName?: string; 803 /** 804 * Specifies the primary language for the values in the name and short_name members. This value is a string containing a single language tag. 805 */ 806 lang?: string; 807 /** 808 * Defines the navigation scope of this website's context. This restricts what web pages can be viewed while the manifest is applied. If the user navigates outside the scope, it returns to a normal web page inside a browser tab/window. If the scope is a relative URL, the base URL will be the URL of the manifest. 809 */ 810 scope?: string; 811 /** 812 * Defines the color of the Android tool bar, and may be reflected in the app's preview in task switchers. 813 */ 814 themeColor?: string; 815 /** 816 * Provides a general description of what the pinned website does. 817 */ 818 description?: string; 819 /** 820 * Specifies the primary text direction for the name, short_name, and description members. Together with the lang member, it helps the correct display of right-to-left languages. 821 */ 822 dir?: 'auto' | 'ltr' | 'rtl'; 823 /** 824 * Defines the developers’ preferred display mode for the website. 825 */ 826 display?: 'fullscreen' | 'standalone' | 'minimal-ui' | 'browser'; 827 /** 828 * The URL that loads when a user launches the application (e.g., when added to home screen), typically the index. Note: This has to be a relative URL, relative to the manifest URL. 829 */ 830 startUrl?: string; 831 /** 832 * Defines the default orientation for all the website's top level browsing contexts. 833 */ 834 orientation?: 'any' | 'natural' | 'landscape' | 'landscape-primary' | 'landscape-secondary' | 'portrait' | 'portrait-primary' | 'portrait-secondary'; 835 /** 836 * Defines the expected “background color” for the website. This value repeats what is already available in the site’s CSS, but can be used by browsers to draw the background color of a shortcut when the manifest is available before the stylesheet has loaded. This creates a smooth transition between launching the web application and loading the site's content. 837 */ 838 backgroundColor?: string; 839 /** 840 * If content is set to default, the status bar appears normal. If set to black, the status bar has a black background. If set to black-translucent, the status bar is black and translucent. If set to default or black, the web content is displayed below the status bar. If set to black-translucent, the web content is displayed on the entire screen, partially obscured by the status bar. 841 */ 842 barStyle?: 'default' | 'black' | 'black-translucent'; 843 /** 844 * Hints for the user agent to indicate to the user that the specified native applications (defined in expo.ios and expo.android) are recommended over the website. 845 */ 846 preferRelatedApplications?: boolean; 847 /** 848 * Experimental features. These will break without deprecation notice. 849 */ 850 dangerous?: { 851 [k: string]: any; 852 }; 853 /** 854 * Configuration for PWA splash screens. 855 */ 856 splash?: { 857 /** 858 * Color to fill the loading screen background 859 */ 860 backgroundColor?: string; 861 /** 862 * Determines how the `image` will be displayed in the splash loading screen. Must be one of `cover` or `contain`, defaults to `contain`. 863 */ 864 resizeMode?: 'cover' | 'contain'; 865 /** 866 * Local path or remote URL to an image to fill the background of the loading screen. Image size and aspect ratio are up to you. Must be a .png. 867 */ 868 image?: string; 869 [k: string]: any; 870 }; 871 /** 872 * Firebase web configuration. Used by the expo-firebase packages on both web and native. [Learn more](https://firebase.google.com/docs/reference/js/firebase.html#initializeapp) 873 */ 874 config?: { 875 firebase?: { 876 apiKey?: string; 877 authDomain?: string; 878 databaseURL?: string; 879 projectId?: string; 880 storageBucket?: string; 881 messagingSenderId?: string; 882 appId?: string; 883 measurementId?: string; 884 [k: string]: any; 885 }; 886 [k: string]: any; 887 }; 888 /** 889 * Sets the bundler to use for the web platform. Only supported in the local CLI `npx expo`. 890 */ 891 bundler?: 'webpack' | 'metro'; 892 [k: string]: any; 893} 894export interface PublishHook { 895 file?: string; 896 config?: { 897 [k: string]: any; 898 }; 899 [k: string]: any; 900} 901