viewport-dimensions

WebJar for viewport-dimensions

License	MIT
GroupId	org.webjars.npm
ArtifactId	viewport-dimensions
Last Version	0.2.0
Release Date	Sep 2, 2017
Type	jar
Description	viewport-dimensions WebJar for viewport-dimensions
Project URL	http://webjars.org
Source Code Management	https://github.com/alexdunphy/viewport

Download viewport-dimensions

Filename	Size
viewport-dimensions-0.2.0.pom
viewport-dimensions-0.2.0.jar	8 KB
viewport-dimensions-0.2.0-sources.jar	22 bytes
viewport-dimensions-0.2.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/viewport-dimensions/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>viewport-dimensions</artifactId>
    <version>0.2.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/viewport-dimensions/
implementation 'org.webjars.npm:viewport-dimensions:0.2.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/viewport-dimensions/
implementation ("org.webjars.npm:viewport-dimensions:0.2.0")

Apache Buildr

'org.webjars.npm:viewport-dimensions:jar:0.2.0'

Apache Ivy

<dependency org="org.webjars.npm" name="viewport-dimensions" rev="0.2.0">
  <artifact name="viewport-dimensions" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='viewport-dimensions', version='0.2.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "viewport-dimensions" % "0.2.0"

Leiningen

[org.webjars.npm/viewport-dimensions "0.2.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Viewport

Simple utility for watching and retrieving browser viewport width, height, vmin and vmax.

documentElement.clientWidth is used (rather than window.innerWidth), so reported viewport dimensions will exclude scrollbar dimensions.

Install

Bower

bower install -S viewport-dimensions

npm

npm i -S viewport-dimensions

(One object is exported:)

var viewport = require('viewport');

API

#width()

Returns {number} - Browser viewport width.

viewport.width(); // (e.g.) 1024

#height()

Returns {number} - Browser viewport height.

viewport.height(); // (e.g.) 768

#max()

Returns {number} - Maximum browser dimension (width/height).

viewport.max(); // (e.g.) 1024

#min()

Returns {number} - Minimum browser dimension (width/height).

viewport.height(); // (e.g.) 768

#setDimensions()

Set internal dimension references to current browser viewport width and height.

viewport.setDimensions();

Environment

Won't generate errors if run server-side, but won't do anything too useful either.

Development

1. Clone repo and npm install
2. Make changes and ensure linting (gulp lint) & tests (gulp test) pass (combined task: gulp dev)
3. Create distributable files (gulp dist) - combined dev + dist task: gulp

Use gulp watch to run linter and tests on each file change (equivalent to manually running gulp dev).

Versions

Version
0.2.0 Sep 2, 2017