Image Picker

@nativescript/imagepicker

Imagepicker plugin supporting both single and multiple selection. + Plugin supports iOS8+ and uses QBImagePicker cocoa pod. + For Android it uses Intents to open the stock images or file pickers. For Android 6 (API 23) and above the permissions to read file storage should be explicitly required. See demo for implementation details.

npm install @nativescript/imagepicker

Usage

The best way to explore the usage of the plugin is to inspect both demo apps in the plugin repository. In demo folder you can find the usage of the plugin for TypeScript non-Angular application. Refer to demo/app/main-page.ts. In demo-angular is the usage in an Angular app. Refer to demo-angular/app/app.component.ts.

In addition to the plugin usage, both apps are webpack configured.

In short, here are the steps:

Import the plugin

TypeScript

import * as imagepicker from "@nativescript/imagepicker";

Javascript

var imagepicker = require("@nativescript/imagepicker");

Create imagepicker

Create imagepicker in single or multiple mode to specifiy if the imagepicker will be used for single or multiple selection of images

TypeScript

let context = imagepicker.create({
    mode: "single" // use "multiple" for multiple selection
});

Javascript

var context = imagepicker.create({ mode: "single" }); // use "multiple" for multiple selection

Request permissions, show the images list and process the selection

context
    .authorize()
    .then(function() {
        return context.present();
    })
    .then(function(selection) {
        selection.forEach(function(selected) {
            // process the selected image
        });
        list.items = selection;
    }).catch(function (e) {
        // process error
    });

To request permissions for Android 6+ (API 23+) we use nativescript-permissions.

To be sure to have permissions add the following lines in AndroidManifest.xml

 
<manifest ... >
  <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

  <application android:requestLegacyExternalStorage="true" ... >
    ...
  </application>
</manifest>

Using the plugin on iOS requires photo library permission. Your app might be rejected from the Apple App Store if you do not provide a description of why you need this permission. The default message "Requires access to a photo library." might not be enough for the App Store reviewers. You can customize it by editing the app/App_Resources/iOS/Info.plist file in your app and adding the following key:

 
<key>NSPhotoLibraryUsageDescription</key>
<string>Description text goes here</string>

API

Methods

  • create(options) — creates an instance of the image-picker. Possible options are:

Option Platform Default Description

mode

both

multiple

The mode if the imagepicker. Possible values are single for single selection and multiple for multiple selection.

minimumNumberOfSelection

iOS

0

The minumum number of selected assets.

maximumNumberOfSelection

iOS

0

The maximum number of selected assets.

showsNumberOfSelectedAssets

iOS

True

Display the number of selected assets.

prompt

iOS

undefined

Display prompt text when selecting assets.

numberOfColumnsInPortrait

iOS

4

Set the number of columns in Portrait orientation.

numberOfColumnsInLandscape

iOS

7

Set the number of columns in Landscape orientation.

mediaType

both

Any

Choose whether to pick Image/Video/Any type of assets.

showAdvanced

Android

false

Show internal and removable storage options on Android (WARNING: not supported officially).

The hostView parameter can be set to the view that hosts the image picker. Applicable in iOS only, intended to be used when open picker from a modal page.

  • authorize() — request the required permissions.

  • present() — show the albums to present the user the ability to select images. Returns an array of the selected images.

License

Apache License Version 2.0