Git Product home page Git Product logo

file-progress's Introduction

file-progress

An extended HTML file input that looks like a progress bar.

Features

  • Lightweight, no dependencies.
  • Better HTML file input design.
  • Has option to upload file via ajax and show progress.
    • Use your own implementation for ajax file upload.

Installation

Using npm:

$ npm install file-progress

Using yarn:

$ yarn add file-progress

Cloning the repo:

$ git clone https://github.com/mrethical/file-progress

Usage

...
<body>
  <input type="file" id="file-progress-input">
  <script type="text/javascript" src="./dist/file-progress.js"></script>
</body>
...
const fileProgress = new FileProgress('file-progress-input');

If you installed the library via package manager, you can use the library by importing it.

import FileProgress from "file-progress";

const fileProgress = new FileProgress('file-progress-input');

Options

option type description
url string if set, will send selected file to the url via ajax
upload function(File, FileProgress): void function for implementing custom ajax call rather than built in
label function(File?): void function for setting custom label
onRemove function(): void callback when file was cleared/removed

To set options, provide them at class initialization.

const fileProgress = new FileProgress('file-progress-input', {
    url: 'https://example.com/upload'
});

Methods

name parameters description
progress percentage (number) set file progress bar (useful when using own ajax upload function)
prefill prefill (label) update the input label without updating the file
open open file modal
set fileList (FileList) programatically set files of input
clear remove files

Screenshots

Imgur

Imgur

License

This library is open-sourced software licensed under the MIT license.

file-progress's People

Contributors

dependabot[bot] avatar mrethical avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.