Have ideas to improve npm?Join in the discussion! »

@react-native-community/image-picker-iosTypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

@react-native-community/image-picker-ios

CircleCI Status Supports iOS MIT License

React Native ImagePicker for iOS. It allows you to get information on:

  • Can you use the Camera
  • Can you record video

Getting started

Install the library using either Yarn:

yarn add @react-native-community/image-picker-ios

or npm:

npm install --save @react-native-community/image-picker-ios

You then need to link the native parts of the library for the platforms you are using. The easiest way to link the library is using the CLI tool by running this command from the root of your project:

react-native link @react-native-community/image-picker-ios

If you can't or don't want to use the CLI tool, you can also manually link the library using the instructions below (click on the arrow to show them):

Manually link the library on iOS

Either follow the instructions in the React Native documentation to manually link the framework or link using Cocoapods by adding this to your Podfile:

pod 'react-native-image-picker-ios', :path => '../node_modules/@react-native-community/image-picker-ios'

Migrating from the core react-native module

This module was created when the ImagePickerIOS was split out from the core of React Native. To migrate to this module you need to follow the installation instructions above and then change you imports from:

import { ImagePickerIOS } from "react-native";

to:

import ImagePickerIOS from "@react-native-community/image-picker-ios";

Note that the API was updated after it was extracted from ImagePickerIOS to support some new features, however, the previous API is still available and works with no updates to your code.

Usage

Import the library:

import ImagePickerIOS from "@react-native-community/image-picker-ios";

Can you use the camera:

ImagePickerIOS.canUseCamera(canUseCamera => {
  console.log("canUseCamera", canUseCamera);
});

Can you record videos:

ImagePickerIOS.canRecordVideos(canRecordVideos => {
  console.log("canRecordVideos", canRecordVideos);
});

API

Types

OpenCameraDialogOptions

Describes the settings for the camera:

Property Type Description
videoMode boolean Should the camera open in video mode.

OpenSelectDialogOptions

Describes the settings for the camera:

Property Type Description
showImages boolean Should the results include images
showVideos boolean Should the results include videos

Methods

canUseCamera()

Executes a callback with the a boolean value stating whether or not you can use the camera.

Example:

ImagePickerIOS.canUseCamera(canUseCamera => {
  console.log("canUseCamera", canUseCamera);
});

canRecordVideos()

Executes a callback with the a boolean value stating whether or not you can record videos.

Example:

ImagePickerIOS.canRecordVideos(canRecordVideos => {
  console.log("canRecordVideos", canRecordVideos);
});

openCameraDialog()

Opens the camera dialog with the specified OpenCameraDialogOptions and two callbacks, one for success and one for cancel.

Example:

ImagePickerIOS.openCameraDialog({
  unmirrorFrontFacingCamera: false
  videoMode: false
}, () => {
  // success
}, (error) => {
  // cancel
});

openSelectDialog()

Opens the camera dialog with the specified OpenSelectDialogOptions and two callbacks, one for success and one for cancel.

Example:

ImagePickerIOS.openCameraDialog({
  showImages: true,
  showVideos: false
}, (imageUrl, height, width) => {
  // success
}, (error) => {
  // cancel
});

Troubleshooting

Errors while running Jest tests

If you do not have a Jest Setup file configured, you should add the following to your Jest settings and create the jest.setup.js file in project root:

setupFiles: ['<rootDir>/jest.setup.js']

You should then add the following to your Jest setup file to mock the ImagePickerIOS Native Module:

import { NativeModules } from 'react-native';
 
NativeModules.RNCImagePickerIOS = {
  canRecordVideos: jest.fn(),
  canUseCamera: jest.fn(),
  openCameraDialog: jest.fn(),
  openSelectDialog: jest.fn(),
};

Issues with the iOS simulator

As your simulator doesn't have a camera, there is no way to open the camera on the simulator.

Maintainers

Contributing

Please see the contributing guide.

License

The library is released under the MIT license. For more information see LICENSE.

Install

npm i @react-native-community/image-picker-ios

DownloadsWeekly Downloads

26

Version

1.0.1

License

MIT

Unpacked Size

79.7 kB

Total Files

38

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar