Any options that exist in Core mode also exist in UI mode, and, in most cases, can be overridden.
Container element for the default drop zone
Container element for the item list.
false this will prevent the user from simultaneously selecting or dropping more than one item. Dropping or selecting another item will clear the upload list. If another is already uploading, it will be canceled. To ignore rather than cancel, simply return
false in the 'validate' or 'submit' event handlers.
Provide a function here to display a message to the user when the uploader receives an error or the user attempts to leave the page. The provided function may return a promise if one wishes to do asynchronous work whilst waiting for user input.
Provide a function here to prompt the user to confirm deletion of a file. The provided function may return a promise if one wishes to do asynchronous work whilst waiting for user input.
Provide a function here to prompt the user for a filename when pasting file(s). The provided function may return a promise if one wishes to do asynchronous work whilst waiting for user input.
This points to the container element that contains the template to use for one or more Fine Uploader UI instances. You can either specify a string, which is the element ID (the ID of the container element on the page) or an
Element that points to the container element.
This section defines UI specific options for the core
The message displayed in the confirm delete dialog.
The status message to appear next to a file that has failed to delete.
The status message to appear next to a file that is pending deletion.
If this value is set to
true, the user will be required to confirm the file delete request via a confirmation dialog.
Enable or disable the display of the file size next to the file after it has been submitted.
true batches of files are added to the top of the UI's file list. The default is to append file(s) to the bottom of the list.
Designate additional drop zones for file input.
Include the path of dropped files (starting with the top-level dropped directory). This value will be sent along with the request as a qqpath parameter.
Enable or disable a tooltip that will display the full contents of the error message when the mouse pointer hovers over the failed item.
Set the message to display next to each failed file. One of:
'default' which displays the
'custom' which displays the error response from the server, or
'none' which displays no text.
The property from the server response that contains the error text to display next to a failed item. Ignored unless
Text sent to
false and more than one file is dropped at once.
Text displayed to users who have ancient browsers.
messages is also in the Core mode options. This section defines UI specific
This section defines UI specific options for the core
The text of the note that will optionally appear next to the item during automatic retry attempts. Ignored if
showAutoRetryNote is false.
Enable or disable the showing of a button/link next to the failed item after all retry attempts have been exhausted. Clicking the button/link will force the uploader to make another attempt.
Enable or disable a status message appearing next to the item during auto retry attempts.
Ignored if the current browser does not support image previews. If you want to use an alternate library to resize the image, you must contribute a function for this option that returns a
Promise. Once the resize is complete, your promise must be fulfilled. You may, of course, reject your returned
Promise is the resize fails in some way.
resizeInfo object, which will be passed to the supplied function, contains the following properties:
blob- The original
Blobobject, if available.
height- Desired height of the image after the resize operation.
image- The original
HTMLImageElementobject, if available.
HTMLCanvasElementelement containing the original image data (not resized).
HTMLCanvasElementelement containing the
HTMLCanvasElementthat should contain the resized image.
width- Desired width of the image after the resize operation.
Maximum number of previews to render per Fine Uploader instance. A call to the reset method resets this value as well.
The amount of time, in milliseconds, to pause between each preview generation process. This is in place to prevent the UI thread from locking up for a continuously long period of time, as preview generation can be a resource-intensive process.
Absolute URL or relative path to the image to display if the preview/thumbnail could not be generated/displayed.
Absolute URL or relative path to the image to display during preview generation (modern browsers) or until the server response has been parsed (older browsers).
Set this to
true if you want the 'waiting' placeholder image to remain in place until the server response has been parsed. This is useful if you expect to return thumbnail URLs in your upload responses for files types that cannot be previewed. This option is ignored in older browsers where client-side previews cannot be generated.
Text that will appear in the
See the Upload Scaled Images feature page for more details.
Text that will appear next to a scaled image that could not be generated. This is in addition to the behavior associated with this property provided by Fine Uploader Core.
Set this to true if you do not want any scaled images to be displayed in the file list.
Text that appears next to a failed item
Appears next to a currently uploading item
Appears next to a paused item
Appears next to item once the last bytes have been sent (differs on the user-agent)