Skip to content

Commit 66e1f66

Browse files
committed
Documentation fixes
1 parent e008e6a commit 66e1f66

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
bootstrap-fileinput
22
====================
33

4-
An enhanced HTML 5 file input for Bootstrap 3.x with file preview for images and text, multiple selection, and more. This plugin is inspired by [this blog article](http://www.abeautifulsite.net/blog/2013/08/whipping-file-inputs-into-shape-with-bootstrap-3/) and [Jasny's File Input plugin](http://jasny.github.io/bootstrap/javascript/#fileinput). The plugin enhances these concepts and simplifies the widget initialization with simple HTML markup on a file input. It also offers support for multiple file preview and previewing both images and text types.
4+
An enhanced HTML 5 file input for Bootstrap 3.x with file preview for images and text, multiple selection, and more. This plugin is inspired by [this blog article](http://www.abeautifulsite.net/blog/2013/08/whipping-file-inputs-into-shape-with-bootstrap-3/) and [Jasny's File Input plugin](http://jasny.github.io/bootstrap/javascript/#fileinput). The plugin enhances these concepts and simplifies the widget initialization with simple HTML markup on a file input. It also ofileclearers support for multiple file preview and previewing both images and text types.
55

66
![File Input Screenshot](https://lh6.googleusercontent.com/-2niyujIaat0/UyqzA_78OQI/AAAAAAAAADE/f6IJkr11uA8/w666-h418-no/fileinput-screenshot.jpg)
77

@@ -30,7 +30,7 @@ An enhanced HTML 5 file input for Bootstrap 3.x with file preview for images and
3030
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 …).
3131
10. Customise the messages for preview, progress, and files selected.
3232
11. Upload action defaults to form submit. Supports an upload route/server action parameter for custom ajax based upload.
33-
12. Triggers JQuery events for advanced development. Events currently available are `filereset` and `fileclear`.
33+
12. Triggers JQuery events for advanced development. Events currently available are `filereset`, `fileclear`, `filecleared`, `fileloaded`, and `fileerror`.
3434
13. Disabled and readonly file input support.
3535
14. Size of the entire plugin is less than 6KB if gzipped. The minified assets are less than 16KB (about 13KB for the minified JS and 3KB for the minified CSS).
3636

@@ -460,28 +460,35 @@ The plugin supports these methods:
460460

461461
#### disable
462462
Disable the file input.
463+
463464
```js
464465
$('#input-id').fileinput('disable');
466+
```
465467

466468
#### enable
467469
Enable the file input.
470+
468471
```js
469472
$('#input-id').fileinput('enable');
473+
```
470474

471475
#### reset
472476
Reset the file input.
477+
473478
```js
474479
$('#input-id').fileinput('reset');
475480
```
476481

477482
#### clear
478483
Clear the file input.
484+
479485
```js
480486
$('#input-id').fileinput('clear');
481487
```
482488

483489
#### refresh
484490
Refreshes the file input plugin based on options provided. You can supply an array of plugin options as a parameter.
491+
485492
```js
486493
// example 1 (disable at runtime)
487494
$('#input-id').attr('disabled', 'disabled');
@@ -490,6 +497,7 @@ $('#input-id').fileinput('refresh');
490497
// example 2 (modify plugin options at runtime)
491498
$('#input-id').fileinput('refresh', {browseLabel: 'Select...', removeLabel: 'Delete'});
492499
```
500+
493501
## License
494502

495-
**bootstrap-fileinput** is released under the BSD 3-Clause License. See the bundled `LICENSE.md` for details.
503+
**bootstrap-fileinput** is released under the BSD 3-Clause License. See the bundled `LICENSE.md` for details.

0 commit comments

Comments
 (0)