The happen from tmcw

happen's Introduction

happen wraps the createEvent DOM API to make real event mocking in-browser palatable.

Installation

Raw:

wget https://raw.github.com/tmcw/happen/master/happen.js

With component

component install tmcw/happen

With Browserify

npm install happen

var happen = require('happen');

With bower

bower install tmcw/happen

Native API

once()

happen.once(element, options) fires an event once. The element must be a DOM element. options must have a type for event type, then can have options:

Keyboard Events

keyCode
charCode
shiftKey
metaKey
ctrlKey
altKey

Mouse Events

detail
screenX
screenY
clientX
clientY
ctrlKey
altKey
shiftKey
metaKey
button

Touch Events

touchstart
touchmove
touchend

var element = document.getElementById('map');

// click shortcut
happen.click(element);

// dblclick shortcut
happen.dblclick(element);

// custom options
happen.dblclick(element, { shift: true });

// any other event type under MouseEvents
happen.once(element, {
    type: 'mousewheel',
    detail: -100
});

// The once api takes
happen.once(
    // element
    element, {
        // event type (e.type)
        type: 'mousewheel',
        // any other options
        detail: -100
    });

// touch events
happen.once(element, {
        type : 'touchstart',
        touches : [{
                pageX : 800,
                pageY : 800
            },
            {
                pageX : 400,
                pageY : 400
            }]
    });

jQuery Plugin

// Shortcut - 'click' is shorthand for { type: 'click' }
$('.foo').happen('click');

// Longhand - specify any sort of properties
$('.foo').happen({ type: 'keyup', keyCode: 50 });

// Works on any jQuery selection
$('.foo, .bar').happen('dblclick');

Shortcuts:

happen.click
happen.dblclick
happen.mousedown
happen.mouseup
happen.mousemove
happen.keydown
happen.keyup
happen.keypress

Use it with a testing framework, like Jasmine or Mocha.

(IE tests failing due to Chai)

Contributors

Stargazers

Watchers

happen's Issues

keyboard events are broken in webkit (safari)

because of

https://bugs.webkit.org/show_bug.cgi?id=16735

Possibly using DOM4 Event is the way forward.

0.1.3?

0.1.3 is published to npm but hasn't been pushed here?

Something changed in 0.1.3 that broke iD tests: https://travis-ci.org/systemed/iD/builds/10824071

needs a fresh release?

the current tag points to a version which had an empty index.js file. I can use the git hash but a fresh release would be nicer.

Read and use synth

http://hg.mozilla.org/mozilla-central/annotate/a666b4f809f0/testing/mochitest/tests/SimpleTest/EventUtils.js#l248

jQuery extension

This shouldn't be as annoying to use with jQuery.

It would be great to try creating events with the KeyboardEvent() constructor, then fall back to using [initKeyEvent / initKeyboardEvent](https://developer.mozilla.org/en-
US/docs/Web/API/KeyboardEvent/initKeyEvent) which are now deprecated in modern browsers.

This would let us generate test events with DOM3 features like KeyboardEvent.key.

(probably goes for Mouse and Touch events too)