Sammy.Js–simplest steps to create Restful web application (Single Page Applications) SPAs

Dear All,

Today I  am sharing with you one of the best and easy to understand JS which is “Sammy.Js”.

“Sammy.js” is 16 k java script over JQUERY which provide facility to developer to create RESTFUL SPAs (single Page Application).

It is very  clean, simple and easy to adapt java script.rl

You get Restful URL easily with this.

It added “#”  hash in URL. For example see below example

http://Indiandotnet.com/index#/

http://indiandotnet.com/index#/Products/

http://indiandotnet.com/Index#/products/1

Let us understand this with example.

In last post you have seen how to consume web API with JQUERY http://indiandotnet.wordpress.com/2014/03/21/how-to-consume-web-api-using-jquery/

Here I am using the sample source code to move forward with sammy.js.

What we are planning here to create a page with menus and in this page we will call sammy.js on menu to call responsive URL to show states list ,particular state according to id and default page . as shown in below figure

Step 1:-  Add “Sammy.js” in the project using Nuget package manager as shown in below figure

Step 2:- Once the Sammy.Js added in your project you will find the Js in your project’s script folder

Step 3:-

Add sammy js reference in the project

   1: <script src="~/Scripts/jquery-2.1.0.min.js"></script>

   2:    <script src="~/Scripts/sammy-0.7.4.min.js"></script>

Step 4:-

Now below screen shot show the html which is designed to achieve our task

Step 5:- Now when Home menu link click by end user we will show  default page which in Index page in our case and its URL will be

http://localhost:43597/Home/index#/ 

And when user click on States link in navigation then it will show URL

http://localhost:43597/Home/index#/States 

And page will show list of states

last but not the least when user click on MP menu in navigation  then it will show URL

http://localhost:43597/Home/index#/States/1 

and page will show state name according to Id which is currently 1 in above url

Step 6:-

Now to achieve this we need to invoke Sammy.js  as shown below in below code

   1: <script type="text/javascript">

   2:  

   3:       $(document).ready(function () {

   4:           var sammySPA = $.sammy("#main", function () { // initializing main div which is base for SPAs application content 

   5:  

   6:               //Default url  

   7:               this.get('#/', function (context) {

   8:                   

   9:                   context.app.swap(''); // clear what ever previously written in main div

  10:                   $("#main").append("<B> Showing default url content by code</b>"); // this code append the content in msin div 

  11:  

  12:               });

  13:               //below code will fire when user click on state link 

  14:               this.get('#/States', function (context) {

  15:                 

  16:                   //calling the Web API to provide State name array 

  17:                   $.get("http://localhost:43597/api/mystate/", function (data, textStatus) {

  18:                       var str = "";

  19:                       // create list with sate name which again referencing to new url

  20:                       for (var i = 0; i < data.length; i++) {

  21:                           str = str + "<li><a href='#/States/" + (i+1).toString() + "'>" + data[i] + "</a></li>";

  22:                       }

  23:  

  24:                       //Clean the main div 

  25:                       context.app.swap('');

  26:                       //Apeend the data in main div

  27:                       $("#main").append("<ul>" + str + "</ul>");

  28:  

  29:                           

  30:                   });

  31:  

  32:               });

  33:  

  34:               //States/stateId url 

  35:               this.get('#/States/:id', function (context) {

  36:                   //calling web api to get particular state by id

  37:                   $.get("http://localhost:43597/api/mystate/"+ context.params.id, function (data, textStatus) {

  38:                     

  39:                       context.app.swap('');

  40:                       $("#main").append("<h1>" + data + "</h1>");

  41:  

  42:  

  43:                   });

  44:               });

  45:  

  46:         

  47:  

  48:           });

  49:           

  50:           sammySPA.run('#/'); //run sammy.js

  51:  

  52:  

  53:  

  54:       });

  55:   </script>

Step 7:-

Let me explain the above code here

We have define $.sammy function which is bounded with the div whose.

$.sammy(‘#main’,function() {}).run(); this is the basic function to invoke sammy.js

Step 8:- Now to which url we need to entertain by which method like  get, put, Post, delete. We need to define our functionality according to our need in current example we have used get function.

this.get(‘#/’,function (context){});

The meaning of above line is when ever a request (default) invoke by end user just execute function as defined. in the function there is context parameter . Which help in accessing method type (get/post) , parameters

Step 9:-  Now when you run and click on States link you will get following screen

Step 10:- you can test it further I have added list of states also with dynamic url  so when you click on MP, RJ, MH etc in above list you will get a new URL according to our need

I hope this example will help you to create your own SPA application.

I defiantly say here “Sammy.js” rock. I like this script hope you will also.

Enjoy learning

your Host

Rajat

How to consume Web API using JQUERY ?

 

Friends,

In last two articles we understood

 what is Web API ? (http://indiandotnet.wordpress.com/2014/02/23/what-is-web-api/)

and How to create it ? (http://indiandotnet.wordpress.com/2014/02/27/how-to-create-web-api/)

Now next is how to consume it ?

So here we will understand this by an example. I am pretty much sure you all  are comfortable with server side code so here in current example we using  client side code to consume web API.

In current example I have created a Web API with name “MyState” . The basic functionality of this Web API is to provide list of all the State with default get method and provide specific state according to provided id.

Let me show you snap shots of created code & running API here

Above figure shows default get method which response array of string (name of state)

Now to consume this Web API in our project we have added a view with following Java script

in below screen we have used a “get” JQUERY function and as we  know the API URL we wrote that and once the response from API returned we concatenated the response array with <li> tag and show as a innerHTML of stateName div as shown in below fig

Now when we run this program on index.cshtml we got following response

In current example we have used  “GET” method we can also consume post operation for INSERT/UPDATE/Delete

I hope you will like this post.

Thanks

Your host

Rajat

Start “Knockout.Js” for Beginners

Dear All,

I heard a lot about “Knockout.js”.

So let us understand it first. “knockout.js “ is rich java script mode. It helps you to work on “MVVM” (Model View View Model) architecture pattern.

It helps you to work on “Reactive programming  or push model ". It means you can track your UI changes without much effort what ever changes done on View level (UI) it easily reflected in your viewmodel.

Let up try it and make a sample, but how to start it this is one of the concern.

So here I am with step by step approach how to start it

Step 1:-  Create a  new web project. I have selected empty template. so right now there is no item exists in it

Step 2:- click on nuget package as shown below

Step 3: We need to add first Jquery package so search Jquery package and add it as shown in below fig

Step 4:- Once JQUERY package is installed on your project now add new package which is knockout.Js package as shown in below fig

Step 5:- Once both this package installed we will add a new page which is default.html now add reference of both JQUERY & Knockout.js to this page

Now I am adding employee view as shown below

Let me explain each important line in this.

In our example we have created EmployeeReviewVM function which is basically a view model function for knockout js.In this function we have define Name & Rating two property and one more computed property (dependent on Rating property value).

we have used “ko.observable” it is used for push mode means whatever changed on View should reflect in viewModel also and vice versa.

Now we have used “ko.computed” function it means what ever the value changed of Rating the increment property calculated at runtime.

Step 5:

Now how to use in view part.

So if you see in the above picture we have used data-bind property which basically  bind the EmployeeViewmodel to html. We have used span so internally we have used text if we have used input tag then we can use value property.

Step 6: Now when you run it you will get following  page result.

I hope you are good to go with this. you can use different property like array , for each etc to fetch data.

You can use knockout js for SPA creation.

I hope this  tutorial give you basic idea.

Enjoy Knockout js.

Thanks & Best Regards,

Rajat Jaiswal

Basic of JQuery With Asp.net

1. What is Jquery ?
Answer: Jquery is JavaScript Library whose main moto is to simplifiy the use of java script for a html document.
It is a light weight JavaScript Library that emphasis intraction between JavaScript & Html.
It simplify traversing ,event handling , animation and ajax.

2. How it Works ?
Answer: To Work with Jquery you have to copy the Jquery Js file in your project.
And refrence in your page like <--
script type="text/javascript"
src="jquery.js" --
>
And you can use it. Second point is that you have to start Jquery in $(document).ready event
And all the event will comes under this ready event.
3. Necessary component to work with Asp.net + Jquery?
Answer: For Jquery in Asp.net you need to have to copy two files in your Project and refrence in your project jquery-1.2.6-vsdoc.js & Jquery1.2.6.js
4. Traversing
Ans:
1) you can find particular element in below type
$("#elementId) -- Suppose there a div box with id dvTest <
div id="dvTest"
--> then we have to use $("#dvTest")
$("element"), -- Suppose there div box in page then if we want to change all the div box background color then we can find all the div with $("div")
$("element").eq(index) -- Now if we want to change the background of of first div only then $("div").eq(1) here eq(1) change the background color of index 1 div
$("element").find() -- Search all the element that match with particular expression like $("div").find("p") here we find all the p which are in div tag
$("element").contnent()- it work same as find
$("element").next() - will find next sibling after element.
$("element").nextAll() - wiil find all next sibling after element but not there child element.
$("element").length() - determine number of element in document
$("element").parent.get(0)- will return the parent of element….
$("element").prev ;- get the privious sibling of each of element...
5. Effects :-
Ans:
Jquery makes it easy to show effects now we don't have to write lot of code for some specific animation here are some example.

$("element").toggle(function1,function2) :- By the name its clear that it will toggle the event which we can use in showing different effects.
Ex- if we want to do colour change of div on different click then we do following code
$("#divtest").toggle(function() { $("divtest").css("background-color", "red");}, function ("divtest").css("background-color","blue");});
in the simillar manner we can do different thing also.
$("element").hover(function):- for hover effect.
$("element").FadeIn(intAmount) :- for fade in effect.
$("element").FadeOut(intAmount):- for fade out effect.
$("element").hide(intAmount) :- for hide effect.
$("element").show(intAmount) :- for show effect.
$("element").animate() :- for animation effect we have animate function
for example lets see below example $("#btnFade").click(function() { $("#dvTest").animate({ "left": "+=50px" }, "slow"); });
It will increase left of div test by 50px with slow speed.
$("element").slideToggle() :- it will move up or down according to last action did by element for example.
$("#btnOpen").click(function() {

$("#dvTest").slideToggle('slow', animate());
function animate() {
}
});
The above button click wiill slide up or down with slow speed.
$("element").slideUp(speeed) :- it will slide up the element with desire speed.
$("element").slideDown(speed) :- it will slide down the element with desire speed.
$("element").fadeTo(speed,opacity):- the extra element is opacity means we can define opacity also with speed for particular element fade effect.
$("element").Stop() :- it will stop all the animation running on the element.
7. Events
Ans: Jquery event system is normalize the event object.Then event object is guranteed to be passed in event handler.
Here is more description
1) event.type :- Determine the nature of event.
Ex:- $(a).click(function(event) { alert(event.type);}); it will return "click"
2) event.target:- Give the refrence of DOM element which raised the event.
EX:- $(a).click(function(event){alert(event.target.href);});
Return the url which is assign to a for href property.
3)event.pageX/pageY: - return the mouse position (cordinate) relative to the document.
Ex:- $(a).click(function (event){ alert(event.PageX); alert(event.PageY); });
4) event.preventDefault() :-
it will stop the default exceution action.
EX:- $(a).click(function(event) { event.preventDefault(); alert('test');}); stop the a href ( transfer to another page)
The above are the basic for event object.
5) ready :- On of the most and basic event for Jquery is ready().
It bind the function to be executed when ever the document is ready for traverse and mainupulate.
Its base of jquery it improve web performance as well.
You many have as many as ready event in your web form. It will execute in the order as you define the events. It’s a solid replacment of window.load()
6) Bind() :- Suppose you have more than one paragraph and you want same event on each paragraph then instead of writing each paragraph event.you can bind paragraph with particular event.
Ex:- $("p").bind("onmouseover", function (){ $(this).css("background- color","red");});
7)One() :- suppose we want a event only once on the document then we can bind the event by one.
Then it will run only once on the particular event.
Ex:- suppose we want click event only once on all the div then
$("div").one("click",function() { ($(this).css("background-color", "blue"); });
8) unbind() :- it will just do upposit the bind event.it unbind all the event for match element.
9) blur() :-
trigger blur event on each matched element. Or in other word we can say when focus is lost from the element then this event run.
Ex:- $("txtName").blur(function() { $(this).css("border","2px");});
9) change():- Change event fire when element's value has been modified.
Ex:- $("txtName").change(function() { alert($("txtName").text();});
There are many more events which is as follow click(),
dblClick(),error(),focus(),KeyDown(),KeyPress(), keyUp(),Load(),mouseout(),mouseover(),mouseup(),mousedown(),resize(),Scroll(),
select(),Submit(),unload().
9. Ajax Functionality
Ans:
Jquery is giving many function for using ajax which help to use ajax functionality easy. Here we goes with detail
$.ajax (s) :- its first and basic function for using ajax by Jquery.
Where s I can it collection of different properties which is enclosed in curly brackets "{ }"
1) $.ajax( {type : " GET/POST",
url : " any url" ,
data : "data1=rajat& data2=test", ( any data which you want to pass to the server…)
Success: function () {} , (any operation after successful readystate= 4)
cache : "TRUE/FALSE" ,
});

Ex:- To pass data from client to server we use following example
$.ajax({
type: "POST",
url: "SaveUser.aspx",
data: "name=RAJAT&Surname=JAISWAL",
success: function(msg){
alert( "Data Saved: " + msg );
}
} );

2)load(url) :- by the name it is clear that it will load html of a remote file and inject in current calling element.
Ex:- $("#dvResult").load("htmlPage1.htm");
it will load htmlPage1.htm 's html in div part
3) $.get(url) :- Simplest form to use http get request is $.get which is jquery.get(). We can send data along with this also which is optional part.
EX:- $("save.aspx",{name:"RAJAT", surname:"JAISWAL"});
suppose if want to take back result from Response. Then it has following format $("save.aspx",{name:"RAJAT", surname: "JAISWAL"} , function(data) { alert('do operation' + data);});
4)$.getJASON(url,data,function) :- To get response in json format we use this fuction its same as $get the diffrence here is only one that its respond in Json.
Ex- suppose from server the data return in json format which is { "info":[{ "strFirstName" :"Rajat" , "strLastName" : "Jaiswal"}]}
Then we do below code $.getJSON("default.aspx", function(data) { alert(data.info[0].strFirstName + data.info[0].strLastName); });
5) $.post(url,data,function):- it same as get method just a diffrence that it use post method to send data.
Ex:- $.post("save.aspx");
for more information just visit
http://indiandotnet.wordpress.com/tag/jquery/
Thanks
Rajat Jaiswal