Package Exports

axios-progress-bar

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (axios-progress-bar) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Axios Progress Bar

This module provides a simple usage of a progress bar for the HTTP requests made by Web applications that use the library axios. It's high inspired in the module angular-loading-bar and uses the awesome nprogress module to display the loading bar in the Browser.

Attention: This module is not bound to any framework. You can use it in any Web application that uses axios.

Demo

demo

Installation

It's available through the NPM package:

npm install --save axios (peer dependency)
npm install --save axios-progress-bar

Or via CDN:

<script src="https://cdn.rawgit.com/rikmms/progress-bar-4-axios/master/dist/index.js"></script>
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

Usage

Simple as invoke (only one time) the function: loadProgressBar(config), where the config argument is the configuration object for the nprogress and is not required. Its properties can be seen here.

An example in ES6 using the new import statement

    import { loadProgressBar } from 'axios-progress-bar'

    loadProgressBar(configs)
    ...

An example using plain HTML and Javascript in the Browser

<!DOCTYPE html>
<html lang="en">
    <head>
        ...
    </head>
    <body>
        ...
    </body>
    <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
    <script src="https://cdn.rawgit.com/rikmms/progress-bar-4-axios/master/dist/index.js"></script>
    
    <script type="text/javascript">
        loadProgressBar()
        ...
    </script>
    
</html>

Tip

By default, the minimal CSS (nprogress.css) is automatically imported into the HTML. However, It's possible to override the properties or set new ones with a custom CSS.

In the next example, the custom CSS only changes the color of the progress bar and the spinner to red (It's necessary to use the !import keyword, to override the default value).

<!DOCTYPE html>
<html lang="en">
    <head>
        <style type="text/css">
            #nprogress .bar {
                background: red !important;
            }

            #nprogress .peg {
                box-shadow: 0 0 10px red, 0 0 5px red !important;
            }

            #nprogress .spinner-icon {
                border-top-color: red !important;
                border-left-color: red !important;
            }
        </style>
    </head>
    <body>
        ...
    </body>
    <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
    <script src="https://cdn.rawgit.com/rikmms/progress-bar-4-axios/master/dist/index.js"></script>
    
    <script type="text/javascript">
        loadProgressBar()
        ...
    </script>
    
</html>

demo-red

Bugs/Requests

Write them in the repository issues.