# minimum-viewport

> Check whether the viewport is at least a certain size

Latest version **1.0.0** (published 2015-08-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install minimum-viewport
pnpm add minimum-viewport
yarn add minimum-viewport
bun add minimum-viewport
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-08-24 |
| First published | 2015-08-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | viewport, window, size, x, y, coordinates |

## Links

- npm: https://www.npmjs.com/package/minimum-viewport
- Repository: https://github.com/bendrucker/minimum-viewport
- Homepage: https://github.com/bendrucker/minimum-viewport#readme
- Issues: https://github.com/bendrucker/minimum-viewport/issues
- npm.io page: https://npm.io/package/minimum-viewport

## Dependencies (3)

- [defined](https://npm.io/package/defined.md) ~1.0.0
- [view-size](https://npm.io/package/view-size.md) ~1.0.1
- [assert-coordinates](https://npm.io/package/assert-coordinates.md) ~1.0.0

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2015-08-24

## README

# minimum-viewport [![Build Status](https://travis-ci.org/bendrucker/minimum-viewport.svg?branch=master)](https://travis-ci.org/bendrucker/minimum-viewport)

> Check whether the viewport is at least a certain size


## Install

```
$ npm install --save minimum-viewport
```


## Usage

```js
var minimumViewport = require('minimum-viewport')

minimumViewport({
  x: 320,
  y: 568
})
//=> true on iPhone 5, false on an Apple Watch
```

## API

#### `minimumViewport(dimensions)` -> `output`

##### dimensions

*Required*  
Type: `object`

An object with x/y dimensions. If either dimension is omitted, it will ignored. For example, `{x: 500}` will match any viewport that's at least 500px wide, regardless of height.


## License

MIT © [Ben Drucker](http://bendrucker.me)

---
_Source: https://npm.io/package/minimum-viewport · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._