Prevent modal close on upload failure and allow users to retry.
Turn on cleaning JPEG image exif. Method can keep image orientation
Max number of files to upload concurrently. Default is 4.
Container where picker should be appended. Only relevant for inline and dropPane display modes.
Set the default container for your custom source.
Set the display name for the custom source.
Set the default path for your custom source container.
Provide an object for mapping picker strings to your own strings.
Strings surrounded by brackets, { foobar }, are interpolated with runtime values.
Source labels are also available to override, e.g. Facebook, Instagram, Dropbox, etc.
When true removes the hash prefix on stored files.
Disables local image thumbnail previews in the summary screen.
When true removes ability to edit images.
Picker display mode, one of 'inline', 'overlay', 'dropPane' - default is 'overlay'.
Configure the drop pane behavior, i.e. when displayMode is dropPane.
When true the originalFile metadata will be the actual File object instead of a POJO
Valid sources are:
Toggle the drop zone to be active on all views. Default is active only on local file source.
Hide the picker modal UI once uploading begins. Defaults to false.
Specify image dimensions. e.g. [800, 600]. Only for JPEG, PNG, and BMP files. Local and cropped images will be resized (upscaled or downscaled) to the specified dimensions before uploading. The original height to width ratio is maintained. To resize all images based on the width, set [width, null], e.g. [800, null]. For the height set [null, height], e.g. [null, 600].
Specify maximum image dimensions. e.g. [800, 600]. Only for JPEG, PNG, and BMP files. Images bigger than the specified dimensions will be resized to the maximum size while maintaining the original aspect ratio. The output will not be exactly 800x600 unless the imageMax matches the aspect ratio of the original image.
Specify minimum image dimensions. e.g. [800, 600]. Only for JPEG, PNG, and BMP files. Images smaller than the specified dimensions will be upscaled to the minimum size while maintaining the original aspect ratio. The output will not be exactly 800x600 unless the imageMin matches the aspect ratio of the original image.
Sets locale. Accepts: ca, da, de, en, es, fr, he, it, ja, ko, nl, no, pl, pt, sv, ru, vi, zh, tr
Maximum number of files allowed to upload. Defaults to 1.
Restrict selected files to a maximum number of bytes. (e.g. 10 * 1024 * 1024 for 10MB limit).
Minimum number of files required to start uploading. Defaults to 1.
Specify [width, height] in pixels of the desktop modal.
Called when all uploads in a pick are cancelled.
Called when the UI is exited.
Called whenever user selects a file.
// Using to veto file selection
// If you throw any error in this function it will reject the file selection.
// The error message will be displayed to the user as an alert.
onFileSelected(file) {
if (file.size > 1000 * 1000) {
throw new Error('File too big, select something smaller than 1MB');
}
}
// Using to change selected file name
// NOTE: This currently only works for local uploads
onFileSelected(file) {
// It's important to return a new file by the end of this function.
return { ...file, name: 'foo' };
}The callback function can also return a Promise to allow asynchronous validation logic.
You can pass a file object to resolve for changing the file name, it will behave the same as when
the file is returned from the non-async callback.
onFileSelected(file) {
return new Promise((resolve, reject) => {
// Do something async
resolve();
// Or reject the selection with reject()
});
}Called when uploading a file fails.
Called when a file is done uploading.
Called during multi-part upload progress events. Local files only.
Called when a file begins uploading.
Called when the UI is mounted.
Called when all files have been uploaded.
Called when uploading starts (user initiates uploading).
For cloud sources whether to link or store files. Defaults to false.
Define a unique id for the application mount point. May be useful for more advanced use cases. For example, if you wish to have more than one picker instance open at once, then each will need their own unique rootId.
Note: This option is ignored when displayMode is dropPane.
Whether to start uploading automatically when maxFiles is hit. Defaults to false.
Options for file storage.
Specify options for images passed to the crop UI.
Options for local file uploads.
Start uploading immediately on file selection. Defaults to true.
Sets the resolution of recorded video. One of "320x240", "640x480" or "1280x720". Default is "640x480".
Restrict file types that are allowed to be picked. Formats accepted: