happen

real browser events

Package: happen

Created by: tmcw

Last modified: Tue, 11 Jul 2023 18:13:24 GMT

Version: 0.3.2

License: BSD-2-Clause

Downloads: 6,194

Repository: https://github.com/tmcw/happen

Install

npm install happen

yarn add happen

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');