mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-02-07 23:03:19 +08:00
docs(image-picker): add interface docs
This commit is contained in:
parent
6521e1833c
commit
db3d5b63c6
@ -2,19 +2,23 @@ import { Cordova, Plugin } from './plugin';
|
|||||||
|
|
||||||
|
|
||||||
export interface ImagePickerOptions {
|
export interface ImagePickerOptions {
|
||||||
// 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.
|
* 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.
|
||||||
|
*/
|
||||||
maximumImagesCount?: number;
|
maximumImagesCount?: number;
|
||||||
|
|
||||||
// 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
|
* Max width to allow images to be
|
||||||
// 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?: number;
|
width?: number;
|
||||||
|
/**
|
||||||
|
* Max height to allow images to be
|
||||||
|
*/
|
||||||
height?: number;
|
height?: number;
|
||||||
|
|
||||||
// quality of resized image, defaults to 100
|
/**
|
||||||
|
* Quality of images, defaults to 100
|
||||||
|
*/
|
||||||
quality?: number;
|
quality?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -38,6 +42,8 @@ export interface ImagePickerOptions {
|
|||||||
* }
|
* }
|
||||||
* }, (err) => { });
|
* }, (err) => { });
|
||||||
* ```
|
* ```
|
||||||
|
* @interfaces
|
||||||
|
* ImagePickerOptions
|
||||||
*/
|
*/
|
||||||
@Plugin({
|
@Plugin({
|
||||||
plugin: 'cordova-plugin-image-picker',
|
plugin: 'cordova-plugin-image-picker',
|
||||||
|
Loading…
Reference in New Issue
Block a user