Fine Uploader has a plethora of options. Many of these options change meaning depending on what sort of uploader you are using. Pay close attention to the mode you are in and keep that in mind when determining the meaning of a particular option.
false if you want to be able to upload queued items later by calling the
Specify an element to use as the 'select files' button. Cannot be a
This will result in log messages being written to the
When true the cancel link does not appear next to files when the form uploader is used.
Provide a function to control the display of file names. The raw file name is passed into the function when it is invoked. Your function may return a modified file name. Note that this does not affect the actual file name, only the displayed file name.
Maximum allowable concurrent requests
When false this will prevent the user from simultaneously selecting or dropping more than one item.
The default name to be used for nameless
null allows camera access on the default button in iOS. Otherwise provide an extra button container element to target.
Enable or disable camera access on iOS (iPod, iPhone, and iPad) devices. Note: Enabling this will disable multiple file selection.
chunking.success.endpoint option only applies to traditional upload endpoints (not S3, Azure, etc).
Allow multiple chunks to be uploaded simultaneously per file
Enable or disable splitting the file separate chunks. Each chunks is sent in a separate request.
Ensure every file is uploaded in chunks, even if the file can only be split up into 1 chunk. Does not apply if chunking is not possible in the current browser.
The maximum size of each chunk, in bytes.
Name of the parameter passed with a chunked request that specifies the size in bytes of the associated chunk.
Name of the parameter passed with a chunked request that specifies the starting byte of the associated chunk.
Name of the parameter passed with a chunked request that specifies the index of the associated partition.
Name of the parameter passed with a chunked request that specifies the total number of chunks associated with the
Enable or disable cross-origin requests from IE9 and older where XDomainRequest must be used.
Enable or disable cross-domain requests.
Enable or disable sending credentials along with each cross-domain request. Ignored if
true and IE9 is being used.
Any additional headers to attach to all delete file requests.
Enable or disable deletion of uploaded files.
The endpoint to which delete file requests are sent.
Set the method to use for delete requests. Accepts 'POST' or 'DELETE'
Any additional parameters to attach to delete file requests.
This must contain an array of objects. Each object will describe an “extra” button that Fine Uploader will track along with the default upload button. Each button object can contain the following properties:
REQUIRED: The container element for the upload button.
This value will be used when creating the
title attribute for the underlying
<input type="file">. If not provided, the
text.fileInputTitle option will be used instead.
true to allow folders to be selected,
false to allow files to be selected. See the browser support page for details regarding the limited user agent support for this feature.
Specify to override the default
Specify to override the default
validation option specified. Any
validation properties not specified will be inherited from the default
Override default values for form support. See the form support feature page for more details.
This can be the ID of the
<form> or a reference to the
If Fine Uploader is able to attach to a form, this value takes the place of the base
Set this to
false if you do not want Fine Uploader to intercept attempts to submit your form. By default, Fine Uploader will intercept submit attempts and instead upload all submitted files, including data from your form in each upload request.
Text passed to the error event handler if a submitted item is zero bits.
Text passed to the error event handler if an image is too tall.
Text passed to the error event handler if an image is too wide.
Text passed to the error event handler if an image is not tall enough.
Text passed to the error event handler if an image is not wide enough.
Text passed to the error event handler if the item is too small.
Text passed to the error event handler if any empty array of items is submitted.
Text displayed to the user when they attempt to leave the page while uploads are still in progress.
Text passed to the error event handler if a retry attempt is declared a failed due to a violation of the
Text passed to the error event handler if a submitted item is too large.
Text passed to the error event handler if a submit is ignored due to a violation of the
Text passed to the error event handler if an invalid file type is detected.
Message displayed if the browser is iOS8 Safari and the corresponding workarounds option is not disabled.
The default name given to pasted images.
Enable this feature by providing any
The number of days before a persistent resume record will expire.
Enable or disable the ability to resume failed or stopped chunked uploads.
Sent with the first request of the resume with a value of
The number of seconds to wait between auto retry attempts.
Enable or disable retrying uploads that receive any error response.
The maximum number of times to attempt to retry a failed upload.
This property will be looked for in the server response and, if found and
true, will indicate that no more retries should be attempted for this item.
Additional headers sent along with each upload request.
The endpoint to send upload requests to.
The name of the parameter passed if the original filename has been edited or a
Blob is being sent.
Force all uploads to use multipart encoding
The attribute of the input element which will contain the file name. For non-multipart-encoded upload requests, this will be included as a parameter in the query string of the URI with a value equal to the file name.
Specify a method to use when sending files to a traditional endpoint. This option is ignored in older browsers (such as IE 9 and older).
The parameters that shall be sent with each upload request.
Enable or disable sending parameters in the request body. If
false, parameters are sent in the URL. Otherwise, parameters are sent in the request body.
The name of the parameter the uniquely identifies each associated item. The value is a Level 4 UUID.
The name of the parameter passed that specifies the total file size in bytes.
See the Upload Scaled Images feature page for more details.
Ignored if the current browser does not support image previews. If you want to use an alternate scaling library, 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.
A `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.
A value between 1 and 100 that describes the requested quality of scaled images. Ignored unless the scaled image type target is image/jpeg.
Scaled images will assume this image type if you don't specify a specific type in your size object, or if the type specified in the size object is not valid. You generally should not use any value other than image/jpeg or image/png here. The default value of
null will ensure the scaled image type is PNG, unless the original file is a JPEG, in which case the scaled file will also be a JPEG. The default is probably the safest option.
Text sent to your
complete event handler as an
error property of the
response param if a scaled image could not be generated.
Ensure the EXIF data from the reference image is inserted into the scaled image. Only applicable when both the reference and the target are type image/jpeg.
Set this to
false if you do not want scaled images to be re-oriented based on parsed EXIF data before they are uploaded.
Set this to
false if you don't want to original file to be uploaded as well.
An array containing size objects that describe scaled versions of each submitted image that should be generated and uploaded. A size object should usually contain a
name String property (which will be appended to the file name of the scaled file), and must always contain a
maxSize integer property. A
type MIME string property is optional.
See the Initial File List feature page for more details.
Any additional headers you would like included with the GET request sent to your server. Ignored in IE9 and IE8 if the endpoint is cross-origin.
If non-null, Fine Uploader will send a GET request on startup to this endpoint, expecting a JSON response containing data about the initial file list to populate.
Any parameters you would like passed with the associated GET request to your server.
Set this to
false if you do not want the file list to be retrieved from the server as part of a reset.
In the event of non-200 response from the server sans the 'error' property, this message will be passed to the 'error' event handler.
The value for the
title attribute attached to the
<input type="file"> maintained by Fine Uploader for each upload button. This is used as hover text, among other things.
Symbols used to represent file size, in ascending order.
Used by the file selection dialog. Restrict the valid file types that appear in the selection dialog by listing valid content-type specifiers here. See docs on the accept attribute of the
Specify file valid file extensions here to restrict uploads to specific types.
Allow file size of 0 bytes
Maximum number of items that can be potentially uploaded in this session. Will reject all items that are added or retried after this limit is reached.
The minimum allowable size, in bytes, for an item.
The maximum allowable size, in bytes, for an item.
true the first invalid item will stop processing further files.
Restrict images to a maximum height in pixels (wherever possible).
Restrict images to a maximum width in pixels (wherever possible).
Restrict images to a minimum height in pixels (wherever possible).
Restrict images to a minimum width in pixels (wherever possible).
Flags that enable or disable workarounds for browser-specific bugs.
<input type='file'> elements tracked by Fine Uploader do NOT contain a
multiple attribute to work around an issue present in iOS7 & 8 that otherwise results in 0-sized uploaded videos.
<input type='file'> elements tracked by Fine Uploader always have a
multiple attribute present. This only applies to iOS8 Chrome and iOS8 UIWebView, and is put in place to work around an issue that causes the browser to crash when a file input element does not contain a
multiple attribute inside of a UIWebView container created by an iOS8 app compiled with and iOS7 SDK.
Disables Fine Uploader and displays a message to the user in iOS 8.0.0 Safari. Due to serious bugs in iOS 8.0.0 Safari, uploading is not possible. This was apparently fixed in subsequent builds of iOS8, so this workaround only targets 8.0.0.