README
@filerobot/preupload-processors
A processor which applies some functionalities for the images before uploading process.
Usage
From NPM
The plugin is on NPM as @filerobot/preupload-processors
npm install --save @filerobot/preupload-processors
then
import PreUploadProcessors from '@filerobot/preupload-processors'
...
...
...
filerobot.use(PreUploadProcessors, optionsObject)
From CDN
The plugin from CDN is found inside Filerobot
global object Filerobot.PreUploadProcessors
const PreUploadProcessors = window.Filerobot.PreUploadProcessors
...
...
...
filerobot.use(PreUploadProcessors, optionsObject)
Plugin's styles
import '@filerobot/core/dist/style.css'
import '@filerobot/preupload-processors/dist/style.css'
or if you prefer the minified version
import '@filerobot/core/dist/style.min.css'
import '@filerobot/preupload-processors/dist/style.min.css'
The plugin's css file should be imported after the Core's css file for having the styles shown correctly.
Options
(optional) id: string
default: 'PreUploadProcessors'
An unique identifier for the plugin to be indentified between the other plugins through it.
(optional) imageProcessorByDefault: boolean
default: false
If true
the processing of image before upload checkbox would be default checked in the upload settings of uploading panel if there are any images selected, otherwise the checkbox will be default un-checked.
(optional) videoProcessorByDefault: boolean
default: false
If true
the processing of video before upload checkbox would be default checked in the upload settings of uploading panel if there are any videos selected, otherwise the checkbox will be default un-checked.
(optional) imageOperations:
default: null
The operations to be available to the user as options to choose from which to apply on the images before uploading, till now the supported operations:
- (object - required): Show user inputs for the user to choose the width & height of resizing, with respecting the passed values in resize
width, height
properties which refers to the max. width & max. height respectively, show following example.
example,
{
resize: {
width: 2000, // max width the user could reach
height: 2000 // max height the user could reach
}
}
(optional) videoTranscodingOptions:
default:
{
resolutions: ['auto', 'hq', 'desktop', 'tablet', 'mobile', 'sample'],
protocols: ['HLS', 'DASH'],
defaultResolution: 'auto',
defaultProtocol: 'HLS'
}
The options available for video transcoding shown in the UI controls with its default options.
(optional) locale: object
default: default locales inside lib/defaultLocale.js
.
Customizing some of the translations or the language's strings and replace the default locale.