thealeksey / jquery-one-click-outside

Get called when someone clicks outside

#jQuery One Click Outside

jQuery.oneClickOutside is a lightweight jQuery plugin (1kb) that let's you add a one-time callback for a click outside of an element. After that all event listeners are automatically removed and the plugin instance is destroyed.

Click here for a demo.

Download the production version (minified) or the development version.

##basic use

    $(".some-element").oneClickOutside({callback:function(){
    	$(".some-element").hide();
    }});

If you decide that you want to cancel the callback, use the "off" method:

    $(".some-element").oneClickOutside("off");

If you have some outside elements that should not trigger the callback, define some exceptions:

    $(".some-element").oneClickOutside({callback:function(){
    	$(".some-element").hide();
    },
    exceptions:".exception"
    });

If you are initializing oneClickOutside from a click handler for the same element, you have to tell that to oneClickOutside with a second parameter:

    $(".some-element").oneClickOutside({callback:function(){
    	$(".some-element").hide();
    },
    calledFromClickInsideHandler:true //parameter: calledFromClickInsideHandler
    });

If you want to refer with "this" to the object the callback is a member of from within the callback, use the thisArg option:

	var obj = {
		callback:function(){
    		alert("My name is "+this.name);
    	},
    	name:"Peter"
	};
    $(".some-element").oneClickOutside({callback:obj.callback, thisArg:obj});

##license

The MIT License (MIT)

Copyright (c) 2014 Christian Voigt

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.