Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiyali/cordova-plugin-image-picker
Cordova plugin that for image selection
https://github.com/hiyali/cordova-plugin-image-picker
cordova image ionic picker plugin
Last synced: about 1 month ago
JSON representation
Cordova plugin that for image selection
- Host: GitHub
- URL: https://github.com/hiyali/cordova-plugin-image-picker
- Owner: hiyali
- License: mit
- Created: 2017-11-08T07:56:16.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-15T10:41:13.000Z (about 7 years ago)
- Last Synced: 2024-03-01T04:38:00.758Z (10 months ago)
- Topics: cordova, image, ionic, picker, plugin
- Language: Objective-C
- Homepage:
- Size: 769 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
cordova-plugin-image-picker
===================
Cordova Plugin For Multiple Images Selection - implemented for iOS and Android 4.0 and above.
## ! NOTICE
This project forked from [https://github.com/Telerik-Verified-Plugins/ImagePicker](https://github.com/Telerik-Verified-Plugins/ImagePicker)
## Installing the plugin
The plugin conforms to the Cordova plugin specification, it can be installed
using the Ionic / Cordova command line interface.
without desc
```shell
ionic cordova plugin add https://github.com/hiyali/cordova-plugin-image-picker.git
```
with desc
```shell
ionic cordova plugin add https://github.com/hiyali/cordova-plugin-image-picker.git --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="your usage message"
```
## Using the plugin
The plugin creates the object `window.imagePicker` with the method `getPictures(success, fail, options)`
Example - Get Full Size Images (all default options):
```javascript
window.imagePicker.getPictures(
function(results) {
for (var i = 0; i < results.length; i++) {
console.log('Image URI: ' + results[i]);
}
}, function (error) {
console.log('Error: ' + error);
}
);
```
Example - Get at most 10 images scaled to width of 800:
```javascript
window.imagePicker.getPictures(
function(results) {
for (var i = 0; i < results.length; i++) {
console.log('Image URI: ' + results[i]);
}
}, function (error) {
console.log('Error: ' + error);
}, {
maximumImagesCount: 10,
width: 800
}
);
```
### Options
```javascript
options = {
// Max images to be selected, defaults to 15. If this is set to 1, upon
// selection of a single image, the plugin will return it (Android only).
maximumImagesCount: int,
// max width and height to allow the images to be. Will keep aspect
// ratio no matter what. So if both are 800, the returned image
// will be at most 800 pixels wide and 800 pixels tall. If the width is
// 800 and height 0 the image will be 800 pixels wide if the source
// is at least that wide.
width: int,
height: int,
// quality of resized image, defaults to 100
quality: int (0-100),
// output type, defaults to FILE_URIs.
// available options are
// window.imagePicker.OutputType.FILE_URI (0) or
// window.imagePicker.OutputType.BASE64_STRING (1)
outputType: int
};
```
### Note for Android Use
When outputType is FILE_URI the plugin returns images that are stored in a temporary directory. These images will often not be deleted automatically though. The files should be moved or deleted after you get their filepaths in javascript. If Base64 Strings are being returned, there is nothing to clean up.
## Android 6 (M) Permissions
On Android 6 you need to request permission to read external storage at runtime when targeting API level 23+.
Even if the `uses-permission` tags for the Calendar are present in `AndroidManifest.xml`.
Note that the `hasReadPermission` function will return true when:
- You're running this on iOS, or
- You're targeting an API level lower than 23, or
- You're using Android < 6, or
- You've already granted permission.
```js
function hasReadPermission() {
window.imagePicker.hasReadPermission(
function(result) {
// if this is 'false' you probably want to call 'requestReadPermission' now
alert(result);
}
)
}
function requestReadPermission() {
// no callbacks required as this opens a popup which returns async
window.imagePicker.requestReadPermission();
}
```
Note that backward compatibility was added by checking for read permission automatically when `getPictures` is called.
If permission is needed the plugin will now show the permission request popup.
The user will then need to allow access and invoke the same method again after doing so.
## Libraries used
#### ELCImagePicker
For iOS this plugin uses the ELCImagePickerController, with slight modifications for the iOS image picker. ELCImagePicker uses the MIT License which can be found in the file LICENSE.
https://github.com/B-Sides/ELCImagePickerController
#### MultiImageChooser
For Android this plugin uses MultiImageChooser, with modifications. MultiImageChooser uses the BSD 2-Clause License which can be found in the file BSD_LICENSE. Some code inside MultImageChooser is licensed under the Apache license which can be found in the file APACHE_LICENSE.
https://github.com/derosa/MultiImageChooser
#### FakeR
Code(FakeR) was also taken from the phonegap BarCodeScanner plugin. This code uses the MIT license.
https://github.com/wildabeast/BarcodeScanner
## License
MIT