README.md

bsbox

bootstrap base modal/dialog and notification box

Requirements

• jQuery 1.6+
• bootstrap 3.x

Basic Usage

Notification

//it also returns a jQuery element 
  bsbox.notif("Hello World");

//it also returns a jQuery element 
  bsbox.notif({message:'Error Occured',type:'danger'});

Options & Defaults

 sticky: false // timeout will be disable and the notification will remain on the screen unless it was closed by the user
 timeout: 5000,
 type: 'success', //danger,warning,info
 closeBtn: true, //displays "x" button in the notification
 template: 'alert', //the template being used
 closeOnClick: true, //close the notification if clicked
 transitionIn: 'slideDown',
 transitionOut: 'slideUp',
 location: 'bottom left'
 

Adding Notification Template

• addTemplate(name, function) - function should return jQuery element of the container

	bsbox.notif.addTemplate('custom-template',function(options){
		var $template = $('<div class="custom-container">'+ options.message + '</div>');
		return $template;
	});

#Dialog

//it also returns a jQuery element 
  bsbox.dialog("Hello world");

//it also returns a jQuery element 
  bsbox.dialog({title:'Error',message: 'Unknown Error Occured',type:'danger'});

Options & Default

  title: 'Message',
  message: null, //string
  type: null, //string
  buttons: null //array of objects

Working with Dialog Buttons Options

• text - the text for the button
• class - class attribute for the button
• attr - (object) attributes for the button
• on- (object) on events for the button

Sample

  bsbox.dialog({
    title:'Error',
    message: 'Unknow Error Occured',
    type: 'danger',
    buttons:[
	{
		text:'OK',
		attr:{
			'data-dismiss':"modal"
		},
		class: 'btn-primary'
	},
	{
		text: 'Cancel',
		attr:{
			'data-dismiss':"modal"
		},
		class: 'btn-danger',
		on: {
		  click: function(e){ alert("you press cancel") }
		}
	}
    ]
  });

Extension Dialog Module (bsbox-dialog-module.js)

---

wrapper for native javascript alert, confirm, prompt

Alert

• bsbox.alert(message, callback)

	bsbox.alert("Hello World");
	bsbox.alert("Hello World",function(){ 
		alert("its done");
	});

Confirm

• bsbox.confirm(message, callback)

	bsbox.confirm("Are you sure you want to quit?",function(response){ //response is a boolean value
		if(response){
			bsbox.notif("You quit");
		}else{
			bsbox.notif("You rock");
		}
	});

Prompt

• bsbox.prompt(message, callback)

	bsbox.prompt("Whats your name",function(response){ //response - returns the value of the input field
		bsbox.notif("Welcome aboard "+response);
	});