# document-visibility

> Handle changes to browser document visibility

Latest version **1.0.1** (published 2016-01-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install document-visibility
pnpm add document-visibility
yarn add document-visibility
bun add document-visibility
```

## 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.1 |
| Published | 2016-01-15 |
| First published | 2016-01-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | document, browser, visibility, page, api |

## Links

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

## Dependencies (2)

- [geval](https://npm.io/package/geval.md) ~2.1.1
- [global](https://npm.io/package/global.md) ~4.3.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-01-15
- 1.0.0 — 2016-01-15

## README

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

> Handle changes to browser document visibility using the [Page Visibility API](https://developer.mozilla.org/en-US/docs/Web/API/Page_Visibility_API)


## Install

```
$ npm install --save document-visibility
```


## Usage

```js
var Visibility = require('document-visibility')
var visibility = Visibility()

visibility.visible()
//=> true/false

visibility.onChange(function (visible) {
  //=> true/false  
})
```

## API

#### `visibility.visible()` -> `boolean`

Returns the visibility of the document. If the browser does not support the visibility API, this will always be `true`.

#### `visibility.onChange(fn)` -> `function`

Returns an unlisten function.

##### fn

*Required*  
Type: `function`  
Arguments: `visible`

A function to call when the page visibility changes.


## License

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

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