1.0.0 ā¢ Published 3 years ago
@ifake/page-visibility v1.0.0
Welcome to @ifake/page-visibility š
Wrapper for the Page Visibility API.
The scaffolding for this project is from pkg
š Homepage
Document
WIP
Usage
# Make sure you have yarn installed on your machine.
yarn add @ifake/page-visibility
# or
npm install @ifake/page-visibility
- Browser
// We expose a global variable that can be used directly in the browser.
const IFPageVisible = window.IFPageVisible
- ES6 Module
import { pageVisibility } from '@ifake/page-visibility'
pageVisibility.observe(isVisible => {
if (isVisible) {
// Page show do something
console.log("Page show")
} else {
// Page hide do something
console.log("Page show")
}
})
// cancel listen
pageVisibility.unobserve()
API
WIP
TODO
- Add
blur
&focus
events for browsers that don't support the API or for users who have special needs
Author
š¤ ifake
š¤ Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
Show your support
Give a āļø if this project helped you!
š License
This project is MIT licensed.
This README was generated with ā¤ļø by readme-md-generator