A light XHR plugin for Vue 2.x and and above versions. It has many similar features with jQuery's ajax() and Angular's $http(). In addition to these, it also has its own important features:

• Assets
• Component shifter
• Event Handlers
• File uploading
• History
• Title
• Serialized query string
• Prevent duplicate requests

Setup

npm install vuejs-ajax --save

You have two ways to setup vuejs-ajax:

CommonJS (Webpack/Browserify)

• ES6

import ajax from 'vuejs-ajax'
Vue.use(ajax)

• ES5

var ajax = require('vuejs-ajax')
Vue.use(ajax)

Example

Vue.ajax.get('http://example.com').then(function(response) {
    console.log('Success', response.data)
}, function(response) {
    console.log('Error', response.statusText)
})

If you want to send data to the backend:

Vue.ajax.get('http://example.com', {
    param1: 'First parameter',
    param2: 'Second parameter'
}).then(function(response) {
    console.log('Success', response.data)
}, function() {
    console.log('Error', response.statusText)
})

Methods & Requests

Get Method

Vue.ajax.get(string url[, object data] [,object configurations])
    .then(function success[, function error])

Post Method

Vue.ajax.post(string url[, object data] [,object configurations])
    .then(function success[, function error])

Arguments

Other methods and requests are the same:

Delete Method

Vue.ajax.delete(string url[, object data] [,object configurations])
    .then(function success[, function error])

Head Method

Vue.ajax.head(string url[, object data] [,object configurations])
    .then(function success[, function error])

Jsonp Request

Vue.ajax.jsonp(string url[, object data] [,object configurations])
    .then(function success[, function error])

Patch Method

Vue.ajax.patch(string url[, object data] [,object configurations])
    .then(function success[, function error])

Put Method

Vue.ajax.put(string url[, object data] [,object configurations])
    .then(function success[, function error])

All of the above methods are a shorthand method of the Vue.ajax():

Vue.ajax({
    url: 'http://example.com',
    method: 'get' // post, put, patch, delete, head, jsonp
}).then(function(response) {
    console.log('Success', response.data)
}, function() {
    console.log('Error', response.statusText)
})

Component Shifter

With componentShifter() you can load (with Vue.ajax) and render your Vue template (html) in your application by dynamic & async Vue.component(). You can also add components and run them nested.

It also supports Vue.ajax's history feature. And the component is automatically update when navigating to the previous - next page.

vm.componentShifter(object configurations[, function success] [,function error])

Settings

Example

index.html

<div id="app">
    <a href="/page" @click.prevent="openPage('/page', 'New page')">Link</a>

    <!-- Your container component -->
    <component :is="myPage"></component>
</div>

app.js

var vm = new Vue({
    el: '#classest',
    data() {
        return {
            myPage: null, // Component name
            pageLoaded: false
        }
    },
    methods: {
        openPage(url, title) {
            // Calling componentShifter
            this.componentShifter({
                is: 'myPage', // [String] Component name
                url: url,
                title: title,
                history: true,
            }, function (response) {
                console.log("Component changed!");
                pageLoaded = true;
            }, function (response) {
                console.log("Component could not be changed!", response);
                pageLoaded = false;
            });
        }
    },
    created() {
        if(!pageLoaded) {
            this.openPage('/page', 'New page')
        }
    }
});

Vue Ajax Configurations

Vue Ajax Configuration Examples

Assets

Assets setting is used to push new asset files (CSS or JS) in the document.

Pushing single asset file

Vue.ajax.get('http://example.com', [data], {
    assets: 'path/css/style.css'
});

Pushing multiple asset files

Vue.ajax.get('http://example.com', [data], {
    assets: ['assets/css/style.css', 'assets/js/script.js']
});

Asynchronous

By default, all requests are sent asynchronously (i.e. this is set to true by default). If you need synchronous requests, set this option to false. Default value is true.

Vue.ajax.get('http://example.com', [data], {
    async: true
});

Cache

Default value is false.

Vue.ajax.get('http://example.com', [data], {
    cache: false
});

Complete Event

A function to be called when the request finishes (Success or error).

Vue.ajax.get('http://example.com', [data], {
    complete: function(response) {
        console.log(response.status)
    }
});

CSRF

Default value is true.

Vue.ajax.get('http://example.com', [data], {
    csrf: true
});

In the html head tag it must be csrf-token meta. Like this:

<meta name="csrf-token" content="ABCDEFGHIJKLMN">

Data

Data to be sent to the server.

Vue.ajax('http://example.com', {
    url: 'http://example.com',
    method: 'get',
    data: {
        param1: 'First parameter',
        param2: 'Second parameter'
    }
});

File Uploading

fileInputs setting should be DOM object. We recommend using the post method when uploading files. The important thing here is that you should not forget the name attribute.

HTML:

<input type="file" name="my-input" id="my-input">

Javascript:

Vue.ajax.post('http://example.com', [data], {
    fileInputs: [
        document.getElementById('my-input')
    ]
});

You can only add the accept attribute to send images.

<input type="file" name="my-input-2" id="my-input-2" accept="image/*">

You can add the multiple attribute to send multiple files with an input element:

<input type="file" name="my-input-3" id="my-input-3" multiple>

Hard Reload On Error

Option to hard reloading when page can not be loaded. Default value is false.

Vue.ajax.get('http://example.com', [data], {
    hardReloadOnError: true
});

History

History setting is usage of PushState (HTML history API). Default value is false.

PushState (changing the URL of the page without refreshing the page) to create a faster browsing experience. This means less elements to load and therefore faster browsing.

Vue.ajax.get('http://example.com', [data], {
    history: true
});

Adding version for history
Layouts can be forced to do a hard reload when assets or html changes. First set the initial layout version in your header with a custom meta tag.

HTML:

<meta http-equiv="x-history-version" content="ABCDEFGH">

HTTP Headers

Vue.ajax.get('http://example.com', [data], {
    headers: {
        'Content-Type': 'application/json',
        'Accept': 'application/json, text/plain, */*'
    }
});

Method

Default value is get.

Vue.ajax({
    url: 'http://example.com',
    method: 'post'
});

Instead, you might prefer to use the following shorthand:

Vue.ajax.post('http://example.com', [data]);

Prevent Duplicate Requests

This setting prevents sending duplicate requests to the same address or given key data. Default value is true.
The following example prevents sending requests over the same URL:

Vue.ajax.get('http://example.com', [data], {
    preventDuplicate: true
});

The following example prevents sending requests over the same given key data:

Vue.ajax.get('http://example.com', [data], {
    preventDuplicate: true,
    key: 'ABCDEFGH'
});

Scroll Top

This setting is used to scroll to top of the document when loading the request. Default value is true.

Vue.ajax.get('http://example.com', [data], {
    scrollTop: true
});

Timeout

Set a timeout (in milliseconds) for the request. Default value is 60000.

Vue.ajax.get('http://example.com', [data], {
    timeout: 60000
});

Title

Title setting is used to change the document title value.

Vue.ajax.get('http://example.com', [data], {
    title: 'New title'
});

URL Data

With this setting, you can add serialized query string to the URL you are sending.

Vue.ajax.get('http://example.com', [data], {
    urlData: [
        {page: 15},
        {category: 'Accessories'}
    ]
});

The URL will be like this when sending the request:
http://example.com?page=15&category=Accessories

With Credentials

There is a detailed explanation here. Default value is false.

Vue.ajax.get('http://example.com', data {
    withCredentials: false
});

Response Handling

The response returns the Object on the frontend.

Success and error together in then() method:

Vue.ajax(object configurations)
    .then(function success[, function error])

Success and error together in in separate methods:

Vue.ajax(object configurations)
    .then(function success)
    .catch(function error)

The object in general is the following structure:

Vue.ajax.get('http://example.com', [data])
    .then(function(response) {
        console.log(response.data)
    });

Response Format

If the content type on the server is "application/json", the response.data is automatically converted to a JSON object. If the content type is anything else, the result is returned as plain text.

PHP:

header('Content-type: application/json; charset=utf-8');
echo json_encode($array);

Laravel:

Route::get('http://example.com', function () {
    return response(json_encode($array), 200)
        ->header('Content-Type', 'application/json; charset=utf-8');
});

VueJS

Vue.ajax.get('http://example.com', [data])
    .then(function(response) {
        console.log(response.data)
    });

Error Handling

In then() method

Vue.ajax.get('http://example.com/not-existing-path', [data])
    .then(function(response) {
        console.log(response.data)
    }, function(response) {
        console.log('Error: ', response.statusText);
    }); // "Error: Not Found"

In catch() method

Vue.ajax.get('http://example.com/not-existing-path', [data])
    .then(function(response) {
        console.log(response.data)
    }).catch(function(response) {
        console.log('Error: ', response.statusText);
    }); // "Error: Not Found"

Event Handlers

Common Events

vueajaxabort

Register a handler to be called when Vue.ajax requests abort.

window.addEventListener('vueajaxabort', function(e) {
    console.log(e);
});

vueajaxcomplete

Register a handler to be called when Vue.ajax requests complete.

window.addEventListener('vueajaxsuccess', function(e) {
    console.log(e);
});

vueajaxerror

Register a handler to be called when Vue.ajax requests complete with an error.

window.addEventListener('vueajaxerror', function(e) {
    console.log(e);
});

vueajaxstart

Register a handler to be called when Vue.ajax requests begins.

window.addEventListener('vueajaxstart', function(e) {
    console.log(e);
});

vueajaxsuccess

Attach a function to be executed whenever an Vue.ajax request completes successfully.

window.addEventListener('vueajaxsuccess', function(e) {
    console.log(e);
});

History Events

vueajaxhistorycomplete

Register a handler to be called when Vue.ajax history requests complete.

window.addEventListener('vueajaxhistorycomplete', function(e) {
    console.log(e);
});

vueajaxhistoryerror

Register a handler to be called when Vue.ajax history requests complete with an error.

window.addEventListener('vueajaxhistoryerror', function(e) {
    console.log(e);
});

vueajaxhistorystart

Register a handler to be called when Vue.ajax history requests begins.

window.addEventListener('vueajaxhistorystart', function(e) {
    console.log(e);
});

vueajaxhistorysuccess

Attach a function to be executed whenever an Vue.ajax history request completes successfully.

window.addEventListener('vueajaxhistorysuccess', function(e) {
    console.log(e);
});

Component Shifter Events

componentshiftercomplete

Register a handler to be called when Component Shifter requests complete.

window.addEventListener('vueajaxhistorycomplete', function(e) {
    console.log(e);
});

componentshiftererror

Register a handler to be called when Component Shifter requests complete with an error.

window.addEventListener('componentshiftererror', function(e) {
    console.log(e);
});

componentshifterstart

Register a handler to be called when Component Shifter requests begins.

window.addEventListener('componentshifterstart', function(e) {
    console.log(e);
});

componentshiftersuccess

Attach a function to be executed whenever an Component Shifter request completes successfully.

window.addEventListener('componentshiftersuccess', function(e) {
    console.log(e);
});

License

MIT

Copyright (c) 2018 Fatih Koca