https://github.com/likerrr/jq-ajax-progress

jQuery plugin that adds support of `progress` promise
https://github.com/likerrr/jq-ajax-progress

ajax jquery jquery-plugin js promises

Last synced: 6 days ago
JSON representation

jQuery plugin that adds support of `progress` promise

• Host: GitHub
• URL: https://github.com/likerrr/jq-ajax-progress
• Owner: likerRr
• License: mit
• Created: 2015-08-22T09:43:12.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-02-04T20:56:09.000Z (almost 7 years ago)
• Last Synced: 2024-05-29T09:21:14.228Z (7 months ago)
• Topics: ajax, jquery, jquery-plugin, js, promises
• Language: JavaScript
• Size: 24.4 KB
• Stars: 62
• Watchers: 6
• Forks: 28
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jQuery Ajax Progress

Lightweight jQuery plugin that adds support of `progress` and `uploadProgress` promises to $.ajax()

# Installation

## npm

`npm install jq-ajax-progress`

## manually

`git clone [email protected]:likerRr/jq-ajax-progress.git`

# How to use

Include `src/jq-ajax-progress.min.js` inside your html after `jQuery` script

## Basic usage

```javascript

$.ajax(url, {

    progress: function(e) {

      // track downloading

    },

    uploadProgress: function(e) {

      // track uploading

      // if (e.lengthComputable) {

      //   var completedPercentage = Math.round((e.loaded * 100) / e.total);

      //   console.log(completedPercentage);

      //}

    }

  })

```

## Extended usage

When you have to send a chunked data to client in some cases it would be good to track what part have just received. For this purposes use boolean option `chunking` (`false` by default). If it's set as `true`, then the second parameter in callback function will be a chunk part.

By default all chunked response contains whole text response that already received and you should manually cut it if you need to do something with parts. One of a possible case when you send big text or media response from server to client and you don't want your client wait for whole response.

> Keep in mind, that under the hood whole response is being cut from the beginning (from zero index)

> until last part's occurrence, so big amount of data (theoretically) may cause a performance troubles. But... just keep

> in mind :)

```javascript

$.ajax(url, {

    chunking: true,

    progress: function(e, part) {

      console.log(part);

    }

  });

```

# Build

Install [node](https://nodejs.org/)

Run `npm install && npm run build`

This will minify library and put it inside `src` folder

# [MIT LICENSE](http://likerrr.mit-license.org/)