added isElementOnScreen

CHANGELOG.md

@@ -1,3 +1,6 @@
+## v1.2.0 - 2015-06-02
+* added isElementOnScreen
+
 ## v1.1.0 - 2015-06-01
 * Added dist file: dist/viewability.js
 * File name changes.

README.md

@@ -41,10 +41,12 @@ Finding out if the element is 100% on screen and using Common JS:
 ```js
 var v = require('viewability');
 var el = document.getElementById('blue-box');
-if (v.horizontal(el).value === 0 && v.vertical(el).value === 0) {
-  console.log('100% on screen.')
-} else if (v.horizontal(el).value > 0 || v.value(el).value > 0) {
-  console.log('Part of element in on screen.')
+if (v.isElementOnScreen(el, true)) {
+  console.log('100% on screen.');
+} else if (v.isElementOnScreen(el)) {
+  console.log('Some parts are on screen');
+} else {
+  console.log('not on screen at all');
 }
 ```
 

bower.json

@@ -1,7 +1,7 @@
 {
   "name": "viewability",
   "main": "dist/viewability.js",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Returns how viewable an element is",
   "homepage": "https://github.com/kahwee/viewability",
   "authors": [

dist/viewability.js

@@ -49,6 +49,17 @@ module.exports = function(el) {
 };
 
 },{}],2:[function(require,module,exports){
+var horizontal = require('./horizontal');
+var vertical = require('./vertical');
+module.exports = function(el, full) {
+	if (full) {
+		return vertical(el).value * horizontal(el).value === 1;
+	} else {
+		return vertical(el).value > 0 || horizontal(el).value > 0;
+	}
+};
+
+},{"./horizontal":1,"./vertical":3}],3:[function(require,module,exports){
 module.exports = function(el) {
 	var windowHeight = window.innerHeight;
 	var elemTop = el.getBoundingClientRect().top;
@@ -98,11 +109,12 @@ module.exports = function(el) {
 	};
 };
 
-},{}],3:[function(require,module,exports){
+},{}],4:[function(require,module,exports){
 module.exports = {
 	vertical: require('./vertical'),
-	horizontal: require('./horizontal')
+	horizontal: require('./horizontal'),
+	isElementOnScreen: require('./isElementOnScreen')
 };
 
-},{"./horizontal":1,"./vertical":2}]},{},[3])(3)
+},{"./horizontal":1,"./isElementOnScreen":2,"./vertical":3}]},{},[4])(4)
 });

isElementOnScreen.js

@@ -0,0 +1,9 @@
+var horizontal = require('./horizontal');
+var vertical = require('./vertical');
+module.exports = function(el, full) {
+	if (full) {
+		return vertical(el).value * horizontal(el).value === 1;
+	} else {
+		return vertical(el).value > 0 || horizontal(el).value > 0;
+	}
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "viewability",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Returns how viewable an element is",
   "main": "dist/viewability.js",
   "scripts": {

viewability.js

@@ -1,4 +1,5 @@
 module.exports = {
 	vertical: require('./vertical'),
-	horizontal: require('./horizontal')
+	horizontal: require('./horizontal'),
+	isElementOnScreen: require('./isElementOnScreen')
 };