bootstrap-fileinput-npm

bootstrap-fileinput
====================


An enhanced HTML 5 file input for Bootstrap 3.x with file preview for various files, offers multiple selection, and more. The plugin allows you a simple way to setup an advanced file picker/upload control built to work specially with Bootstrap CSS3 styles. It enhances the file input functionality further, by offering support to preview a wide variety of files i.e. images, text, html, video, audio, flash, and objects. In addition, it includes AJAX based uploads, dragging & dropping files, viewing upload progress, and selectively previewing, adding, or deleting files.
!File Input Screenshot

This plugin was initially inspired by this blog article and Jasny's File Input plugin. But the plugin has now matured with various additional features and enhancements to be a complete (yet simple) file management tool and solution for web developers.

> NOTE: The latest version of the plugin is v4.2.8 (dev-master). Refer the CHANGE LOG for details.

Features

$3

1. The plugin will convert a simple HTML file input to an advanced file picker control. Will help fallback to a normal HTML file input for browsers not supporting JQuery or Javascript.
2. The file input consists of the following three sections with options and templates to control the display:
- _file caption section_: to display a brief information of the file(s) selected
- _file action buttons section_: to browse, remove, and upload files.
- _file preview section_: to display the selected files on client for preview (supports preview of image, text, flash, and video file types). Other file types will be displayed as normal thumbnails.
3. The plugin automatically converts an input with type = file to an advanced file picker input if you set its class = file. All options to the input can be passed as HTML5 data attributes.
4. Ability to select and preview multiple files. Uses HTML 5 File reader API to read and preview files. Displays the progress of files being being loaded onto the preview zone, in case many files are chosen.
5. Offers predefined templates and CSS classes which can be changed to style your file-input display as per your needs.
6. With v1.5.0, you can now configure the plugin to show an initial preview of images/files with initial caption
(more useful for record update scenarios). Refer the initialPreview
and initialCaption properties in the plugin options
section for configuring this.
7. Option to show/hide any or all of the following:
- caption section
- preview section
- upload button
- remove button
8. Customise the location of the target container elements to display the entire plugin, the caption container, the caption text, the preview container, preview image, and preview status.
9. For text file previews, autowrap the text to the thumbnail width, and show a wrap indicator link to display complete text on hover. You can customize the wrap indicator (which defaults to …).
10. Customise the messages for preview, progress, and files selected.
11. Upload action defaults to form submit. Supports an upload route/server action parameter for custom ajax based upload.
12. Triggers JQuery events for advanced development. Events currently available are filereset, fileclear, filecleared, fileloaded, and fileerror.
13. Disabled and readonly file input support.
14. Dynamically auto size the file captions for long file names exceeding container width.
15. Raise new fileimageuploaded event that fires after image is completely loaded on the preview container.
16. Autosize preview images when they exceed the size of the preview container.
17. Completely templatized and extensible to allow configuration of the file-input the way the developer wants.
18. Preview intelligence based on various file preview types. The inbuilt file support types are categorized as image, text, html, video, audio, flash, object, and other.
19. allowedPreviewTypes: You can now configure which all file types are allowed to be shown as a preview. This defaults to ['image', 'html', 'text', 'video', 'audio', 'flash', 'object']. Thus all file types are treated as an object to preview by default. For exampleTo preview only image and video, you can set this to ['image', 'video'].
20. allowedPreviewMimeTypes: In addition to allowedPreviewTypes, you can also control which all mime types can be displayed for preview. This defaults to null, meaning all mime types are supported.
>NOTE: With release 2.5.0 you can now control which file types or extensions are allowed for upload by setting allowedFileTypes and allowedFileExtensions.
21. layoutTemplates: Allows you to configure all layout template settings within one property. The layout objects that can be configured are: main1, main2, preview, caption, and modal.
22. previewTemplates: All preview templates for each preview type have been combined into one property, instead of separate templates for image, text etc. The keys are the formats as set in allowedPreviewTypes and values are the templates used for previewing. There are default prebuilt templates for each preview file type (generic, image, text, html, video, audio, flash, object, and other). The generic template is used only for displaying initialPreview content using direct markup.
23. previewSettings: Allows you to configure width and height for each preview image type. The plugin has default widths and heights predefined for each type i.e image, text, html, video, audio, flash, and object.
24. fileTypeSettings: Allows you to configure and identify each preview file type using a callback. The plugin has default callbacks predefined to identify each type i.e image, text, html, video, audio, flash, and object.
25. Replacing tags within templates has been enhanced. With this release it will automatically check for multiple occurrences of each tag to replace within a template string.
26. Manipulate events and add your own custom validation messages easily by returning output to abort uploads in any of the other events.
27. Support for translations and locales.

$3

With release 4.0.0, the plugin now also includes inbuilt support for AJAX Uploads and selectively adding or deleting files. AJAX upload functionality are
built upon HTML5 FormData and XMLHttpRequest Level 2 standards. Most modern browsers do support this standard, but the plugin will automatically degrade to normal form based submission for unsupported browsers.

1. Add functionality for AJAX based UPLOAD using HTML5 FormData (most modern browsers support it). Will degrade to normal Form Based File submission if this is not supported.
2. To use AJAX Upload, one must set the uploadUrl property.
3. Enhance plugin to now allow files to be added, appended, removed (based on FEEDBACK from many). Thus one can append files to preview.
4. New DRAG & DROP zone available in preview to drag and drop files and append.
5. Delete or upload files one by one OR in batch.
6. If showPreview is set to false, or uploadUrl is not supported plugin will degrade to normal form based upload.
7. Configurable indicators for file awaiting upload, file successfully uploaded, files errored in upload.
8. Ability to add extra form data with ajax based uploads.
9. Upload progress bar and individual thumbnail upload indicators.
10. Ability to cancel and abort ongoing AJAX uploads.
11. Build up initial preview content (e.g. gallery of saved images). You can set initial preview actions (prebuilt support for initial preview delete). Other custom action buttons can be set for initial preview thumbnails as well.
12. Ensure plugin is still lean in size and optimized for performance inspite of the above features by optimally utilizing HTML5 & jquery features only.
13. Automatically refresh preview with content from server as soon as an ajax upload finishes.
14. Ability to resize images has been added since release v4.2.7. The browser must support HTML5 canvas for resizing images. In addition, this release includes various enhancements for upload management without a preview.

> NOTE: Drag and Drop zone functionality, selectively appending or deleting files, and upload indicator with progress are ONLY AVAILABLE if you use AJAX BASED uploads (by setting uploadUrl).

Demo

View the plugin documentation and plugin demos at Krajee JQuery plugins.

Pre-requisites

1. Bootstrap 3.x
2. Latest JQuery
3. Most modern browsers supporting HTML5 (inputs and FileReader API) including CSS3 & JQuery. For Internet Explorer, one must use IE versions 10 and above. IE9 and below will work as a normal file input, and will not support multiple file selection or the HTML 5 FileReader API.
4. With release 4.0, AJAX uploads are supported. AJAX uploads require that the browser support HTML5 FormData and XHR2 (XMLHttpRequest 2). Most modern browsers support FormData and XHR2. The plugin will automatically degrade to normal form based submission for browsers not supporting AJAX uploads.

Installation

$3

You can use the bower package manager to install. Run:

bower install bootstrap-fileinput

$3

You can use the composer package manager to install. Either run:

$ php composer.phar require kartik-v/bootstrap-fileinput "@dev"

or add:

"kartik-v/bootstrap-fileinput": "@dev"

to your composer.json file

$3

You can also manually install the plugin easily to your project. Just download the source ZIP or TAR ball and extract the plugin assets (css and js folders) into your project.

Usage

Step 1: Load the following assets in your header.

``html










`

If you noticed, you need to load the jquery.min.js and bootstrap.min.css in addition to the fileinput.min.css and fileinput.min.js. The locale file fileinput_locale_.js can be optionally included for translating for your language if needed.

NOTE: The canvas-to-blob.min.js file is the source for the JavaScript-Canvas-to-Blob plugin by blueimp. It is required to be loaded before fileinput.js if you wish to use the image resize feature of the bootstrap-fileinput plugin. For ease of access, the plugin source for JavaScript-Canvas-to-Blob is included in the js/plugins folder of this project repository.

Step 2: Initialize the plugin on your page. For example,

`js
// initialize with defaults
$("#input-id").fileinput();

// with plugin options
$("#input-id").fileinput({'showUpload':false, 'previewFileType':'any'});
`

The #input-id is the identifier for the input (e.g. type = file) on your page, which is hidden automatically by the plugin.

Alternatively, you can directly call the plugin options by setting data attributes to your input field.

`html

`

Translations

As shown in the installation section, translations are now enabled with release 4.1.8. You can load a locale file /fileinput_locale_.js after the core fileinput.min.js file, where is the language code (e.g. de, fr etc.). If locale file does not exist, you can submit a translation for the new language via a new pull request to add to this folder. Use the sample locale file to copy and create a translation configuration for your own language.

Plugin Options

The plugin supports these following options:

$3

_string_ language configuration for the plugin to enable the plugin to display messages for your locale (you must set the ISO code for the language). You can have multiple language widgets on the same page. The locale JS file for the language code must be defined as mentioned in the translations section. The file must be loaded after fileinput.js.

$3

_boolean_ whether to display the file caption. Defaults to true.

$3

_boolean_ whether to display the file preview. Defaults to true.

$3

_boolean_ whether to display the file remove/clear button. Defaults to true.

$3

_boolean_ whether to display the file upload button. Defaults to true. This will default to a form submit button, unless the uploadUrl is specified.

$3

_boolean_ whether to display the file upload cancel button. Defaults to true. This will be only enabled and displayed when an AJAX upload is in process.

$3

_boolean_ whether to display the close icon in the preview. Defaults to true. This will be only parsed when showPreview is true or when you are using the {close} tag in your preview templates.

$3

_boolean_ whether to persist display of the uploaded file thumbnails in the preview window (for ajax uploads) until the remove/clear button is pressed. Defaults to true. When set to false, a next batch of files selected for upload will clear these thumbnails from preview.

$3

_boolean_ whether to automatically replace the files in the preview after the maxFileCount limit is reached and a new set of file(s) is/are selected. This will only work if a valid maxFileCount is set. Defaults to false.

$3

_string_ CSS class to be set for the button labels (i.e. browse, remove, upload, and cancel). Defaults to hidden-xs, whereby labels are hidden for small screen devices.

$3

_string_ any additional CSS class to append to the caption container.

$3

_string_ any additional CSS class to append to the preview container.

$3

_string_ any additional CSS class to append to the main plugin container.

$3

_string_, the delimiter to be used to allow passing multiple content delimited as a string to initialPreview. Defaults to '$$'.

$3

_string | array_ the initial preview content to be displayed. You can pass the minimal HTML markup for displaying your image, text, or file.
If set as a string, this will display a single file in the initial preview if there is no delimiter. You can set a delimiter (as defined
in initialDelimiter) to show multiple files in initial preview. If set as an array, it will display all files in the array as an
initial preview (useful for multiple file upload scenarios).

The following CSS classes will need to be added for displaying each file type as per the plugin style theme:

- image files: Include CSS class file-preview-image
- text files: Include CSS class file-preview-text
- other files: Include CSS class file-preview-other

Examples of how you can setup various files for initial preview:

`js
// for image files
initialPreview: [
"",
"",
],

// for text files
initialPreview: "

" +
"This is the sample text file content upto wrapTextLength of 250 characters" +
"[…]" +
"

"

// for other files
initialPreview: "

" +
"

" +
"Filename.xlsx" + "

"
`

$3

_int_, the count of initial preview items that will be added to the count of files selected in preview. This is applicable when displaying
the right caption, when overwriteInitial is set to false.

$3

_string_, the delimiter to be used for splitting the initial preview content as individual file thumbnails (applicable only if initialPreview is passed as a _string_ instead of _array_). Defaults to $$.

$3

_array_, the configuration for setting up important properties for each initialPreview item (that is setup as part of initialPreview). Each element in the array should be an object/associative array consisting of the following keys:

- caption: _string_, the caption or filename to display for each initial preview item content.
- width: _string_, the CSS width of the image/content displayed.
- url: _string_, the URL for deleting the image/content in the initial preview via AJAX post response. This will default to deleteUrl if not set.
- key: _string|object_, the key that will be passed as data to the url via AJAX POST.
- frameClass: _string_, the additional frame css class to set for the file's thumbnail frame.
- frameAttr: _object_, the HTML attribute settings (set as key:value pairs) for the thumbnail frame.
- extra: _object|function_, the extra data that will be passed as data to the initial preview delete url/AJAX server call via POST. This will default to deleteExtraData if not set.

An example configuration of initialPreviewConfig (for the previously set initialPreviewContent) can be:

`js
// setup initial preview with data keys
initialPreview: [
"",
"",
],
// initial preview configuration
initialPreviewConfig: [
{
caption: 'desert.jpg',
width: '120px',
url: '/localhost/avatar/delete',
key: 100,
extra: {id: 100}
},
{
caption: 'jellyfish.jpg',
width: '120px',
url: '/localhost/avatar/delete',
key: 101,
frameClass: 'my-custom-frame-css',
frameAttr: {
style: 'height:80px',
title: 'My Custom Title',
},
extra: function() {
return {id: $("#id").val()};
},
}
]
`

> Note: The ajax delete action will send the following data to server via POST:
- key: the key setting as setup in initialPreviewConfig['key']
- any other extra data as key: value pairs passed either via initialPreviewConfig['extra'] OR deleteExtraData format if former is not set.

$3

_bool_, whether the delete button will be displayed for each thumbnail that has been created with initialPreview.

$3

_array_, this will be a list of tags used in thumbnail templates that will be replaced dynamically within the thumbnail markup, when the thumbnail is rendered. For example:

`js
// change thumbnail footer template
layoutTemplates.footer = '

\n' +
'

{caption}

\n' +
' {CUSTOM_TAG_NEW}\n' +
' {CUSTOM_TAG_INIT}\n' +
' {actions}\n' +
'

';

// set preview template tags
previewThumbTags = {
'{CUSTOM_TAG_NEW}': 'CUSTOM MARKUP',
'{CUSTOM_TAG_INIT}': ' '
};
`

$3

_array_, this is an extension of previewThumbTags specifically for initial preview content - but will be configured as an array of objects corresponding to each initial preview thumbnail. The initial preview thumbnails set via initialPreview will read this configuration for replacing tags. Extending example above:


`js
// change thumbnail footer template
layoutTemplates.footer = '

\n' +
'

{caption}

\n' +
' {CUSTOM_TAG_NEW}\n' +
' {CUSTOM_TAG_INIT}\n' +
' {actions}\n' +
'

';

// setup initial preview with data keys
initialPreview: [
"",
"",
],

// set initial preview template tags
initialPreviewThumbTags = {
'{CUSTOM_TAG_NEW}': ' ',
'{CUSTOM_TAG_INIT}': 'CUSTOM MARKUP'
};
`

$3

_object | function_ the extra data that will be passed as data to the initial preview delete url/AJAX server call via POST. This will be overridden by the initialPreviewConfig['extra'] property. This can be setup either as an object (associative array of keys and values) or as a function callback. As an object, it can be set for example as:

`js
{id: 100, value: '100 Details'}
`

As a function callback, it can be setup for example as:

`js
function() {
var obj = {};
$('.your-form-class').find('input').each(function() {
var id = $(this).attr('id'), val = $(this).val();
obj[id] = val;
});
return obj;
}
`

$3

_object | function_ the URL for deleting the image/content in the initial preview via AJAX post response. This will be overridden by the initialPreviewConfig['url'] property.

$3

_string_ the initial preview caption text to be displayed. If you do not set a value here and initialPreview is set to
true this will default to "{preview-file-count} files selected", where {preview-file-count} is the count of the
files passed in initialPreview.

$3

_boolean_ whether you wish to overwrite the initial preview content and caption setup. This defaults to true, whereby, any initialPreview content set
will be overwritten, when new file is uploaded or when files are cleared. Setting it to false will help displaying a saved image or file from database always -
useful especially when using the multiple file upload feature.

$3

_object_ the templates configuration for rendering each part of the layout. You can set the following templates to control the widget layout:

- main1: the template for rendering the widget with caption.
- main2: the template for rendering the widget without caption.
- preview: the template for rendering the preview.
- icon: the icon to render before the caption text.
- caption: the template for rendering the caption.
- modal: the template for rendering the modal (for text file preview zooming).
- progress: the template for the progress bar when upload is in progress (for batch/mass uploads and within each preview thumbnail for async/single uploads). The upload progress bar when displayed within each thumbnail will be wrapped inside a container having a CSS class of file-thumb-progress. The following tags will be parsed and replaced automatically:
- {percent}: will be replaced with the upload progress percentage.
- footer: the template for the footer section of each file preview thumbnail. The following tags will be parsed and replaced automatically:
- {actions}: will be replaced with the output of the actions template.
- actions: the template for the file action buttons to be displayed within the thumbnail footer. The following tags will be parsed and replaced automatically:
- {upload}: will be replaced with the output of the actionUpload template.
- {delete}: will be replaced with the output of the actionDelete template.
- actionDelete: the template for the file delete action button within the thumbnail footer. The following tags will be parsed and replaced automatically:
- {removeClass}: the css class for the remove button. Will be replaced with the removeClass set within fileActionSettings.
- {removeIcon}: the icon for the remove button. Will be replaced with the removeIcon set within fileActionSettings.
- {removeTitle}: the title to display on hover for the remove button. Will be replaced with the removeTitle set within fileActionSettings.
- {dataUrl}: the URL for deleting the file thumbnail for initialPreview content only. Will be replaced with the url set within initialPreviewConfig.
- {dataKey}: the key (additional data) that will be passed to the URL above via POST to the AJAX call. Will be replaced with the key set within initialPreviewConfig.
- actionUpload: the template for the file upload action button within the thumbnail footer.
- {uploadClass}: the css class for the upload button. Will be replaced with the uploadClass set within fileActionSettings.
- {uploadIcon}: the icon for the upload button. Will be replaced with the uploadIcon set within fileActionSettings.
- {uploadTitle}: the title to display on hover for the upload button. Will be replaced with the uploadTitle set within fileActionSettings.

The main1 and main2 templates would automatically parse the following tags for replacement:

- {class}: the CSS class as set in the mainClass property.
- {close}: will be replaced with the close (cross) icon (by default on top right of the preview window). The layout template to control this markup is layoutTemplates.close.
- {preview}: the content parsed by the previewTemplate and will be displayed only if showPreview is true.
- {caption}: the content parsed by the captionTemplate and will be displayed only if showCaption is true.
- {remove}: the file remove/clear button and will be displayed only if showRemove is true.
- {upload}: the file upload button and will be displayed only if showUpload is true.
- {cancel}: the file upload cancel button that will be displayed when AJAX upload is in process to abort the AJAX upload.
- {browse}: the main file browse button to select your files for input.

The preview and caption templates can understand the following special tags which will be replaced:

- {class}: the CSS class as set in the mainClass, captionClass or previewClass properties.

Similarly, the progress layout template can understand the following special tags which will be replaced:

- {class}: the CSS class as set in the progressClass or progressCompleteClass properties.

The layoutTemplates if not set will default to:

`js
{
main1: '{preview}\n' +
'

\n' +
'

\n' +
' {caption}\n' +
'

\n' +
' {remove}\n' +
' {cancel}\n' +
' {upload}\n' +
' {browse}\n' +
'

\n' +
'

',
main2: '{preview}\n

\n{remove}\n{cancel}\n{upload}\n{browse}\n',
preview: '

\n' +
' {close}\n' +
'

\n' +
'

\n' +
'

\n' +
'

' +
'

\n' +
'

\n' +
'

\n' +
'

',
close: '

×

',
icon: '',
caption: '

\n' +
' …\n' +
'

\n' +
'

',
btnDefault: '{icon}{label}',
btnLink: '{icon}{label}',
btnBrowse: '

{icon}{label}

',
modal: '

\n' +
'

\n' +
'

\n' +
'

\n' +
' ×\n' +
'

{heading} {title}

\n' +
'

\n' +
'

\n' +
' {body}\n' +
'

\n' +
'

\n' +
'

\n' +
'

',
zoom: '\n' +
' {zoomInd}\n' +
'\n',
progress: '

\n' +
'

\n' +
' {percent}%\n' +
'

\n' +
'

',
footer: '

\n' +
'

{caption}

\n' +
' {progress} {actions}\n' +
'

',
actions: '

\n' +
'

\n' +
' {upload}{delete}{other}' +
'

\n' +
'

{indicator}

\n' +
'

\n' +
'

',
actionDelete: '{removeIcon}\n',
actionUpload: '{uploadIcon}\n'
};
`

$3

_object_ the templates configuration for rendering each preview file type. The following file types are recognized:

- image: the preview template for image files.
- text: the preview template for text files.
- html: the preview template for html files.
- video: the preview template for video files (supported by HTML 5 video tag).
- audio: the preview template for audio files (supported by HTML 5 audio tag).
- flash: the preview template for flash files (supported currently on webkit browsers).
- object: the preview template for all other files - by default treated as object. To disable this behavior, configure the allowedPreviewTypes property.
- generic: this template is used ONLY for rendering the initialPreview markup content passed directly as a raw format.

The following tags will be parsed and replaced in each of the templates:

- {previewId}: will be replaced with the generated identifier for the preview frame container.
- {data}: will be replaced with the data source for each preview type.
- {width}: will be replaced with the width for the file type as set in previewSettings.
- {height}: will be replaced with the height for the file type as set in previewSettings.
- {caption}: will be replaced with the file name.
- {type}: will be replaced with the file type.
- {content}: this is applicable only for the generic template. It will be replaced with the raw HTML markup as set in initialPreview. None of
the above tags will be parsed for the generic template.
- {dialog}: currently applicable only for text file previews. Will be replaced with the JS code to launch the modal dialog.
- {zoomTitle}: currently applicable only for text file previews. This will be replaced with the msgZoomTitle property. This is the title that is displayed on hover of the zoom button (which on clicking will display the text file).
- {zoomInd}: currently applicable only for text file previews. This will be replaced with the zoomIndicator property. This is the title that is displayed on hover of the zoom button (which on clicking will display the text file).
- {heading}: currently applicable only for text file previews. This represents the modal dialog heading title. This will be replaced with the msgZoomModalHeading property.

The following templates will be used in rendering the main buttons for upload, remove, cancel, and browse.

- btnDefault: The template for upload, remove, and cancel buttons
- btnLink: The template for upload button when used with ajax (i.e. when uploadUrl is set).
- btnBrowse: The template for the browse button.

The following tags will be parsed and auto replaced in the above button templates:

- {type}: the HTML button type, defaults to button for most buttons and submit for form based uploads
- {title}: the title to display on button hover.
- {css}: the CSS class for the button. This is derived from settings for uploadClass or removeClass or cancelClass or browseClass.
- {status}: the disabled status for the button if available (else will be blank).
- {icon}: the button icon as identified by uploadIcon or removeIcon or cancelIcon or browseIcon.
- {label}: the button label as identified by uploadLabel or removeLabel or cancelLabel or browseLabel.
- {href}: applicable only for Upload button for ajax uploads and will be replaced with the uploadUrl property.

The previewTemplates if not set will default to:

`js
{
generic: '

\n' +
' {content}\n' +
' {footer}\n' +
'

\n',
html: '

\n' +
' \n' +
' {footer}\n' +
'

',
image: '

\n' +
' \n' +
' {footer}\n' +
'

\n',
text: '

\n' +
'

{data}

\n' +
' \n' +
' {zoomInd}\n' +
' \n' +
' {footer}\n' +
'

',
video: '

\n' +
' \n' +
' {footer}\n' +
'

\n',
audio: '

\n' +
' \n' +
' {footer}\n' +
'

\n',
flash: '

\n' +
' \n' +
' {footer}\n' +
'

\n',
object: '

\n' +
' \n' +
' {footer}\n' +
'

',
other: '

' title="{caption}" ' + STYLE_SETTING + '>\n' +
'

\n'+
' ' + DEFAULT_PREVIEW + '\n' +
'

\n' +
'

{footer}

\n' +
'

'
}
`

The values of the constants used in the above templates are as follows:

`js
STYLE_SETTING = 'style="width:{width};height:{height};"',
OBJECT_PARAMS = ' \n' +
' \n' +
' \n' +
' \n' +
' \n'+
' \n',
DEFAULT_PREVIEW = '

\n' +
' {previewFileIcon}\n' +
'

'
`

where:

- {previewFileIcon}: corresponds to the previewFileIcon property.
- {previewFileIconClass}: corresponds to the previewFileIconClass property.

$3

_array_ the list of allowed file types for upload. This by default is set to null which means the plugin supports all file types for upload. If an
invalid file type is found, then a validation error message as set in msgInvalidFileType will be raised. The following types as set in fileTypeSettings
are available for setup.

`js
['image', 'html', 'text', 'video', 'audio', 'flash', 'object']
`

$3

_array_ the list of allowed file extensions for upload. This by default is set to null which means the plugin supports all file extensions for upload. If an
invalid file extension is found, then a validation error message as set in msgInvalidFileExtension will be raised. An example of setting this could be:

`js
['jpg', 'gif', 'png', 'txt']
`

> NOTE: You need to be careful in case you are setting both allowedFileTypes and allowedFileExtensions. In this case, the allowedFileTypes property
is validated first and generally precedes the allowedFileExtensions setting (and the latter validation maybe skipped).

$3

_array_ the list of allowed preview types for your widget. This by default supports all file types for preview. The plugin by default treats each
file as an object if it does not match any of the previous types. To disable this behavior, you can remove object from the list of allowedPreviewTypes
OR fine tune it through allowedPreviewMimeTypes. To disable content preview for all file-types and show the previewIcon instead as a thumbnail, set this to null, empty, or false.

This is by default setup as following:
`js
['image', 'html', 'text', 'video', 'audio', 'flash', 'object']
`

$3

_array_ the list of allowed mime types for preview. This is set to null by default which means all possible mime types are allowed. This setting works in combination with allowedPreviewTypes to filter only the needed file types allowed for preview. You can check this list of allowed mime types to add to this list if needed.

$3

_string_ the default content / markup to show by default in the preview window whenever the files are cleared or the input is cleared. This can be useful for use cases like showing the default user profile picture or profile image before upload to overwrite. This is a bit different from initialPreview in the sense, that the initialPreview content will always be displayed unless it is deleted or overwritten based on overwriteInitial. The defaultPreviewContent on the other hand will only be shown ONLY on initialization OR whenever you clear the preview. At other times when files have been selected this will be overwritten temporarily until file(s) selected is/are cleared.

$3

_object_ the list of additional custom tags that will be replaced in the layout templates. This should be an associative array object of key: value pairs, where:

- key: _string_, is the tag to be replaced and as a standard is recommended to be enclosed between braces.
- value: _string|function_, is the value that will replace the tag key above. This can be setup either as a string or callback function.

For example:

`js
// example 1 - tags with value set as string
customLayoutTags: {
'{tagA}': 'Tag A',
'{tagB}': 'Tag B',
}

// example 2 - tags with value set as callback
customLayoutTags: {
'{tagC}': function() {
return $("#element-id").val();
}
}
`

$3

_object_ the list of additional custom tags that will be replaced in the preview templates. This should be an associative array object of key: value pairs, where:

- key: _string_, is the tag to be replaced and as a standard is recommended to be enclosed between braces.
- value: _string|function_, is the value that will replace the tag key above. This can be setup either as a string or callback function.

For example:

`js
// example 1 - tags with value set as string
customPreviewTags: {
'{tagA}': 'Tag A',
'{tagB}': 'Tag B',
}

// example 2 - tags with value set as callback
customPreviewTags: {
'{tagC}': function() {
return $("#element-id").val();
}
}
`

$3

_object_ the format settings (width and height) for rendering each preview file type. This is by default setup as following:

`js
{
image: {width: "auto", height: "160px"},
html: {width: "213px", height: "160px"},
text: {width: "160px", height: "136px"},
video: {width: "213px", height: "160px"},
audio: {width: "213px", height: "80px"},
flash: {width: "213px", height: "160px"},
object: {width: "160px", height: "160px"},
other: {width: "160px", height: "160px"}
}
`

$3

_object_ the settings to validate and identify each file type when a file is selected for upload. This is a list of callbacks, which accepts the file mime type and file name as a parameter.
This is by default setup as following:

`js
// vType: is the file mime type
// vName: is the file name
{
image: function(vType, vName) {
return (typeof vType !== "undefined") ? vType.match('image.*') : vName.match(/\.(gif|png|jpe?g)$/i);
},
html: function(vType, vName) {
return (typeof vType !== "undefined") ? vType == 'text/html' : vName.match(/\.(htm|html)$/i);
},
text: function(vType, vName) {
return typeof vType !== "undefined" && vType.match('text.*') || vName.match(/\.(txt|md|csv|nfo|php|ini)$/i);
},
video: function (vType, vName) {
return typeof vType !== "undefined" && vType.match(/\.video\/(ogg|mp4|webm)$/i) || vName.match(/\.(og?|mp4|webm)$/i);
},
audio: function (vType, vName) {
return typeof vType !== "undefined" && vType.match(/\.audio\/(ogg|mp3|wav)$/i) || vName.match(/\.(ogg|mp3|wav)$/i);
},
flash: function (vType, vName) {
return typeof vType !== "undefined" && vType == 'application/x-shockwave-flash' || vName.match(/\.(swf)$/i);
},
object: function (vType, vName) {
return true;
},
other: function (vType, vName) {
return true;
},
}
`

$3

_string_ the default icon to be shown in each preview file thumbnail when an unreadable file type for preview is detected. Defaults to .

$3

_string_ the CSS class to be applied to the preview file icon container. Defaults to file-icon-4x.

$3

_object_ the preview icon markup settings for each file extension (type). You need to set this as key: value pairs, where the key corresponds to a file extension (e.g. doc, docx, xls etc.), and the value corresponds to the markup of the icon to be rendered. If this is not set OR a file extension is not set here, the preview will default to previewFileIcon. Note that displaying the icons instead of file content is controlled via allowedPreviewTypes and allowedPreviewMimeTypes.

You can setup previewFileIconSettings as shown below:

`js
previewFileIconSettings: {
'doc': '',
'xls': '',
'ppt': '',
'jpg': '',
'pdf': '',
'zip': '',
}
`

$3

_object_ the extensions to be auto derived for each file extension (type). This is useful if you want to set the same icon for multiple file extension types. You need to set this as key: value pairs, where the key corresponds to a file extension as set in previewFileIconSettings (e.g. doc, docx, xls etc.). The value will be a function callback that accepts the following parameter:

- ext: _string_, the file extension (without the . [dot]) of the file currently selected in the preview

You can configure the callback to match the set of file extensions (via regex or similar) for each key and return a boolean output if the file extension matches.

For example, you can setup previewFileExtSettings as shown below:

`js
previewFileExtSettings: {
'doc': function(ext) {
return ext.match(/(doc|docx)$/i);
},
'xls': function(ext) {
return ext.match(/(xls|xlsx)$/i);
},
'ppt': function(ext) {
return ext.match(/(ppt|pptx)$/i);
}
}
`

$3

_string_ the label to display for the file picker/browse button. Defaults to Browse ….

$3

_string_ the icon to display before the label for the file picker/browse button. Defaults to  .

$3

_string_ the CSS class for the file picker/browse button. Defaults to btn btn-primary.

$3

_string_ the label to display for the file remove button. Defaults to Remove.

$3

_string_ the icon to display before the label for the file picker/remove button. Defaults to  .

$3

_string_ the CSS class for the file remove button. Defaults to btn btn-default.

$3

_string_ the title to display on hover for the file remove button. Defaults to Clear selected files.

$3

_string_ the label to display for the file cancel button. Defaults to Cancel.

$3

_string_ the icon to display before the label for the file picker/remove button. Defaults to  .

$3

_string_ the CSS class for the file cancel button. Defaults to btn btn-default.

$3

_string_ the title to display on hover for the file cancel button. Defaults to Abort ongoing upload.

$3

_string_ the label to display for the file upload button. Defaults to Upload.

$3

_string_ the icon to display before the label for the file upload button. Defaults to  .

$3

_string_ the CSS class for the file upload button. Defaults to btn btn-default.

$3

_string_ the title to display on hover for the file remove button. Defaults to Upload selected files.

$3

_string_ the URL for the upload processing action (typically for ajax based processing). Defaults to null. If this is not set or null, then the upload button action will default to form submission. NOTE: This is MANDATORY if you want to use advanced features like drag & drop, append/remove files, selectively upload files via ajax etc.

$3

_bool_ whether the batch upload of multiple files will be asynchronous/in parallel. Defaults to true.

$3

_object | function_ the extra data that will be passed as data to the url/AJAX server call via POST. This can be setup either as an object (associative array of keys and values) or as a function callback. As an object, it can be set for example as:

`js
{id: 100, value: '100 Details'}
`

As a function callback, the uploadExtraData can be setup as shown below. Note that for uploading individual file via thumbnail, the callback can also receive the thumbnail previewId and index as parameters. These are described below:

- previewId: the identifier for the preview file container (only available when uploading each thumbnail file)
- index: the zero-based sequential index of the loaded file in the preview list (only available when uploading each thumbnail file)

`js
// previewId and index is only available for individual file upload via the thumbnail
function (previewId, index) {
var obj = {};
$('.your-form-class').find('input').each(function() {
var id = $(this).attr('id'), val = $(this).val();
obj[id] = val;
});
return obj;
}
`

$3

_int_ the minimum allowed image width in px if you are uploading image files. Defaults to null which means no limit on image width.

$3

_int_ the minimum allowed image height in px if you are uploading image files. Defaults to null which means no limit on image height.

$3

_int_ the maximum allowed image width in px if you are uploading image files. Defaults to null which means no limit on image width. Note that if you set resizeImage property to true, then the entire image will be resized within this width.

$3

_int_ the maximum allowed image height in px if you are uploading image files. Defaults to null which means no limit on image height. Note that if you set resizeImage property to true, then the entire image will be resized within this height.

$3

_bool_ whether to add ability to resize uploaded images. Defaults to false. Note that resizing images requires HTML5 canvas support which is supported on most modern browsers. In addition, you must include the JavaScript-Canvas-to-Blob plugin by blueimp by including canvas-to-blob.js in your application. This JS file must be loaded before fileinput.js on the page. The JavaScript-Canvas-to-Blob source files are available in js/plugins folder of bootstrap-fileinput project page. The canvas-to-blob.js plugin is a polyfill for canvas.toBlob method and is needed for allowing the resized image files via HTML5 canvas to be returned as a blob.

$3

_string_ preference to resize the image based on width or height. Defaults to width. This property is parsed only when resizeImage is true. If set to width, the maxImageWidth property is first tested and if image size is greater than this, then the image is resized to maxImageWidth. The image height is resized and adjusted in the same ratio as width. In case, the image width is already less than maxImageWidth then the maxImageHeight property is used to resize and width is adjusted in same ratio.

This will behave conversely, when resizePreference is set to height - the maxImageHeight will be first tested against image height and then the rest of steps will be similarly parsed with preference given to height instead of width as before. For example:

`php
// Example for resizePreference = 'width'
// - will resize image width to 200 px if image width is > 200 px
// - will resize image height to 200 px if image width is < 200 px and
// image height is > 200 px
// if none of the above image will be returned as is
$('#file-input').fileinput({
resizeImage: true,
maxImageWidth: 200,
maxImageHeight: 200,
resizePreference: 'width'
});
`

$3

_float_ the quality of the resized image. This must be a decimal number between 0.00 to 1.00. Defaults to 0.92.

$3

_string_ the default image mime type of the converted image after resize. Defaults to image/jpeg.

$3

_float_ the maximum file size for upload in KB. If set to 0, it means size allowed is unlimited. Defaults to 0.

$3

_int_ the minimum number of files allowed for each multiple upload. If set to 0, it means number of files are optional. Defaults to 0.

$3

_int_ the maximum number of files allowed for each multiple upload. If set to 0, it means number of files allowed is unlimited. Defaults to 0.

$3

_boolean_ whether to include initial preview file count (server uploaded files) in validating minFileCount and maxFileCount. Defaults to false.

$3

_string_ the title displayed (before the file name) on hover of the zoom button for zooming the file content in a modal window. This is currently applicable only for text file previews. Defaults to View details.

$3

_string_ the heading of the modal dialog that displays the zoomed file content. This is currently applicable only for text file previews. This is currently applicable only for text file previews. Defaults to Detailed Preview.

$3

_string_ the message to be displayed when the file size exceeds maximum size. Defaults to:

`
File "{name}" ({size} KB) exceeds maximum allowed upload size of {maxSize} KB. Please retry your upload!
`
where:

- {name}: will be replaced by the file name being uploaded
- {size}: will be replaced by the uploaded file size
- {maxSize}: will be replaced by the maxFileSize parameter.

$3

_string_ the message to be displayed when the file count is less than the minimum count as set in minFileCount. Defaults to:

`
You must select at least {n} {files} to upload. Please retry your upload!
`

where:

- {n}: will be replaced by the allowed minimum files as set in minFileCount
- {files}: will be replaced with fileSingle or filePlural properties in locale file depending on the minFileCount.

$3

_string_ the message to be displayed when the file count exceeds maximum count as set in maxFileCount. Defaults to:

`
Number of files selected for upload ({n}) exceeds maximum allowed limit of {m}. Please retry your upload!
`

where:

- {n}: will be replaced by number of files selected for upload
- {m}: will be replaced by the allowed maximum files as set in maxFileCount

$3

_string_ the exception message to be displayed when the file selected is not found by the FileReader. Defaults to:

`
File "{name}" not found!
`
where:

- {name}: will be replaced by the file name being uploaded

$3

_string_ the exception message to be displayed when the file selected is not allowed to be accessed due to a security exception. Defaults to:

`
Security restrictions prevent reading the file "{name}".
`
where:

- {name}: will be replaced by the file name being uploaded

$3

_string_ the exception message to be displayed when the file selected is not readable by the FileReader API. Defaults to:

`
File "{name}" is not readable.
`
where:

- {name}: will be replaced by the file name being uploaded

$3

_string_ the exception message to be displayed when the file preview upload is aborted. Defaults to:

`
File preview aborted for "{name}".
`
where:

- {name}: will be replaced by the file name being uploaded

$3

_string_ the exception message to be displayed for any other error when previewing the file. Defaults to:

`
An error occurred while reading the file "{name}".
`
where:

- {name}: will be replaced by the file name being uploaded

$3

_string_ the message to be displayed when the file type is not in one of the file types set in allowedFileTypes. Defaults to:

`
Invalid type for file "{name}". Only "{types}" files are supported.
`
where:

- {name}: will be replaced by the file name being uploaded
- {types}: will be replaced by the comma separated list of types defined in allowedFileTypes.

$3

_string_ the message to be displayed when the file type is not in one of the file extensions set in allowedFileExtensions. Defaults to:

`
Invalid extension for file "{name}". Only "{extensions}" files are supported.
`
where:

- {name}: will be replaced by the file name being uploaded
- {extensions}: will be replaced by the comma separated list of extensions defined in allowedFileExtensions.

$3

_string_ the message to be displayed when an ongoing ajax file upload is aborted by pressing the Cancel button. Defaults to The file upload was aborted. If this is set to null or empty, the internal ajax error message will be displayed.

$3

_string_ the exception message to be displayed within the caption container (instead of msgFilesSelected),
when a validation error is encountered. Defaults to File Upload Error.

$3

_string_ the css class for the validation error message displayed in the caption container. Defaults to text-danger.

$3

_string_ the icon to be displayed before the validation error in the caption container. Defaults to .

$3

_string_ the css class for the error message to be displayed in the preview window when the file size exceeds maxSize. Defaults to file-error-message.

$3

_string_ the message displayed when the files are getting read and loaded for preview. Defaults to

`Loading file {index} of {files} …`

The following special variables will be replaced:

- {index}: the sequence number of the current file being loaded.
- {files}: the total number of files selected for upload.

$3

_string_ the progress message displayed as each file is loaded for preview. Defaults to:

`Loading file {index} of {files} - {name} - {percent}% completed.`

The following variables will be replaced:

- {index}: the sequence number of the current file being loaded.
- {files}: the total number of files selected for upload.
- {percent}: the percentage of file read and loaded.
- {name}: the name of the current file being loaded.

$3

_string_ the progress message displayed in caption window when multiple (more than one) files are selected. Defaults to {n} files selected. The following variables will be replaced:

- {n}: the number of files selected.

$3

_string_ the message displayed when a folder has been dragged to the drop zone. Defaults to Drag & drop files only! {n} folder(s) dropped were skipped.. The following variables will be replaced The following variables will be replaced:

- {n}: the number of folders dropped.

$3

_string_ the exception message to be displayed when the file selected for preview is an image and its width is less than the minImageWidth setting. Defaults to:

`
Width of image file "{name}" must be at least {size} px.
`
where:

- {name}: will be replaced by the file name being uploaded
- {size}: will be replaced by the minImageWidth setting.

$3

_string_ the exception message to be displayed when the file selected for preview is an image and its height is less than the minImageHeight setting. Defaults to:

`
Width of image file "{name}" must be at least {size} px.
`
where:

- {name}: will be replaced by the file name being uploaded
- {size}: will be replaced by the minImageHeight setting.

$3

_string_ the exception message to be displayed when the file selected for preview is an image and its width exceeds the maxImageWidth setting. Defaults to:

`
Width of image file "{name}" cannot exceed {size} px.
`
where:

- {name}: will be replaced by the file name being uploaded
- {size}: will be replaced by the maxImageWidth setting.

$3

_string_ the exception message to be displayed when the file selected for preview is an image and its height exceeds the maxImageHeight setting. Defaults to:

`
Height of image file "{name}" cannot exceed {size} px.
`
where:

- {name}: will be replaced by the file name being uploaded
- {size}: will be replaced by the maxImageHeight setting.

$3

_string_ the error message to be displayed when a resize validation error occurs due to invalid image dimensions. Defaults to:

`
Could not get the image dimensions to resize.
`

$3

_string_ the exception message to be displayed when any javascript exception is thrown during resizing of the image. Defaults to:

`
Error while resizing the image.

{errors}

.
`
where:

- {errors}: will be replaced with the exception error message.

$3

_string_ the upload progress bar CSS class to be applied when AJAX upload is in process (applicable only for ajax uploads). Defaults to progress-bar progress-bar-success progress-bar-striped active.

$3

_string_ the upload progress bar CSS class to be applied when AJAX upload is complete. Defaults to progress-bar progress-bar-success.

$3

_string_ the type of files that are to be displayed in the preview window. Defaults to image. Can be one of the following:

- image: Only image` type files will be shown in preview.