Socket
Socket
Sign inDemoInstall

events-polyfill

Package Overview
Dependencies
0
Maintainers
1
Versions
23
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    events-polyfill

Polyfill event : EventListener, EventTarget, Event, CustomEvent, MouseEvent, KeyboardEvent, FocusEvent, PointerEvent and add support for options (like 'once')


Version published
Maintainers
1
Install size
95.9 kB
Created

Readme

Source

Polyfill different events classes and methods to match last ES7 specifications

Tested on IE 10+

Install
npm i events-polyfill --save

For fast use import 'events-polyfill' (will import index.js).

[INFO] New release v2 that allow you to import specific polyfills only:

  • you can use webpack (or any bundler) to import only required polyfills from src/.
  • or you can import index.js (or index.min.js) at the root to polyfill everything.
src/constructors/*.js

Polyfill for : Event, CustomEvent, MouseEvent, KeyboardEvent, FocusEvent PointerEvent

src/ListenerOptions.js

Polyfill for the options argument of :

EventTarget.prototype.addEventListener(type, listener[, options]);
EventTarget.prototype.removeEventListener(type, listener[, options]);

options : last parameter which replace boolean useCapture

  • once : trigger only once this event (default: false)
  • passive : allow browser to continue animations (ex: while scrolling) by 'disabling' event.preventDefault() (default: false)
  • capture : replace useCapture (default: false)
Example:
document.addEventListener('click', function() {
    console.log('clicked once');
}, { once: true });
src/ListenerEventTypes.js

Polyfill for the type argument of :

EventTarget.prototype.addEventListener(type, listener[, options]);
EventTarget.prototype.removeEventListener(type, listener[, options]);

Polyfill vendor prefixed events like 'pointerlockchange' (try 'pointerlockchange', 'mozpointerlockchange' and 'webkitpointerlockchange') and some 'experimental' events like 'wheel' (try 'wheel', 'mousewheel', 'DOMMouseScroll')

  • [INFO] If option can't be polyfilled : throw an error (allow you to check is event type is supported)

Currently polyfilled types :

[
    'wheel',
    'pointerlockchange', 'pointerlockerror',
    'fullscreenchange', 'fullscreenerror',
    'animationend', 'animationiteration', 'animationstart', 'transitionend',
    'pointercancel', 'pointerdown', 'pointerhover', 'pointermove', 'pointerout', 'pointerover', 'pointerup'
]

FAQs

Last updated on 25 Apr 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc