Skip to content

A minimalistic implementation of viewstack in javascript. Viewstack converts a collection of containers such that only one container is visible at a time.

Notifications You must be signed in to change notification settings

niki4810/jquery-viewstack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

viewstack

A minimalistic implementation of viewstack in javascript. Viewstack converts a collection of containers such that only one container is visible at a time.

#Dependencies

jquery-viewstack depends on

  • jQuery &
  • jQuery-ui

How to use

To convert a html container as shown below into a viewstack

<div id="myViewStack">
	<div> container 1 </div>
	<div> container 2 </div>
	<div> container 3 </div>
</div>

Creating a view stack:

//creating a view stack (defaults the view index to 0)
$("#myViewStack").viewstack();

Setting the selected index property:

//passing the selectedIndex as a param
$("#myViewStack").viewstack({
	selectedIndex : 1
});

//or use the options param
$("#myViewStack").viewstack("option", "selectedIndex", 1);

Listening for a creation complete event

$("#myViewStack").viewstack({
	creationComplete : function(e, data) {
		console.log(data.selectedIndex);
	}
})

Listening for selected index change event

$("#myViewStack").viewstack({
	selectedIndexChange : function( e, data ){
		console.log(data.selectedIndex);
	}
});

Get the total number of view stack children

$("#myViewStack").viewstack("getChildrenCount");

Get the viewstack's selectedIndex

 $("#myViewStack").viewstack("getSelectedIndex");

##Example

view an example at : example

License

The MIT License (MIT)

Copyright (c) 2012 Nikhilesh Katakam

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A minimalistic implementation of viewstack in javascript. Viewstack converts a collection of containers such that only one container is visible at a time.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published