Skip to content

Latest commit

 

History

History
52 lines (44 loc) · 3 KB

README.md

File metadata and controls

52 lines (44 loc) · 3 KB
Raw

version npm

react-native-camera-roll-picker

CameraRoll Picker component for React native

##Add to Project

  • Make sure node_modules/react-native/Libraries/CameraRoll/RCTCameraRoll.xcodeproj has been imported to project libraries by following the libraries linking instructions.

  • Install component through npm

$ npm install react-native-camera-roll-picker --save
  • Require component
import CameraRollPicker from 'react-native-camera-roll-picker';

##Basic Usage

<CameraRollPicker
  callback={this.getSelectedImages} />

##Props

  • callback : Callback function when images was selected. (is required!). Return a selected image array and current selected image.
  • scrollRenderAheadDistance : "How early to start rendering rows before they come on screen, in pixels." (Default: 500)
  • initialListSize : Specifies how many rows we want to render on our first render pass. (Default: 1)
  • pageSize : After the initial render where 'initialListSize' is used, ListView looks at the pageSize to determine how many rows to render per frame. (Default: 3)
  • removeClippedSubViews : "When true, offscreen child views (whose overflow value is hidden) are removed from their native backing superview when offscreen. This can improve scrolling performance on long lists. The default value is true." (The default value is false before version 0.14-rc). (Default: true)
  • groupTypes : The group where the photos will be fetched, one of 'Album', 'All', 'Event', 'Faces', 'Library', 'PhotoStream' and 'SavedPhotos'. (Default: SavedPhotos)
  • assetType : The asset type, one of 'Photos', 'Videos' or 'All'. (Default: Photos)
  • selected : Already be selected images array. (Default: [])
  • 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 camer roll picker container. (Default: device width)
  • selectedMarker : Custom selected image marker component. (Default: checkmark).
  • 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')

##Run Example

$ git clone https://github.com/jeanpan/react-native-camera-roll-picker.git
$ cd react-native-camera-roll-picker
$ cd Example
$ npm install
$ react-native run-ios