Expo

Get Started
API Reference

ImagePicker

expo-image-picker provides access to the system's UI for selecting images and videos from the phone's library or taking a photo with the camera.

Platform Compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb

Installation

expo install expo-image-picker

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

You can configure expo-image-picker using its built-in config plugin if you use config plugins in your project (EAS Build or expo run:[android|ios]). The plugin allows you to configure various properties that cannot be set at runtime and require building a new app binary to take effect.
Are you using the classic build system? (expo build:[android|ios])
Are you using this library in a bare React Native app?
Learn how to configure the native projects in the installation instructions in the expo-image-picker repository.

{
  "expo": {
    "plugins": [
      [
        "expo-image-picker",
        {
          "photosPermission": "The app accesses your photos to let you share them with your friends."
        }
      ]
    ]
  }
}

NameDefaultDescription
photosPermission"Allow $(PRODUCT_NAME) to access your photos"iOS only A string to set the NSPhotoLibraryUsageDescription permission message.
cameraPermission"Allow $(PRODUCT_NAME) to access your camera"iOS only A string to set the NSCameraUsageDescription permission message.
microphonePermission"Allow $(PRODUCT_NAME) to access your microphone"iOS only A string to set the NSMicrophoneUsageDescription permission message.

import React, { useState, useEffect } from 'react';
import { Button, Image, View, Platform } from 'react-native';
import * as ImagePicker from 'expo-image-picker';

export default function ImagePickerExample() {
  const [image, setImage] = useState(null);

  const pickImage = async () => {
    // No permissions request is necessary for launching the image library
    let result = await ImagePicker.launchImageLibraryAsync({
      mediaTypes: ImagePicker.MediaTypeOptions.All,
      allowsEditing: true,
      aspect: [4, 3],
      quality: 1,
    });

    console.log(result);

    if (!result.cancelled) {
      setImage(result.uri);
    }
  };

  return (
    <View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
      <Button title="Pick an image from camera roll" onPress={pickImage} />
      {image && <Image source={{ uri: image }} style={{ width: 200, height: 200 }} />}
    </View>
  );
}
When you run this example and pick an image, you will see the image that you picked show up in your app, and something similar to the following logged to your console:
{
  "cancelled":false,
  "height":1611,
  "width":2148,
  "uri":"file:///data/user/0/host.exp.exponent/cache/cropped1814158652.jpg"
}

Please refer to the with-aws-storage-upload example. Follow Amplify docs to set your project up correctly.

Please refer to the with-firebase-storage-upload example. Make sure you follow the "Using Firebase" docs to set your project up correctly.

import * as ImagePicker from 'expo-image-picker';

  • options? (PermissionHookOptions<object>)

Check or request permissions to access the camera. This uses both requestCameraPermissionsAsync and getCameraPermissionsAsync to interact with the permissions.

Example

const [status, requestPermission] = ImagePicker.useCameraPermissions();

  • [null | PermissionResponse, RequestPermissionMethod<PermissionResponse>, GetPermissionMethod<PermissionResponse>]

Check or request permissions to access the media library. This uses both requestMediaLibraryPermissionsAsync and getMediaLibraryPermissionsAsync to interact with the permissions.

Example

const [status, requestPermission] = ImagePicker.useMediaLibraryPermissions();

Checks user's permissions for accessing camera.

A promise that fulfills with an object of type CameraPermissionResponse.


Deprecated. Use getMediaLibraryPermissionsAsync() instead.

  • writeOnly (boolean) - Whether to request write or read and write permissions. Defaults to false

Checks user's permissions for accessing photos.

A promise that fulfills with an object of type MediaLibraryPermissionResponse.


Android system sometimes kills the MainActivity after the ImagePicker finishes. When this happens, we lost the data selected from the ImagePicker. However, you can retrieve the lost data by calling getPendingResultAsync. You can test this functionality by turning on Don't keep activities in the developer options.

  • On Android: a promise that resolves to an array of objects of exactly same type as in ImagePicker.launchImageLibraryAsync or ImagePicker.launchCameraAsync if the ImagePicker finished successfully. Otherwise, to the array of ImagePickerErrorResult.
  • On other platforms: an empty array.

Display the system UI for taking a photo with the camera. Requires Permissions.CAMERA. On Android and iOS 10 Permissions.CAMERA_ROLL is also required. On mobile web, this must be called immediately in a user interaction like a button press, otherwise the browser will bloc the request without a warning.

Note: Make sure that you handle MainActivity destruction on Android. See ImagePicker.getPendingResultAsync. Notes for Web: The system UI can only be shown after user activation (e.g. a Button press).

Therefore, calling launchCameraAsync in componentDidMount, for example, will not work as intended. The cancelled event will not be returned in the browser due to platform restrictions and inconsistencies across browsers.

If the user cancelled the action, the method returns { cancelled: true }. Otherwise, this method returns information about the selected media item. When the chosen item is an image, this method returns { cancelled: false, type: 'image', uri, width, height, exif, base64 }; when the item is a video, this method returns { cancelled: false, type: 'video', uri, width, height, duration }.


Display the system UI for choosing an image or a video from the phone's library. Requires Permissions.MEDIA_LIBRARY on iOS 10 only. On mobile web, this must be called immediately in a user interaction like a button press, otherwise the browser will block the request without a warning. Animated GIFs support If the selected image is an animated GIF, the result image will be an animated GIF too if and only if quality is set to undefined and allowsEditing is set to false. Otherwise compression and/or cropper will pick the first frame of the GIF and return it as the result (on Android the result will be a PNG, on iOS — GIF).

Notes for Web: The system UI can only be shown after user activation (e.g. a Button press).

Therefore, calling launchImageLibraryAsync in componentDidMount, for example, will not work as intended. The cancelled event will not be returned in the browser due to platform restrictions and inconsistencies across browsers.

If the user cancelled the action, the method returns { cancelled: true }. Otherwise, this method returns information about the selected media item. When the chosen item is an image, this method returns { cancelled: false, type: 'image', uri, width, height, exif, base64 }; when the item is a video, this method returns { cancelled: false, type: 'video', uri, width, height, duration }.


Asks the user to grant permissions for accessing camera. This does nothing on web because the browser camera is not used.

A promise that fulfills with an object of type CameraPermissionResponse.


Deprecated. Use requestMediaLibraryPermissionsAsync() instead.

  • writeOnly (boolean) - Whether to request write or read and write permissions. Defaults to false

Asks the user to grant permissions for accessing user's photo. This method does nothing on web.

A promise that fulfills with an object of type MediaLibraryPermissionResponse.

Alias for PermissionResponse type exported by expo-modules-core.

Deprecated. Use ImagePicker.MediaLibraryPermissionResponse instead.

An alias for the MediaLibraryPermissionResponse object.

Generic: T extends ImagePickerOptions | OpenFileBrowserOptions
Type: T extends { allowsMultipleSelection: true } ? ImagePickerMultipleResult : ImagePickerResult

NameTypeDescription
base64
(optional)
stringIncluded if the base64 option is truthy, and is a Base64-encoded string of the selected image's JPEG data. If you prepend this with 'data:image/jpeg;base64,' to create a data URI, you can use it as the source of an Image element; for example:
<Image
  source={{ uri: 'data:image/jpeg;base64,' + launchCameraResult.base64 }}
  style={{ width: 200, height: 200 }}
/>
cancelledbooleanBoolean flag which shows if request was cancelled. If asset data have been returned this should always be false.
duration
(optional)
numberLength of the video in milliseconds.
exif
(optional)
Record<string, any>The exif field is included if the exif option is truthy, and is an object containing the image's EXIF data. The names of this object's properties are EXIF tags and the values are the respective EXIF values for those tags.
heightnumberHeight of the image or video.
type
(optional)
'image' | 'video'The type of the asset.
uristringURI to the local image or video file (usable as the source of an Image element, in the case of an image) and width and height specify the dimensions of the media.
widthnumberWidth of the image or video.

An object returned when the pick action has been cancelled by the user.

NameTypeDescription
cancelledtrue-

NameTypeDescription
codestringThe error code.
exception
(optional)
stringThe exception which caused the error.
messagestringThe error message.

NameTypeDescription
cancelledfalse-
selectedImageInfo[]-

NameTypeDescription
allowsEditing
(optional)
booleanWhether to show a UI to edit the image after it is picked. On Android the user can crop and rotate the image and on iOS simply crop it.

Default: false
allowsMultipleSelection
(optional)
boolean
Web Only

Whether or not to allow selecting multiple media files at once.
aspect
(optional)
[number, number]An array with two entries [x, y] specifying the aspect ratio to maintain if the user is allowed to edit the image (by passing allowsEditing: true). This is only applicable on Android, since on iOS the crop rectangle is always a square.
base64
(optional)
booleanWhether to also include the image data in Base64 format.
exif
(optional)
booleanWhether to also include the EXIF data for the image. On iOS the EXIF data does not include GPS tags in the camera case.
mediaTypes
(optional)
MediaTypeOptionsChoose what type of media to pick.

Default: ImagePicker.MediaTypeOptions.Images
presentationStyle
(optional)
UIImagePickerPresentationStyle
iOS Only

Choose presentation style to customize view during taking photo/video.

Default: ImagePicker.UIImagePickerPresentationStyle.Automatic
quality
(optional)
numberSpecify the quality of compression, from 0 to 1. 0 means compress for small size, 1 means compress for maximum quality.
Note: If the selected image has been compressed before, the size of the output file may be bigger than the size of the original image.
videoExportPreset
(optional)
VideoExportPreset
Deprecated. See videoExportPreset in Apple documentation.
iOS 11+ Only

Specify preset which will be used to compress selected video.

Default: ImagePicker.VideoExportPreset.Passthrough
videoMaxDuration
(optional)
numberMaximum duration, in seconds, for video recording. Setting this to 0 disables the limit. Defaults to 0 (no limit).
  • On iOS, when allowsEditing is set to true, maximum duration is limited to 10 minutes. This limit is applied automatically, if 0 or no value is specified.
  • On Android, effect of this option depends on support of installed camera app.
  • On Web this option has no effect - the limit is browser-dependant.
videoQuality
(optional)
UIImagePickerControllerQualityType
iOS Only

Specify the quality of recorded videos. Defaults to the highest quality available for the device.

Default: ImagePicker.UIImagePickerControllerQualityType.High

Extends PermissionResponse type exported by expo-modules-core and contains additional iOS-specific field.

PermissionResponse extended by:

NameTypeDescription
accessPrivileges
(optional)
'all' | 'limited' | 'none'
iOS Only

NameTypeDescription
allowsMultipleSelectionboolean
Web Only

Whether or not to allow selecting multiple media files at once.
base64booleanWhether to also include the image data in Base64 format.
capture
(optional)
boolean-
mediaTypesMediaTypeOptionsChoose what type of media to pick.

Default: ImagePicker.MediaTypeOptions.Images

Acceptable values are: 'never', number.

Acceptable values are: PermissionHookBehavior, Options.

NameTypeDescription
canAskAgainboolean-
expiresPermissionExpiration-
grantedboolean-
statusPermissionStatus-

  • MediaTypeOptions.All : "All" - Images and videos.
  • MediaTypeOptions.Images : "Images" - Only images.
  • MediaTypeOptions.Videos : "Videos" - Only videos.

  • PermissionStatus.DENIED : "denied"
  • PermissionStatus.GRANTED : "granted"
  • PermissionStatus.UNDETERMINED : "undetermined"

  • UIImagePickerControllerQualityType.High : 0 - Highest available resolution.
  • UIImagePickerControllerQualityType.Medium : 1 - Depends on the device.
  • UIImagePickerControllerQualityType.Low : 2 - Depends on the device.
  • UIImagePickerControllerQualityType.VGA640x480 : 3 - 640 × 480
  • UIImagePickerControllerQualityType.IFrame1280x720 : 4 - 1280 × 720
  • UIImagePickerControllerQualityType.IFrame960x540 : 5 - 960 × 540

  • UIImagePickerPresentationStyle.Automatic : -2
  • UIImagePickerPresentationStyle.FullScreen : 0
  • UIImagePickerPresentationStyle.PageSheet : 1
  • UIImagePickerPresentationStyle.FormSheet : 2
  • UIImagePickerPresentationStyle.CurrentContext : 3
  • UIImagePickerPresentationStyle.OverFullScreen : 5
  • UIImagePickerPresentationStyle.OverCurrentContext : 6
  • UIImagePickerPresentationStyle.Popover : 7
  • UIImagePickerPresentationStyle.BlurOverFullScreen : 8

  • VideoExportPreset.Passthrough : 0 - Resolution: Unchanged • Video compression: None • Audio compression: None
  • VideoExportPreset.LowQuality : 1 - Resolution: Depends on the device • Video compression: H.264 • Audio compression: AAC
  • VideoExportPreset.MediumQuality : 2 - Resolution: Depends on the device • Video compression: H.264 • Audio compression: AAC
  • VideoExportPreset.HighestQuality : 3 - Resolution: Depends on the device • Video compression: H.264 • Audio compression: AAC
  • VideoExportPreset.H264_640x480 : 4 - Resolution: 640 × 480 • Video compression: H.264 • Audio compression: AAC
  • VideoExportPreset.H264_960x540 : 5 - Resolution: 960 × 540 • Video compression: H.264 • Audio compression: AAC
  • VideoExportPreset.H264_1280x720 : 6 - Resolution: 1280 × 720 • Video compression: H.264 • Audio compression: AAC
  • VideoExportPreset.H264_1920x1080 : 7 - Resolution: 1920 × 1080 • Video compression: H.264 • Audio compression: AAC
  • VideoExportPreset.H264_3840x2160 : 8 - Resolution: 3840 × 2160 • Video compression: H.264 • Audio compression: AAC
  • VideoExportPreset.HEVC_1920x1080 : 9 - Resolution: 1920 × 1080 • Video compression: HEVC • Audio compression: AAC
  • VideoExportPreset.HEVC_3840x2160 : 10 - Resolution: 3840 × 2160 • Video compression: HEVC • Audio compression: AAC

The following permissions are added automatically through the library AndroidManifest.xml.
Android PermissionDescription

Required to be able to access the camera device.

Allows an application to read from external storage.

Allows an application to write to external storage.

The following usage description keys are used by the APIs in this library.
Info.plist KeyDescription

A message that tells the user why the app is requesting access to the device’s microphone.

A message that tells the user why the app is requesting access to the user’s photo library.

A message that tells the user why the app is requesting access to the device’s camera.