react-native-media-library2

React Native JSI access to user's media library

Configure for iOS

Add NSPhotoLibraryUsageDescription, and NSPhotoLibraryAddUsageDescription keys to your Info.plist:

<key>NSPhotoLibraryUsageDescription</key>
<string>Give $(PRODUCT_NAME) permission to access your photos</string>
<key>NSPhotoLibraryAddUsageDescription</key>
<string>Give $(PRODUCT_NAME) permission to save photos</string>

Configure for Android

This package automatically adds the READ_EXTERNAL_STORAGE and WRITE_EXTERNAL_STORAGE permissions. They are used when accessing the user's images or videos.

<!-- Added permissions -->
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

Installation

add this line to `package.json`
"react-native-media-library2": "*"
yarn
npx pod-install

Usage

import { mediaLibrary } from "react-native-media-library2";

// ...

export interface CollectionItem {
  readonly filename: string;
  readonly id: string;
  readonly count: number;
}

interface Options {
  mediaType?: MediaType[];
  sortBy?: 'creationTime' | 'modificationTime';
  sortOrder?: 'asc' | 'desc';
  extensions?: string[];
  requestUrls?: boolean;
  limit?: number;
  offset?: number;
  collectionId?: string;
}

interface SaveToLibrary {
  localUrl: string;
  album?: string;
}

export type MediaType = 'photo' | 'video' | 'audio' | 'unknown';
export interface AssetItem {
  readonly filename: string;
  readonly id: string;
  readonly creationTime: number;
  readonly modificationTime: number;
  readonly mediaType: MediaType;
  readonly duration: number;
  readonly width: number;
  readonly height: number;
  readonly uri: string;
}

export interface FullAssetItem extends AssetItem {
  readonly url: string;
}

export interface FetchThumbnailOptions {
  url: string;
  time?: number;
  quality?: number;
}

export interface Thumbnail {
  url: string;
  width: number;
  height: number;
}

export interface ImageResizeParams {
  uri: ImageRequireSource | string;
  width?: number;
  height?: number;
  format?: 'jpeg' | 'png';
  resultSavePath: string;
}

export interface ImageCropParams {
  uri: ImageRequireSource | string;
  // offset between 0 and 1 percents of original image
  x: number;
  // offset between 0 and 1 percents of original image
  y: number;
  width: number;
  height: number;
  format?: 'jpeg' | 'png';
  resultSavePath: string;
}

mediaLibrary.getCollections(): Promise<CollectionItem[]>
mediaLibrary.getAssets(options?: Options): Promise<AssetItem[]>
mediaLibrary.getAsset(id: string): Promise<FullAssetItem | undefined>
// will return save asset or error string
mediaLibrary.saveToLibrary(params: SaveToLibrary): Promise<FullAssetItem | string>
// returns cache directory
mediaLibrary.cacheDir: string

// retrieve frame from video with passed params
mediaLibrary.fetchVideoFrame(params: FetchThumbnailOptions): Promise<Thumbnail | undefined>

// combine passed images in one
mediaLibrary.combineImages(params: {
  images: (ImageRequireSource | string)[];
  resultSavePath: string;
}): Promise<{ result: boolean }>

// resize image based on passed width and height
mediaLibrary.imageResize(params: ImageResizeParams): Promise<{ result: boolean }>
// crop image based on passed offset
mediaLibrary.imageCrop(params: ImageCropParams): Promise<{ result: boolean }>

// resolve passed images sizes
mediaLibrary.imageSizes(params: {
  images: (ImageRequireSource | string)[];
}): Promise<{ result: { width: number; height: number; size: number }[] }>

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Made with create-react-native-library