@zayesh/stay

Stay

Stay is a small but effective module for the creation of dynamic xhr-driven web applications. It expects the server to be able to send the page content as a JSON string in which the key names correspond with the IDs of the target DOM containers.

Installation

Download the minified library and include it in your project:

<script src="/js/stay.min.js"></script>

You can also install this module with npm.

$ npm install @zayesh/stay

Usage

// Note: using require is not necessary with the browser bundle.
var Stay = require("@zayesh/stay");

var stay = new Stay({
 /* Default is ["main", "navigation", "footer"] */
 responseFields: ["myContent"],
 /* Default is "/json" */
 infix: "/urlPatternForAsyncRequests",
 /* Default is 60000ms, 0 means no timeout */
 timeoutPost: 0,
 /* Default is 5000ms */
 timeoutGet: 0,
 /* Default is true */
 autoUpdate: false
});

// You can also add and remove response fields.
stay.addResponseField("myContainer");
stay.removeResponseField("main");

stay.addEventListener("navigate", function()
{
 alert("Page navigation has started.");
});

stay.addEventListener("receive", function(event)
{
 // If autoUpdate is set to false, the programmer can 
 // decide when to update the page content.
 // The response is the parsed JSON string from the server.
 stay.update(event.response);
});

stay.addEventListener("load", function()
{
 alert("The requested page has been loaded.");
});

Documentation

API

Contributing

Maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Release History

Version: 0.0.0 (28.06.2015)

The module realizes a robust xhr-driven page navigation.

License

Copyright (c) 2015 Raoul van Rüschen
Licensed under the Zlib license.