{"_id":"viewport-dimensions","_rev":"249789","name":"viewport-dimensions","description":"Simple utility for watching and retrieving browser viewport width, height, vmin and vmax","dist-tags":{"latest":"0.2.0"},"maintainers":[{"name":"alexdunphy","email":"alexanderdunphy@gmail.com"}],"time":{"modified":"2021-06-03T16:11:12.000Z","created":"2015-08-17T20:27:06.134Z","0.2.0":"2015-09-03T16:26:24.877Z","0.1.0":"2015-08-17T20:27:06.134Z"},"users":{},"author":{"name":"Alex Dunphy","email":"alexanderdunphy@gmail.com"},"repository":{"type":"git","url":"git+ssh://git@github.com/alexdunphy/viewport.git"},"versions":{"0.2.0":{"name":"viewport-dimensions","version":"0.2.0","description":"Simple utility for watching and retrieving browser viewport width, height, vmin and vmax","author":{"name":"Alex Dunphy","email":"alexanderdunphy@gmail.com"},"main":"index.js","scripts":{"test":"gulp dev","coveralls":"if [ ! -f ./test/coverage/lcov.info ]; then npm test; fi; cat ./test/coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"},"repository":{"type":"git","url":"git+ssh://git@github.com/alexdunphy/viewport.git"},"bugs":{"url":"https://github.com/alexdunphy/viewport/issues"},"homepage":"https://github.com/alexdunphy/viewport","license":"MIT","devDependencies":{"bower":"^1.5.2","chai":"^3.2.0","coveralls":"^2.11.4","gulp":"^3.9.0","gulp-eslint":"^1.0.0","gulp-header":"^1.7.1","gulp-notify":"^2.2.0","gulp-rename":"^1.2.2","gulp-uglify":"^1.4.0","gulp-util":"^3.0.6","karma":"^0.13.9","karma-coverage":"^0.5.1","karma-mocha":"^0.2.0","karma-mocha-reporter":"^1.1.1","karma-notify-reporter":"^0.1.1","karma-phantomjs-launcher":"^0.2.1","karma-sauce-launcher":"^0.2.14","karma-sinon-chai":"^1.0.0","lodash":"^3.10.1","mocha":"^2.3.0","phantomjs":"^1.9.18","run-sequence":"^1.1.2","webpack":"^1.12.0"},"keywords":["viewport","browser","window","document","width","height","innerWidth","innerHeight","clientWidth","clientHeight","dimensions","dimension"],"gitHead":"66f8ccc6e35cb15d3a2b8889e7d59706c43486d8","_id":"viewport-dimensions@0.2.0","_shasum":"de740747db5387fd1725f5175e91bac76afdf36c","_from":".","_npmVersion":"2.8.4","_nodeVersion":"0.12.2","_npmUser":{"name":"alexdunphy","email":"alexanderdunphy@gmail.com"},"dist":{"shasum":"de740747db5387fd1725f5175e91bac76afdf36c","size":4018,"noattachment":false,"key":"/viewport-dimensions/-/viewport-dimensions-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/viewport-dimensions/download/viewport-dimensions-0.2.0.tgz"},"maintainers":[{"name":"alexdunphy","email":"alexanderdunphy@gmail.com"}],"directories":{},"publish_time":1441297584877,"_cnpm_publish_time":1441297584877,"_hasShrinkwrap":false},"0.1.0":{"name":"viewport-dimensions","version":"0.1.0","description":"Simple utility for watching and retrieving browser viewport width, height, vmin and vmax","main":"index.js","scripts":{"test":"gulp dev","coveralls":"if [ ! -f ./test/coverage/lcov.info ]; then npm test; fi; cat ./test/coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"},"repository":{"type":"git","url":"git@github.com:alexdunphy/viewport.git"},"bugs":{"url":"https://github.com/alexdunphy/viewport/issues"},"homepage":"https://github.com/alexdunphy/viewport","license":"MIT","devDependencies":{"chai":"^3.2.0","coveralls":"^2.11.3","gulp":"^3.9.0","gulp-eslint":"^1.0.0","gulp-header":"^1.2.2","gulp-if":"^1.2.5","gulp-notify":"^2.2.0","gulp-rename":"^1.2.2","gulp-uglify":"^1.2.0","gulp-util":"^3.0.6","karma":"^0.13.9","karma-coverage":"^0.5.0","karma-mocha":"^0.2.0","karma-mocha-reporter":"^1.1.1","karma-notify-reporter":"^0.1.1","karma-phantomjs-launcher":"^0.2.1","karma-sauce-launcher":"^0.2.14","karma-sinon-chai":"^1.0.0","lodash":"^3.10.1","mocha":"^2.2.5","phantomjs":"^1.9.18","run-sequence":"^1.1.2","webpack":"^1.11.0"},"gitHead":"35e9fbb7b52834f61903d43480e6d1cb297368c9","_id":"viewport-dimensions@0.1.0","_shasum":"c1b241ab59c8cc01c5c84148955d59d2bca58333","_from":".","_npmVersion":"2.7.4","_nodeVersion":"0.12.2","_npmUser":{"name":"alexdunphy","email":"alexanderdunphy@gmail.com"},"dist":{"shasum":"c1b241ab59c8cc01c5c84148955d59d2bca58333","size":83755,"noattachment":false,"key":"/viewport-dimensions/-/viewport-dimensions-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/viewport-dimensions/download/viewport-dimensions-0.1.0.tgz"},"maintainers":[{"name":"alexdunphy","email":"alexanderdunphy@gmail.com"}],"directories":{},"publish_time":1439843226134,"_cnpm_publish_time":1439843226134,"_hasShrinkwrap":false}},"readme":"[![Travis CI status](https://img.shields.io/travis/alexdunphy/viewport.svg)](https://travis-ci.org/alexdunphy/viewport)\n[![Coveralls status](https://img.shields.io/coveralls/alexdunphy/viewport.svg)](https://coveralls.io/r/alexdunphy/viewport)\n[![devDependencies status](https://img.shields.io/david/dev/alexdunphy/viewport.svg)](https://david-dm.org/alexdunphy/viewport#info=devDependencies)\n\n[![Sauce Labs status](https://saucelabs.com/browser-matrix/alexdunphy-viewport.svg)](https://saucelabs.com/u/alexdunphy-viewport)\n\n# Viewport\n\nSimple utility for watching and retrieving browser viewport width, height, vmin and vmax.\n\n`documentElement.clientWidth` is used (rather than `window.innerWidth`), so reported viewport dimensions will exclude scrollbar dimensions.\n\n## Install\n\n#### Bower\n\n`bower install -S viewport-dimensions`\n\n#### npm\n\n`npm i -S viewport-dimensions`\n\n(One object is exported:)\n\n```javascript\nvar viewport = require('viewport');\n```\n\n## API\n\n### #width()\nReturns _{number}_ - Browser viewport width.\n\n```javascript\nviewport.width(); // (e.g.) 1024\n```\n\n### #height()\nReturns _{number}_ - Browser viewport height.\n\n```javascript\nviewport.height(); // (e.g.) 768\n```\n\n### #max()\nReturns _{number}_ - Maximum browser dimension (width/height).\n\n```javascript\nviewport.max(); // (e.g.) 1024\n```\n\n### #min()\nReturns _{number}_ - Minimum browser dimension (width/height).\n\n```javascript\nviewport.height(); // (e.g.) 768\n```\n\n### #setDimensions()\nSet internal dimension references to current browser viewport width and height.\n\n```javascript\nviewport.setDimensions();\n```\n\n## Environment\n\nWon't generate errors if run server-side, but won't do anything too useful either.\n\n## Development\n\n1. Clone repo and `npm install`\n2. Make changes and ensure linting (`gulp lint`) & tests (`gulp test`) pass (combined task: `gulp dev`)\n3. Create distributable files (`gulp dist`) - combined dev + dist task: `gulp`\n\nUse `gulp watch` to run linter and tests on each file change (equivalent to manually running `gulp dev`).\n","_attachments":{},"homepage":"https://github.com/alexdunphy/viewport","bugs":{"url":"https://github.com/alexdunphy/viewport/issues"},"license":"MIT"}