@shovelandsandbox/rn-camera-roll-picker
TypeScript icon, indicating that this package has built-in type declarations

1.0.7 • Public • Published

Welcome to @kebetoo/camera-roll-picker 👋

npm version Documentation

A CameraRoll picker with support for changing the album name (groupName) and adding a video marker. Rewritten with performance in mind. Based on react-native-camera-roll-picker

🏠 Homepage

Getting started

  • Install component through npm
$ npm install @kebetoo/camera-roll-picker --save
$ npm install @react-native-community/cameraroll
  • Require component
import CameraRollPicker from '@kebetoo/camera-roll-picker';

Usage

<CameraRollPicker callback={this.getSelectedImages} />

Props

  • callback : Callback function when images was selected. (is required!). Return a selected image array and current selected image.
  • initialNumToRender : Specifies how many rows we want to render on our first render pass. (Default: 5)
  • groupTypes : The group where the photos will be fetched, one of 'Album', 'All', 'Event', 'Faces', 'Library', 'PhotoStream' and 'SavedPhotos'. (Default: Album)
  • assetType : The asset type, one of 'Photos', 'Videos' or 'All'. (Default: Photos)
  • selected : Already be selected images array. (Default: [])
  • selectSingleItem : Boolean to select only one single image at time. (Default: false)
  • maximum : Maximum number of selected images. (Default: 15)
  • imagesPerRow : Number of images per row. (Default: 3)
  • imageMargin : Margin size of one image. (Default: 5)
  • containerWidth : Width of camera roll picker container. (Default: device width)
  • selectedMarker : Custom selected marker component. (Default: Ionicons checkmark-circle).
  • backgroundColor : Set background color. (Default: white).
  • emptyText: Text to display instead of a list when there are no photos found. (Default: 'No photos.')
  • emptyTextStyle : Styles to apply to the emptyText. (Default: textAlign: 'center')
  • loader : Loader component node. (Default: <ActivityIndicator />)

New props

  • groupName : Specifies filter on group names, like 'Recent Photos', 'Whatsapp Images' or custom album titles. (Default: undefined)
  • videoMarker : Custom video marker component. (Default: Ionicons videocam)
  • loaderColor: Custom loader color, useful for theming the component. (Default: white) ,
  • loaderSize: Loader size. (Default: 25)
  • checkPermissions : A function to check android.permission.READ_EXTERNAL_STORAGE permission on Android. (Default: custom function based on PermissionsAndroid.request)
  • include : An array to specify fields other than the uri to include in the result. Possible values: [filename, fileSize, location, imageSize, playableDuration]. See react-native-cameraroll#getphotos (Default: [])

Run tests

npm run test

Author

👤 bacarybruno

Show your support

Give a ⭐️ if this project helped you!


This README was generated with ❤️ by readme-md-generator

Package Sidebar

Install

npm i @shovelandsandbox/rn-camera-roll-picker

Weekly Downloads

1

Version

1.0.7

License

MIT

Unpacked Size

21.2 kB

Total Files

9

Last publish

Collaborators

  • shovelandsandbox