https://github.com/bendrucker/document-visibility
Handle changes to browser document visibility using the Page Visibility API
https://github.com/bendrucker/document-visibility
Last synced: over 1 year ago
JSON representation
Handle changes to browser document visibility using the Page Visibility API
- Host: GitHub
- URL: https://github.com/bendrucker/document-visibility
- Owner: bendrucker
- License: mit
- Created: 2016-01-15T15:56:54.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-11-13T19:04:38.000Z (over 7 years ago)
- Last Synced: 2025-04-10T08:13:59.666Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 6.84 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# document-visibility [](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
var unlisten = 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)