The FileInput widget is a wrapper for the Bootstrap File Input JQuery Plugin designed by Krajee. This plugin enhances the HTML 5 file input for Bootstrap 5.x / 4.x / 3.x with file preview for images and text, multiple selection, and more. The widget enhances the default HTML file input with various features including the following:
\kartik\widgets
namespace, this widget can be also installed from the yii2-widget-fileinput repository
and can also be accessed via \kartik\file\FileInput
namespace.
The widget runs on all modern browsers supporting HTML5 File Inputs and File Processing API. For browsers not supporting Javascript/Jquery this widget will gracefully degrade to normal HTML file input.
Not seeing the updated content on this page! Hard refresh your browser to clean cache for this page (e.g. SHIFT-F5 on Windows Chrome)
FileInput
supports configuration of the bootstrap library version so that you can use this either with any Bootstrap version 3.x and above. For setting up the bootstrap version for your extension, you can configure the FileInput::bsVersion
property to one of the following.
To use with bootstrap 3 library - you can set FileInput::bsVersion
property to any string starting with 3 (e.g. 3
or 3.3.7
or 3.x
)
To use with bootstrap 4 library - you can set FileInput::bsVersion
property to any string starting with 4 (e.g. 4
or 4.6.0
or 4.x
)
To use with bootstrap 5 library - you can set FileInput::bsVersion
property to any string starting with 5 (e.g. 5
or 5.1.0
or 5.x
)
Generally, you may also want to set a default version globally for all Krajee Extensions (instead of setting it for each widget or extension separately). In order to do this, you can setup the bsVersion
property within Yii 2 application params (i.e. Yii::$app->params['bsVersion']
). To set this up, add this section of code to your application params configuration file (e.g. config/params.php
):
'params' => [ 'bsVersion' => '5.x', // this will set globally `bsVersion` to Bootstrap 5.x for all Krajee Extensions // other settings // 'adminEmail' => 'admin@example.com' ]
If FileInput::bsVersion
property is set, in addition to Yii::$app->params['bsVersion']
, the extension level setting (FileInput::bsVersion
property) will override the Yii::$app->params['bsVersion']
. If FileInput::bsVersion
property is not set, and Yii::$app->params['bsVersion']
is also not set, FileInput::bsVersion
property will default to 3.x
(i.e. Bootstrap 3.x version will be assumed as default).
You need to install one of yiisoft/yii2-bootstrap
or yiisoft/yii2-bootstrap4
or yiisoft/yii2-bootstrap5
extensions manually in your application to enable Bootstrap 3.x or 4.x or 5.x functionality respectively. This dependency has not been pre-built into the composer configuration for Krajee extensions, to allow better control to the developers in configuring their bootstrap library version. If bsVersion
is set to 5.x
and yiisoft/yii2-bootstrap5
is not installed, then an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap5
extension. If bsVersion
is set to 4.x
and yiisoft/yii2-bootstrap4
is not installed, then an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap4
extension. Similarly, if bsVersion
is set to 3.x
and yiisoft/yii2-bootstrap
is not installed, an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap
extension.
To install yiisoft/yii2-bootstrap5
, add the repo to the require
section of your application's composer.json.
"yiisoft/yii2-bootstrap5": "@dev"
To install yiisoft/yii2-bootstrap4
, add the repo to the require
section of your application's composer.json.
"yiisoft/yii2-bootstrap4": "@dev"
To install yiisoft/yii2-bootstrap
, add the repo to the require
section of your application's composer.json.
"yiisoft/yii2-bootstrap": "@dev"
The Krajee extension asset bundle(s) by default depend on one of the following asset bundles to load the Bootstrap CSS and JS:
yii\bootstrap\BootstrapAsset
and/or yii\bootstrap\BootstrapPluginAsset
for bootstrap 3.x (bsVersion = 3
setting)
yii\bootstrap4\BootstrapAsset
and/or yii\bootstrap4\BootstrapPluginAsset
for bootstrap 4.x ( bsVersion = 4
setting)
yii\bootstrap5\BootstrapAsset
and/or yii\bootstrap5\BootstrapPluginAsset
for bootstrap 5.x (bsVersion = 5
setting)
This is controlled by the property bsDependencyEnabled
within the asset bundle (which defaults to true
). One can override this and prevent the default yii2 bootstrap assets (CSS & JS) from loading by doing one or all of the following:
Global Override: Set Yii::$app->params['bsDependencyEnabled']
to false
in your Yii 2 application config params.php
. This setting will be applied for all Krajee Extension Asset Bundles that depend on Bootstrap assets.
'params' => [ 'bsDependencyEnabled' => false, // this will not load Bootstrap CSS and JS for all Krajee extensions // you need to ensure you load the Bootstrap CSS/JS manually in your view layout before Krajee CSS/JS assets // // other params settings below // 'bsVersion' => '5.x', // 'adminEmail' => 'admin@example.com' ]
Asset Bundle Specific Override: Set bsDependencyEnabled
to false
for the specific asset bundle within Yii2 Asset Manager component in your Yii 2 application config file.
// ... 'components' => [ 'assetManager' => [ 'bundles' => [ 'kartik\form\ActiveFormAsset' => [ 'bsDependencyEnabled' => false // do not load bootstrap assets for a specific asset bundle ], ], ], ],
When setting bsDependencyEnabled
to false
, you need to ensure that your app code/view layout loads the Bootstrap CSS and JS on your view before the Krajee CSS/JS are loaded to ensure that the Krajee extension JS plugins and CSS styles do not get broken.
Bootstrap 5.x / 4.x does not include glyphicons or any other icons framework bundled with the library. Krajee extensions therefore will use Font Awesome 5.x icons instead of glyphicons when working with Bootstrap 5.x / 4.x. You can download Font Awesome 5.x icons from the icons website. Alternatively, you can load the free version of Font Awesome from their CDN.
For Krajee extensions and demos, the Font Awesome Free version is used and loaded as the Icons Display Package on all the Yii2 demo layouts. To include font awesome assets on your page, include the following markup on the HEAD
section of your view layout file, when bsVersion
is set to 4.x
or 5.x
.
Option 1: Font CSS version of Font Awesome:
<!-- on your view layout file HEAD section --> <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css">
Option 2: SVG / JS version of Font Awesome (recommended for cleaner scaling vector icons and features like icon layers):
<!-- on your view layout file HEAD section --> <script defer src="https://use.fontawesome.com/releases/v5.3.1/js/all.js" crossorigin="anonymous"></script>
Alternatively, you can use the FontAwesomeAsset
from the kartik-v/yii2-icons
package to load the SVG/JS version.
// on your view layout file use kartik\icons\FontAwesomeAsset; FontAwesomeAsset::register($this);
The yii2-widget-fileinput
extension can be installed automatically or manually using one of these options:
Installation via Composer is the recommended and most easy option to install Krajee Yii2 extensions. You can install yii2-widget-fileinput
via composer
package manager. Either run:
$ php composer.phar require kartik-v/yii2-widget-fileinput "dev-master"
or add:
"kartik-v/yii2-widget-fileinput": "dev-master"
to your application's composer.json
file.
You may also manually install the extension to your project (in case your composer install does not work). Just download the source ZIP or TAR ball and extract the extension asset files and folders into your project. You may need to install dependencies manually and also set the namespaces to the extensions in your Yii2 extensions configurations manually.
bsVersion
:
string | int, the bootstrap library version to be used for the extension. Refer the Bootstrap Info section for details and pre-requisites on setting this property.
To use with Bootstrap library - you can set this to any string starting with
3
(e.g. 3
or 3.3.7
or 4.x / 3.x
)
To use with bootstrap 4 - you can set this to any string starting with
4
(e.g. 4
or 4.6.0
or 4.x
)
To use with bootstrap 5 - you can set this to any string starting with
4
(e.g. 5
or 5.1.0
or 5.x
)
bsColCssPrefixes
:
array, the bootstrap grid column css prefixes mapping, the key is the bootstrap versions, and the value is an array containing the sizes and their corresponding grid column css prefixes. The class using this trait, must implement kartik\base\BootstrapInterface
. If not set will default to:.
[ 3 => [ self::SIZE_X_SMALL => 'col-xs-', self::SIZE_SMALL => 'col-sm-', self::SIZE_MEDIUM => 'col-md-', self::SIZE_LARGE => 'col-lg-', self::SIZE_X_LARGE => 'col-lg-', self::SIZE_XX_LARGE => 'col-lg-', ], 4 => [ self::SIZE_X_SMALL => 'col-', self::SIZE_SMALL => 'col-sm-', self::SIZE_MEDIUM => 'col-md-', self::SIZE_LARGE => 'col-lg-', self::SIZE_X_LARGE => 'col-xl-', self::SIZE_XX_LARGE => 'col-xl-', ], 5 => [ self::SIZE_X_SMALL => 'col-', self::SIZE_SMALL => 'col-sm-', self::SIZE_MEDIUM => 'col-md-', self::SIZE_LARGE => 'col-lg-', self::SIZE_X_LARGE => 'col-xl-', self::SIZE_XX_LARGE => 'col-xxl-', ], ];
resizeImages
: boolean, whether to resize images on client side. Defaults to false
. You must set this to true
if you wish to configure the plugin to resize images and load the necessary dependent CanvasBlobAsset
.
showMessage
: boolean, whether to display a warning message for browsers running IE9 and below. Defaults to true
.
messageOptions
: array, HTML attributes for the container for the warning message for browsers running IE9 and below. Defaults to ['class' => 'alert alert-warning']
.
disabled
: boolean whether the input widget is to be entirely disabled. Defaults to false
.
readonly
: boolean whether the input widget is to be entirely readonly. Defaults to false
.
options
: array, the HTML attributes for the file input.
pluginLoading
: boolean, whether to show a loading progress indicator in place of the input before plugin is completely loaded. Defaults to true
.
pluginOptions
: array the plugin settings/options for the Bootstrap Star Rating Plugin. There are a quite a few options you can set in this plugin. Refer the plugin documentation and demos for details.
pluginEvents
: array the FileInput JQuery events. You must define events in
event-name
=> event-function
format. All events will be stacked in the sequence.
Refer the plugin documentation and demos for details. For example:
pluginEvents = [ "fileclear" => "function() { log("fileclear"); }", "filereset" => "function() { log("filereset"); }", ];
[]
to the input/attribute name. Check the examples for usage.
use kartik\widgets\FileInput // or 'use kartikile\FileInput' if you have only installed yii2-widget-fileinput in isolation // Usage with ActiveForm and model echo $form->field($model, 'avatar')->widget(FileInput::classname(), [ 'options' => ['accept' => 'image/*'], ]); // With model & without ActiveForm // Note for multiple file upload, the attribute name must be appended with // `[]` for PHP to be able to read an array of files echo '<label class="control-label">Add Attachments</label>'; echo FileInput::widget([ 'model' => $model, 'attribute' => 'attachment_1[]', 'options' => ['multiple' => true] ]); // Usage without a model echo '<label class="control-label">Upload Document</label>'; echo FileInput::widget([ 'name' => 'attachment_3', ]); // A disabled fileinput input echo '<label class="control-label">Select Attachment</label>'; echo FileInput::widget([ 'name' => 'attachment_4', 'disabled' => true ]);
use kartik\widgets\FileInput // or 'use kartikile\FileInput' if you have only installed yii2-widget-fileinput in isolation use yii\helpers\Url; // Ajax uploads with drag and drop feature. Enable AJAX uploads by setting the `uploadUrl` property // in pluginOptions. You can also pass extra data to your upload URL via `uploadExtraData`. Refer // [plugin documentation and demos](https://plugins.krajee.com/file-input/demo) for more details // and options on using AJAX uploads. echo FileInput::widget([ 'name' => 'attachment_48[]', 'options'=>[ 'multiple'=>true ], 'pluginOptions' => [ 'uploadUrl' => Url::to(['/site/file-upload']), 'uploadExtraData' => [ 'album_id' => 20, 'cat_id' => 'Nature' ], 'maxFileCount' => 10 ] ]); // Display an initial preview of files with caption // (useful in UPDATE scenarios). Set overwrite `initialPreview` // to `false` to append uploaded images to the initial preview. echo FileInput::widget([ 'name' => 'attachment_49[]', 'options'=>[ 'multiple'=>true ], 'pluginOptions' => [ 'initialPreview'=>[ "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e1/FullMoon2010.jpg/631px-FullMoon2010.jpg", "https://upload.wikimedia.org/wikipedia/commons/thumb/6/6f/Earth_Eastern_Hemisphere.jpg/600px-Earth_Eastern_Hemisphere.jpg" ], 'initialPreviewAsData'=>true, 'initialCaption'=>"The Moon and the Earth", 'initialPreviewConfig' => [ ['caption' => 'Moon.jpg', 'size' => '873727'], ['caption' => 'Earth.jpg', 'size' => '1287883'], ], 'overwriteInitial'=>false, 'maxFileSize'=>2800 ] ]); // Control display of widget elements echo FileInput::widget([ 'name' => 'attachment_50', 'pluginOptions' => [ 'showPreview' => false, 'showCaption' => true, 'showRemove' => true, 'showUpload' => false ] ]); // Adjust caption and button size echo FileInput::widget([ 'name' => 'attachment_51', 'pluginOptions' => [ 'showUpload' => false, 'browseLabel' => '', 'removeLabel' => '', 'mainClass' => 'input-group-lg' ] ]); // Style widget buttons echo FileInput::widget([ 'name' => 'attachment_52', 'pluginOptions' => [ 'browseClass' => 'btn btn-success', 'uploadClass' => 'btn btn-info', 'removeClass' => 'btn btn-danger', 'removeIcon' => '<i class="fas fa-trash"></i> ' ] ]); // A block file picker button with custom icon and label echo FileInput::widget([ 'name' => 'attachment_53', 'pluginOptions' => [ 'showCaption' => false, 'showRemove' => false, 'showUpload' => false, 'browseClass' => 'btn btn-primary btn-block', 'browseIcon' => '<i class="fas fa-camera"></i> ', 'browseLabel' => 'Select Photo' ], 'options' => ['accept' => 'image/*'] ]); // Multiple file/image selection with image only preview // Note for multiple file upload, the attribute name must be appended with // `[]` for PHP to be able to read an array of files echo $form->field($model, 'avatar[]')->widget(FileInput::classname(), [ 'options' => ['multiple' => true, 'accept' => 'image/*'], 'pluginOptions' => ['previewFileType' => 'image'] ]); // Multiple file selection with both text and image preview // Note for multiple file upload, the attribute name must be appended with // `[]` for PHP to be able to read an array of files echo $form->field($model, 'upload_files[]')->widget(FileInput::classname(), [ 'options' => ['multiple' => true], 'pluginOptions' => ['previewFileType' => 'any'] ]); // Customizing the plugin elements (e.g. using a different container to display the caption) echo '<div class="card p-3all">'; echo FileInput::widget([ 'name' => 'attachment_30', 'pluginOptions' => [ 'showPreview' => false, 'showCaption' => false, 'elCaptionText' => '#customCaption' ] ]); echo '<span id="customCaption" class="text-success">No file selected</span>'; echo '</div>'; // FileInput inside a modal dialog use common\components\Modal; use kartikorm\ActiveForm; use kartik\widgets\FileInput; // or 'use kartikile\FileInput' if you have only installed yii2-widget-fileinput in isolation Modal::begin([ 'title'=>'File Input inside Modal', 'toggleButton' => [ 'label'=>'Show Modal', 'class'=>'btn btn-default btn-outline-secondary' ], ]); $form1 = ActiveForm::begin([ 'options'=>['enctype'=>'multipart/form-data'] // important ]); echo FileInput::widget(['name'=>'kartiks_file']); ActiveForm::end(); Modal::end(); // Multilanguage widgets with AJAX UPLOAD echo FileInput::widget([ 'name' => 'input-fr[]', 'language' => 'fr', 'options' => ['multiple' => true], 'pluginOptions' => ['previewFileType' => 'any', 'uploadUrl' => Url::to(['/site/file-upload'])] ]); echo '<br><label>FileInput in Russian</label>'; echo FileInput::widget([ 'name' => 'input-ru[]', 'language' => 'ru', 'options' => ['multiple' => true], 'pluginOptions' => ['previewFileType' => 'any', 'uploadUrl' => Url::to(['/site/file-upload']),] ]);
yii2-widget-fileinput is released under the BSD-3-Clause
License. See the bundled LICENSE.md for details.
Comments & Discussion
Note
You can now visit the Krajee Webtips Q & A forum for searching OR asking questions OR helping programmers with answers on these extensions and plugins. For asking a question click here. Select the appropriate question category (i.e. Krajee Plugins) and choose this current page plugin in the question related to field.
The comments and discussion section below are intended for generic discussions or feedback for this plugin. Developers may not be able to search or lookup here specific questions or tips on usage for this plugin.