Skip to content

Programmatically trigger a DOM event. Useful for unit testing mostly.

License

Notifications You must be signed in to change notification settings

isabella232/trigger-event

 
 

Repository files navigation

trigger-event

CircleCI Codecov

Programmatically trigger a DOM event. Useful for testing mostly.

Installation

$ npm install @segment/trigger-event

Example

var trigger = require('trigger-event');
trigger(button, 'click', { meta: true });
trigger(document, 'keydown', { key: 'enter' });

Shorthand for keys:

trigger('keydown', { key: 'enter' })

API

trigger(type, [element], [options])

Types:

'click'
'dblclick'
'keydown'
'keyup'

Element will default to document if none is provided.

Default options:

alt        : false,
bubbles    : true,
button     : 0,
cancelable : true,
clientX    : 0,
clientY    : 0,
ctrl       : false,
detail     : 1,
key        : 0, // can be a string like 'enter' for convenience
meta       : false,
screenX    : 0,
screenY    : 0,
shift      : false,
view       : window

About

Programmatically trigger a DOM event. Useful for unit testing mostly.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 74.4%
  • Makefile 25.6%