@lang0909/camera-roll
v0.0.2
Published
React Native Camera Roll for iOS & Android
Downloads
52
Maintainers
Readme
@react-native-camera-roll/camera-roll
lang0909 fork version
Notice: The NPM package name has changed, please change your package.json dependency!
Previous package name: @react-native-community/cameraroll
New package name: @react-native-camera-roll/camera-roll
Getting started
$ npm install @react-native-camera-roll/camera-roll --save
Mostly automatic installation
$ react-native link @react-native-camera-roll/camera-roll && npx pod-install
Manual installation
iOS
- In XCode, in the project navigator, right click
Libraries
➜Add Files to [your project's name]
- Go to
node_modules
➜@react-native-camera-roll/camera-roll
and addRNCCameraroll.xcodeproj
- In XCode, in the project navigator, select your project. Add
libRNCCameraroll.a
to your project'sBuild Phases
➜Link Binary With Libraries
- Run your project (
Cmd+R
)<
Android
- Open up
android/app/src/main/java/[...]/MainApplication.java
(Auto link, ^RN0.69 does not required)
- Add
import com.reactnativecommunity.cameraroll.CameraRollPackage;
to the imports at the top of the file - Add
new CameraRollPackage()
to the list returned by thegetPackages()
method
- Append the following lines to
android/settings.gradle
:include ':@react-native-camera-roll_camera-roll' project(':@react-native-camera-roll_camera-roll').projectDir = new File(rootProject.projectDir, '../node_modules/@react-native-camera-roll/camera-roll/android')
- Insert the following lines inside the dependencies block in
android/app/build.gradle
:implementation project(':@react-native-camera-roll_camera-roll')
Starting with Android 10, the concept of scoped storage is introduced. Currently, to make it working with that change, you have to add android:requestLegacyExternalStorage="true"
to AndroidManifest.xml
:
<manifest ... >
<application android:requestLegacyExternalStorage="true" ... >
...
</application>
</manifest>
Migrating from the core react-native
module
This module was created when the CameraRoll 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 { CameraRoll } from "react-native";
to:
import { CameraRoll } from "@react-native-camera-roll/camera-roll";
Usage
CameraRoll
provides access to the local camera roll or photo library.
Permissions
iOS
The user's permission is required in order to access the Camera Roll on devices running iOS 10 or later. Add the NSPhotoLibraryUsageDescription
key in your Info.plist
with a string that describes how your app will use this data. This key will appear as Privacy - Photo Library Usage Description
in Xcode.
If you are targeting devices running iOS 11 or later, you will also need to add the NSPhotoLibraryAddUsageDescription
key in your Info.plist
. Use this key to define a string that describes how your app will use this data. By adding this key to your Info.plist
, you will be able to request write-only access permission from the user. If you try to save to the camera roll without this permission, your app will exit.
Android
Permission is required to read and write to the external storage.
On Expo, follow the guide here for requesting the permission.
On react-native-cli or ejected apps, adding the following lines will add the capability for the app to request the permission. Find more info on Android Permissions here.
<manifest>
...
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
...
<application>
Add the android:requestLegacyExternalStorage="true"
attribute to the <application>
tag for Android 10 support.
Then you have to explicitly ask for the permission
import { PermissionsAndroid, Platform } from "react-native";
import { CameraRoll } from "@react-native-camera-roll/camera-roll";
async function hasAndroidPermission() {
const permission = PermissionsAndroid.PERMISSIONS.WRITE_EXTERNAL_STORAGE;
const hasPermission = await PermissionsAndroid.check(permission);
if (hasPermission) {
return true;
}
const status = await PermissionsAndroid.request(permission);
return status === 'granted';
}
async function savePicture() {
if (Platform.OS === "android" && !(await hasAndroidPermission())) {
return;
}
CameraRoll.save(tag, { type, album })
};
Andoid 13
On Android 13 the READ_EXTERNAL_STORAGE
has been replace by READ_MEDIA_IMAGES
and READ_MEDIA_VIDEO
.
<manifest>
...
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
...
<application>
Methods
Reference
Methods
save()
CameraRoll.save(tag, { type, album })
Saves the photo or video to the photo library.
On Android, the tag must be a local image or video URI, such as "file:///sdcard/img.png"
.
On iOS, the tag can be any image URI (including local, remote asset-library and base64 data URIs) or a local video file URI (remote or data URIs are not supported for saving video at this time).
If the tag has a file extension of .mov or .mp4, it will be inferred as a video. Otherwise it will be treated as a photo. To override the automatic choice, you can pass an optional type
parameter that must be one of 'photo' or 'video'.
It allows to specify a particular album you want to store the asset to when the param album
is provided.
On Android, if no album is provided, DCIM directory is used, otherwise PICTURE or MOVIES directory is used depending on the type
provided.
Returns a Promise which will resolve with the new URI.
Parameters:
| Name | Type | Required | Description | | ---- | ---------------------- | -------- | ---------------------------------------------------------- | | tag | string | Yes | See above. | | type | enum('photo', 'video') | No | Overrides automatic detection based on the file extension. | | album | string | No | The album to save to |
getAlbums()
CameraRoll.getAlbums(params);
Returns a Promise with a list of albums
Parameters:
assetType
: {string} : Specifies filter on asset type. Valid values are:All
// defaultVideos
Photos
Returns:
Array of Album
object
- title: {string}
- count: {number}
getPhotos()
CameraRoll.getPhotos(params);
Returns a Promise with photo identifier objects from the local camera roll of the device matching shape defined by getPhotosReturnChecker
.
Parameters:
| Name | Type | Required | Description | | ------ | ------ | -------- | ------------------------------------------------ | | params | object | Yes | Expects a params with the shape described below. |
first
: {number} : The number of photos wanted in reverse order of the photo application (i.e. most recent first for SavedPhotos). Required.after
: {string} : A cursor that matchespage_info { end_cursor }
returned from a previous call togetPhotos
. Note that using this will reduce performance slightly on iOS. An alternative is just using thefromTime
andtoTime
filters, which have no such impact.groupTypes
: {string} : Specifies which group types to filter the results to. Valid values are:Album
All
// defaultEvent
Faces
Library
PhotoStream
SavedPhotos
groupName
: {string} : Specifies filter on group names, like 'Recent Photos' or custom album titles.assetType
: {string} : Specifies filter on asset type. Valid values are:All
Videos
Photos
// default
mimeTypes
: {Array} : Filter by mimetype (e.g. image/jpeg). Note that using this will reduce performance slightly on iOS.fromTime
: {number} : Filter by creation time with a timestamp in milliseconds. This time is exclusive, so we'll select all photos withtimestamp > fromTime
.toTime
: {number} : Filter by creation time with a timestamp in milliseconds. This time is inclusive, so we'll select all photos withtimestamp <= toTime
.include
: {Array} : Whether to include some fields that are slower to fetchfilename
: Ensuresimage.filename
is available in each node. This has a large performance impact on iOS.fileSize
: Ensuresimage.fileSize
is available in each node. This has a large performance impact on iOS.location
: Ensureslocation
is available in each node. This has a large performance impact on Android.imageSize
: Ensuresimage.width
andimage.height
are available in each node. This has a small performance impact on Android.playableDuration
: Ensuresimage.playableDuration
is available in each node. This has a medium peformance impact on Android.
Returns a Promise which when resolved will be of the following shape:
edges
: {Array} An array of node objectsnode
: {object} An object with the following shape:type
: {string}group_name
: {string}image
: {object} : An object with the following shape:uri
: {string}filename
: {string | null} : Only set if theinclude
parameter containsfilename
height
: {number | null} : Only set if theinclude
parameter containsimageSize
width
: {number | null} : Only set if theinclude
parameter containsimageSize
fileSize
: {number | null} : Only set if theinclude
parameter containsfileSize
playableDuration
: {number | null} : Only set for videos if theinclude
parameter containsplayableDuration
. Will be null for images.
timestamp
: {number}location
: {object | null} : Only set if theinclude
parameter containslocation
. An object with the following shape:latitude
: {number}longitude
: {number}altitude
: {number}heading
: {number}speed
: {number}
page_info
: {object} : An object with the following shape:has_next_page
: {boolean}start_cursor
: {string}end_cursor
: {string}
limited
: {boolean | undefined} : true if the app can only access a subset of the gallery pictures (authorization isPHAuthorizationStatusLimited
), false otherwise (iOS only)
Example
Loading images:
_handleButtonPress = () => {
CameraRoll.getPhotos({
first: 20,
assetType: 'Photos',
})
.then(r => {
this.setState({ photos: r.edges });
})
.catch((err) => {
//Error Loading Images
});
};
render() {
return (
<View>
<Button title="Load Images" onPress={this._handleButtonPress} />
<ScrollView>
{this.state.photos.map((p, i) => {
return (
<Image
key={i}
style={{
width: 300,
height: 100,
}}
source={{ uri: p.node.image.uri }}
/>
);
})}
</ScrollView>
</View>
);
}
Loading images with listeners and refetchs:
import { PhotoGallery, cameraRollEventEmitter } from '@react-native-camera-roll/camera-roll';
import { useCallback, useEffect, useState } from 'react';
import { AppState, EmitterSubscription } from 'react-native';
interface GalleryOptions {
pageSize: number;
mimeTypeFilter?: Array<string>;
}
interface GalleryLogic {
photos?: ImageDTO[];
loadNextPagePictures: () => void;
isLoading: boolean;
isLoadingNextPage: boolean;
isReloading: boolean;
hasNextPage: boolean;
}
const supportedMimeTypesByTheBackEnd = [
'image/jpeg',
'image/png',
'image/heif',
'image/heic',
'image/heif-sequence',
'image/heic-sequence',
];
export const useGallery = ({
pageSize = 30,
mimeTypeFilter = supportedMimeTypesByTheBackEnd,
}: GalleryOptions): GalleryLogic => {
const [isLoading, setIsLoading] = useState(false);
const [isReloading, setIsReloading] = useState(false);
const [isLoadingNextPage, setIsLoadingNextPage] = useState(false);
const [hasNextPage, setHasNextPage] = useState(false);
const [nextCursor, setNextCursor] = useState<string>();
const [photos, setPhotos] = useState<ImageDTO[]>();
const loadNextPagePictures = useCallback(async () => {
try {
nextCursor ? setIsLoadingNextPage(true) : setIsLoading(true);
const { edges, page_info } = await PhotoGallery.getPhotos({
first: pageSize,
after: nextCursor,
assetType: 'Photos',
mimeTypes: mimeTypeFilter,
...(isAndroid && { include: ['fileSize', 'filename'] }),
});
const photos = convertCameraRollPicturesToImageDtoType(edges);
setPhotos((prev) => [...(prev ?? []), ...photos]);
setNextCursor(page_info.end_cursor);
setHasNextPage(page_info.has_next_page);
} catch (error) {
console.error('useGallery getPhotos error:', error);
} finally {
setIsLoading(false);
setIsLoadingNextPage(false);
}
}, [mimeTypeFilter, nextCursor, pageSize]);
const getUnloadedPictures = useCallback(async () => {
try {
setIsReloading(true);
const { edges, page_info } = await PhotoGallery.getPhotos({
first: !photos || photos.length < pageSize ? pageSize : photos.length,
assetType: 'Photos',
mimeTypes: mimeTypeFilter,
// Include fileSize only for android since it's causing performance issues on IOS.
...(isAndroid && { include: ['fileSize', 'filename'] }),
});
const newPhotos = convertCameraRollPicturesToImageDtoType(edges);
setPhotos(newPhotos);
setNextCursor(page_info.end_cursor);
setHasNextPage(page_info.has_next_page);
} catch (error) {
console.error('useGallery getNewPhotos error:', error);
} finally {
setIsReloading(false);
}
}, [mimeTypeFilter, pageSize, photos]);
useEffect(() => {
if (!photos) {
loadNextPagePictures();
}
}, [loadNextPagePictures, photos]);
useEffect(() => {
const subscription = AppState.addEventListener('change', async (nextAppState) => {
if (nextAppState === 'active') {
getUnloadedPictures();
}
});
return () => {
subscription.remove();
};
}, [getUnloadedPictures]);
useEffect(() => {
let subscription: EmitterSubscription;
if (isAboveIOS14) {
subscription = cameraRollEventEmitter.addListener('onLibrarySelectionChange', (_event) => {
getUnloadedPictures();
});
}
return () => {
if (isAboveIOS14 && subscription) {
subscription.remove();
}
};
}, [getUnloadedPictures]);
return {
photos,
loadNextPagePictures,
isLoading,
isLoadingNextPage,
isReloading,
hasNextPage,
};
};
deletePhotos()
CameraRoll.deletePhotos([uri]);
Requests deletion of photos in the camera roll.
On Android, the uri must be a local image or video URI, such as "file:///sdcard/img.png"
.
On iOS, the uri can be any image URI (including local, remote asset-library and base64 data URIs) or a local video file URI. The user is presented with a dialog box that shows them the asset(s) and asks them to confirm deletion. This is not able to be bypassed as per Apple Developer guidelines.
Returns a Promise which will resolve when the deletion request is completed, or reject if there is a problem during the deletion. On iOS the user is able to cancel the deletion request, which causes a rejection, while on Android the rejection will be due to a system error.
Parameters:
| Name | Type | Required | Description | | ---- | ---------------------- | -------- | ---------------------------------------------------------- | | uri | string | Yes | See above. |
iosGetImageDataById()
CameraRoll.iosGetImageDataById(internalID, true);
Parameters:
| Name | Type | Required | Description | | ------------ | ----------------------- | ---------- | ---------------------------------------------------- | | internalID | string | Yes | Ios internal ID 'PH://xxxx'. | | convertHeic | boolean | False | Whether to convert or not to JPEG image. |
Known issues
IOS
If you try to save media into specific album without asking for read and write permission then saving will not work, workaround is to not precice album name for IOS if you don't want to request full permission (Only ios >= 14).