JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 283
  • Score
    100M100P100Q95871F
  • License MIT

Cross-browser, lightweight way to check if user is looking at the page or interacting with it. (wrapper around HTML5 visibility api)

Package Exports

  • @rosskevin/ifvisible
  • @rosskevin/ifvisible/dist/es/index.js
  • @rosskevin/ifvisible/dist/umd/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rosskevin/ifvisible) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@rosskevin/ifvisible

Crossbrowser & lightweight way to check if user is looking at the page or interacting with it.

Check out the Demo or read below for code examples.

Demo

Installation

From npm

npm install @rosskevin/ifvisible

# or

yarn install @rosskevin/ifvisible

Examples

Instantiation

This library provides a singleton exposed as ifvisible by default in addition to a UMD package, but for more advancecd users, they can import the class directly for a different attachment from the ES package.

// import singleton global bound to the `window`
import ifvisible from '@rosskevin/ifvisible'

or for more advanced usage for use cases that a singleton may not be useful, you may instantiate it directly:

// import the object and instantiate it yourself
import { IfVisible } from '@rosskevin/ifvisible'
window.ifvisible = new IfVisible(window, document)

General

// If page is visible right now
if (ifvisible.now()) {
  // Display pop-up
  openPopUp()
}

// You can also check the page status using `now` method
if (!ifvisible.now('hidden')) {
  // Display pop-up if page is not hidden
  openPopUp()
}

// Possible statuses are:
// idle: when user has no interaction
// hidden: page is not visible
// active: page is visible and user is active

Options

E

ifvisible
  .setIdleDuration(120) // default: 30 - Page will become idle after 120 seconds
  .setThrottleDuration(1000) // default: 500 - DOM event triggers will be throttled to avoid bogging down UI

Handle tab switch or browser minimize states

ifvisible.on('blur', function () {
  // example code here..
  animations.pause()
})

ifvisible.on('focus', function () {
  // resume all animations
  animations.resume()
})

on

Listen for activity events such idle or active

ifvisible.on('idle', function () {
  // Stop auto updating the live data
  stream.pause()
})

ifvisible.on('wakeup', function () {
  // go back updating data
  stream.resume()
})

Manually trigger status events

ifvisible.idle() // will put page in a idle status

ifvisible.idle(function () {
  // This code will work when page goes into idle status
})

// other methods are
ifvisible.blur() // will trigger idle event as well
ifvisible.idle()

ifvisible.focus() // Will trigger wakeup event as well
ifvisible.wakeup()

ifvisible.off() to remove event triggers:

ifvisible.off('idle', triggeredFunction) // will remove only triggeredFunction from being tiggered on idle
ifvisible.off('idle') // will remove all events triggered on idle

// works with other events:
ifvisible.off('blur')
ifvisible.off('wakeup')
ifvisible.off('focus')

ifvisible.onEvery to set smart intervals

Only animate a logo if the page is visible.

// If page is visible run this function on every half seconds
ifvisible.onEvery(0.5, function () {
  // Do an animation on the logo only when page is visible
  animateLogo()
})

Advanced

ifvisible.detach() // detach from DOM but keep user listeners stored within ifvisible
ifvisible.reattach() // reattach to DOM and start listening again

Browsers

This library is intended to support modern browsers. Legacy IE support (not Edge) was dropped to clean up code. Given Microsoft discontinued IE altogether, moving forward is in the best interest of maintenance. If you need legacy support, look towards the original ifvisible.js

Why fork?

The original ifvisible.js library was:

  • languishing with no updates
  • old build system
  • outdated dev depencies
  • used typescript but was not strongly typed
  • did not publish the typescript types (even though it was written in typescript)
  • burdened with legacy code everywhere
  • only a UMD module available.
  • we wanted to improve the library

In contrast this version:

  • targets modern browsers only
  • is strongly typed
  • publishes UMD and ES bundles (will publish ESM as that comes to pass as well)
  • is fully updated and maintained

NOTE: this fork was detached for the sole purpose of making new pull requests point to this repo instead of the original unmaintained parent.

License

MIT.