jqUploader Documentation
Documentation
Here is the list of available options
- maxFileSize
- If used, limits the maximum allowed file size (in byte). Default to no limit.Note
that, due to limitations in the flash player, the maximum allowed size is 100
Mo Example limiting to 1 megabyte:
'maxFileSize:
1048576'.
Recommandation: simply add this bit of
html in your upload form, right before the file input field: <input
name="MAX_FILE_SIZE" value="1048576" type="hidden" />. In this way, even
users without javascript enabled will not have to wait the end of the transfer
to discover that their file is too heavy according to the server settings. This
is for ergonomy, NOT security, so make sure you enforce a filesize check in your
serverside upload script!
- width
- The width of the Flash file. Defaults to '320'
- height
- The height of the Flash file. Defaults to '85'
- version
- Minimum version of Flash required. Defaults to 8. Do not set
it below 8 if you want to stay out of troubles.
- background
- Background color of the Flash file. Defaults to white ('FFFFFF'). Example
value:
'FF9900'
- hideSubmit
- Defaults to true. Tells jqUploader whether to hide (true) or show (false) the
form's submit button. It means that if you wish to user MUST upload the file,
set this to true, else to false.
- cls
- The class added to the input field. Defaults to "jqUploader"
- src
- Path to the flash file. Defaults to jqUploader.swf. If relative, this path
takes the current html page path as starting point.
- uploadScript
The path to the serverside script handling the upload. Defaults to the
form action attribute value. ATTENTION!! This path is also relative to the
html page containing your form, NOT to the flash file. To be safe, use an
absolute url.
- afterScript
- When the upload is completed, the user will be taken to that page (optional).
- varName
- Generated text field's NAME attribute value. Defaults to file input field.
You shouldn't need to use this one.
- allowedExt
- Allowed file extensions. Default value: "*.jpg; *.jpeg; *.png"
IMPORTANT NOTE: client-side file extension restriction is about ergonomy,
not security, so that the user does not have to wait for the end of
the transfer to be informed of the non compliant file format.
It's very easy to circonvene (just download the page, edit it, by adding your
*.virus extension). So it's far from being enough in terms of security, hence you
really must set a second line of defense at the server level.
So, long story short, implement filetype restriction
in your serverside script.
- allowedExtDescr
- Description displayed in the "Browse" file selection box. Default value: "Images
(*.jpg; *.jpeg; *.png)"
- params
- Allows to pass some more parameters to the flash file. Defaults to an empty
array. Example {foo:"bar"}
- flashvars
- Allows to pass some more variables to the flash file. Defaults to an empty
array. Example {foo:"bar"}
- elementType
- Flash file container. Defaults to a div
- barcolor
- Progress bar color. Defaults to '0000CC'.
- startMessage
- Message welcoming the user. Defaults to the file input's corresponding label
value (if available in your html form).
- errorSizeMessage
- Message indicating that the selected file size is beyond the allowed maximum
file size limit. Defaults to
File is too big!
- validFileMessage
- Message indicating that the selected file is valid and inviting the user
to start the upload. Defaults to
now click "upload" to proceed
- progressMessage
- Message displayed during the upload, immediately followed by :
(%). Defaults to
Please wait, uploading
- endMessage
- Message displayed after the upload process is finished. Default: "You\'re
all done!"