Visit the Website, sparkyjs.com
Sparky.js is a client-side application scaffold which helps those who want to have organized structure in their app, but don't want to subscribe to a particular client-side MVC framework.
It provides such capabilities as a code Router, an Event system, an Ajax wrapper, and more.
Sparky.js is not a solution for javascript-powered web-apps, rather, it's a base for websites that are javascript heavy.
Say goodbye to spaghetti JS, and hello to SparkyJS!
To fully utilize Sparky's routing, a few things must be done outside of the script.
In your application, output the meta tags you see in the example below with their respective content dynamically filled in with their appropriate values.
It is recommended you output the url, userid, controller, and action tags. The url will be used to simplify redirects and ajax requests, the userid will help determine whether or not a user is logged in, and the controller and action will route page-specific logic.
With the meta tags provided to the right, it'd be safe to assume that the current page the user is on is a "Following" page which is a sub-page of "Dashboard", and if the user is not logged in, -1 should be userid's default value.
Lastly, include jQuery, and the path to your Sparky application.
<!-- Source of http://myapp.com/dashboard/following -->
<!doctype html>
<html>
<head>
<meta name="url" content="http://myapp.com/">
<meta name="controller" content="dashboard">
<meta name="action" content="following">
<meta name="userid" content="-1">
</head>
<body>
<!-- Your Content -->
<script type="text/javascript" src="path/to/jquery.js"></script>
<script type="text/javascript" src="path/to/sparky.js"></script>
</body>
</html>Now that your meta tags are set, let's explore what Sparky does. The Utils object is used for caching objects, outputting dynamic data, defining app settings, and routing your application.
Upon calling Utils.settings.init(), the object Utils.settings will be filled with the data that was output from the meta tags.
Utils.cache is good for storing references to whatever it is you may be accessing frequently
After initializing your apps settings, calling Utils.home_url('auth/login?foo=bar') would return http://myapp.com/auth/login?foo=bar.
The function Utils.log is a wrapper for console.log, so that way you may turn logging on/off via the debug variable in the settings object. The log function is made more accessible by assigning the variable _log to it. Making a _log('is easy');.
Lastly, we have the Utils.route function. Note: This is not to be confused with the Routes object. This function will loop through our Routes object and execute any page specific code based on the controller and action.
Utils = {
settings: {
debug: true,
meta: {
controller: -1,
action: -1,
currentUser: -1,
homeURL: -1
},
init: function() {
Utils.settings.meta.controller = $("meta[name=controller]").attr("content");
Utils.settings.meta.action = $("meta[name=action]").attr("content");
Utils.settings.meta.currentUser = $("meta[name=userid]").attr("content");
Utils.settings.meta.homeURL = $("meta[name=url]").attr("content");
}
},
cache: {
window: window,
document: document
},
home_url: function(path){
if(typeof path=="undefined"){
path = '';
}
return Utils.settings.meta.homeURL+path+'/';
},
log: function(what) {
if (utils.settings.debug) {
console.log(what);
}
},
route: function(){
var controller = Utils.settings.meta.controller;
var action = Utils.settings.meta.action;
if(typeof Routes[controller] != 'undefined'){
if(typeof Routes[controller].init != 'undefined'){
Routes[controller].init.call();
}
if(typeof Routes[controller][action] != 'undefined'){
Routes[controller][action].call();
}
}
}
};
_log = Utils.log;Routing is a big part of Sparky's charm. It is very easy to execute your page-specific logic in an organized fashion, making management of your app a breeze. With a JS loader like RequireJS, you can develop dynamic, structured, and modular apps in conjunction with Sparky's architecture.
What the Utils.route function does is loop through the Routes object seen to the right. Using the variables we output in the meta tags above, we can determine what code needs to also be executed client side.
The first level of objects within the Routes object represent controllers. If your controller object has an init function, it will be called before any action functions. If there is a function within your controller object who's name matches the set action, that function will then be called.
Example: There are two controller objects to the right, "auth" and "dashboard". If we output in our meta tags "auth" as the controller, Routes.auth.init() will be called if it exists. If the action is set to "register", Routes.auth.register() will then be called.
Routes = {
auth: function(){
init: function(){
if(Utils.settings.currentUser){
window.location.href = Utils.home_url('dashboard');
}
},
register: function(){
$('#register_form').formValidate(); // Pseudo Code
}
},
dashboard: {
init: function(){
_log('Auto Loading Dashboard Code');
$('#stats').barChart(); // Pseudo Code
},
following: function() {
_log('Doing code for the Following Page');
$('.follow-buttons').followButton(); // Pseudo Code
}
}
};Though the process of Ajax is simplified quite well with libraries like jQuery, it is beneficial to use a wrapper to avoid writing all the requests and simplify your life.
The base Ajax Object provided in Sparky allows a simple way to make your request. Ajax.call for POST requests, and Ajax.get for get requests.
A request for a "Like Button" might look like this:
Ajax.call('doLike', {pictureID: 7}, function(result){
// Success
}, function(){
alert('Sorry, you must be logged in for that action');
});First parameter would be the method we want to call for our Ajax script, second parameter is the data, third is the success function, and if the fourth parameter is set to a function, it will fire only if the user is not logged in.
Ajax = {
ajaxUrl: Utils.home_url('ajax'), // return http://myapp.com/ajax/
checkAuth: function(returnFunc){
if(typeof returnFunc == 'function' && Utils.settings.meta.currentUser==-1){
returnFunc.call();
return false;
}
},
call: function(method, data, returnFunc, authRequiredFunc){
Ajax.checkAuth(authRequiredFunc);
$.ajax({
type:'POST',
url: Ajax.ajaxUrl+method,
dataType:'json',
data: data,
success: returnFunc
});
},
get: function(method, data, returnFunc, authRequiredFunc){
Ajax.checkAuth(authRequiredFunc);
$.ajax({
type:'GET',
url: Ajax.ajaxUrl+method,
dataType:'json',
data: data,
success: returnFunc
});
}
};Events play an important role in Javascript and the DOM. Javasript should be used to handle the logic, but having the ability to bind events by writing HTML is a breeze, and better represents what your specific elements can do. Say goodbye to the days of messy and disorganized event binding!
Firstly, create a few HTML elements in which you want to bind events to. Using HTML5 data attributes, assigning data-event to an element will bind it to the function name of its value. For instance: data-event="doLogin" will bind it to Events.endpoints.doLogin if it exists.
The default event type bound to the element is the click event. If you wish to listen for a different type of event, add the data-attribute data-method to your element and it's value should be the jQuery event name.
If you add to the DOM and want to bind elements, you may call Events.init or Events.bindEvents. Elements that have already been bound will not be bound again, thus binding only new elements.
Provided are a few examples of the implementation of events. The this keyword is available, and if you need to inspect the event object, you may pass it as a parameter to your endpoint function.
<button data-event="doLogin">Login</button>
<input type="text" data-event="numsOnly" data-method="keyup">Events = {
endpoints: {},
bindEvents: function(){
$('[data-event]').each(function(){
var $this = $(this),
method = $this.attr('data-method') || 'click',
name = $this.attr('data-event'),
binded = $this.attr('data-binded')=='true';
if(typeof Events.endpoints[name] != 'undefined'){
if(!binded){
$this.attr('data-binded', 'true');
$this.on(method, Events.endpoints[name]);
}
}
});
},
init: function(){
Events.bindEvents();
}
}<button data-binded="true" data-event="doLogin">Login</button>
<input data-binded="true" type="text" data-event="numsOnly" data-method="keyup">Events = {
endpoints: {
doLogin: function(){
Ajax.call('doLogin', {username:someVal, password: somePass}, function(res){
if(res.success){
window.location.href = Utils.home_url('dashboard'); // Redirects to http://myapp.com/dashboard/
} else {
alert('Invalid username or password');
}
});
}
numOnly: function(){
this.value=this.value.replace(/[^\d]/,'');
}
},
bindEvents: function(){},
init: function(){}
}The App object is used to start Sparky, bind events, and route your code. It can also house the core of your logic if you wish. Usually, it is best to put any global logic in the App object.
The Public object is returned to allow you to publicize any functions you wish, elsewise, the scope of your functionality will be within your application itself. The App.init function is returned by default.
App = {
/*
* Add any additional functions/objects you want here,
* usually functions that will execute on every page or
* beefy worker functions
*/
logic: {},
init: function() {
// Collect our settings and info
Utils.settings.init();
// Bind events to the DOM
Events.init();
// Execute page-specific code
Utils.route();
}
};
/*
* Return function you want to have accessible globally
* Sparky.init() => App.init()
*/
Public = {
init: App.init
};
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent