221

What is the best way to simulate a user entering text in a text input box in JS and/or jQuery?

I don't want to actually put text in the input box, I just want to trigger all the event handlers that would normally get triggered by a user typing info into a input box. This means focus, keydown, keypress, keyup, and blur. I think.

So how would one accomplish this?

Brian Tompsett - 汤莱恩
  • 5,753
  • 72
  • 57
  • 129
Alex
  • 64,178
  • 48
  • 151
  • 180

9 Answers9

271

You can trigger any of the events with a direct call to them, like this:

$(function() {
    $('item').keydown();
    $('item').keypress();
    $('item').keyup();
    $('item').blur();
});

Does that do what you're trying to do?

You should probably also trigger .focus() and potentially .change()

If you want to trigger the key-events with specific keys, you can do so like this:

$(function() {
    var e = $.Event('keypress');
    e.which = 65; // Character 'A'
    $('item').trigger(e);
});

There is some interesting discussion of the keypress events here: jQuery Event Keypress: Which key was pressed?, specifically regarding cross-browser compatability with the .which property.

Community
  • 1
  • 1
ebynum
  • 3,494
  • 1
  • 18
  • 15
109

You could dispatching events like

el.dispatchEvent(new Event('focus'));
el.dispatchEvent(new KeyboardEvent('keypress',{'key':'a'}));
aljgom
  • 7,879
  • 3
  • 33
  • 28
  • 7
    or `el.dispatchEvent(new Event('keypress', {keyCode: 'a'}))` – cuzox May 10 '18 at 20:51
  • 4
    @Cuzox why not use KeyboardEvent? It autofills values like shiftKey and it is the correct way. Also, you put a string in keyCode, that is wrong. – SuperOP535 Sep 13 '18 at 14:16
  • 13
    If you need `Ctrl`: `el.dispatchEvent(new KeyboardEvent('keydown', { keyCode: 70, ctrlKey: true }));` (This will cause a shortcut `Ctrl + F`) – Илья Зеленько Dec 06 '18 at 15:43
  • 1
    KeyboardEvent([typeArg](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#events), [KeyboardEventInit](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)) – Joshua Dec 04 '21 at 21:27
35

To trigger an enter keypress, I had to modify @ebynum response, specifically, using the keyCode property.

e = $.Event('keyup');
e.keyCode= 13; // enter
$('input').trigger(e);
cloakedninjas
  • 4,007
  • 2
  • 31
  • 45
  • 3
    `keydown` event isn't being caught, or am I doing something wrong here? fiddle.jshell.net/Palestinian/8d8J9 – Omar Jul 21 '13 at 00:27
  • @cloak: it works. Check my comment here for a complete selector to fix asp.net controls: http://www.codeproject.com/Tips/269388/How-prevent-Textbox-postback-when-hit-enter-key-in?msg=5145046#xx5145046xx Make sure you call it after you insert anything in the dom if using Ajax. – Dan Randolph Oct 16 '15 at 23:32
29

You can achieve this with: EventTarget.dispatchEvent(event) and by passing in a new KeyboardEvent as the event.

For example: element.dispatchEvent(new KeyboardEvent('keypress', {'key': 'a'}))

Working example:

// get the element in question
const input = document.getElementsByTagName("input")[0];

// focus on the input element
input.focus();

// add event listeners to the input element
input.addEventListener('keypress', (event) => {
  console.log("You have pressed key: ", event.key);
});

input.addEventListener('keydown', (event) => {
  console.log(`key: ${event.key} has been pressed down`);
});

input.addEventListener('keyup', (event) => {
  console.log(`key: ${event.key} has been released`);
});

// dispatch keyboard events
input.dispatchEvent(new KeyboardEvent('keypress',  {'key':'h'}));
input.dispatchEvent(new KeyboardEvent('keydown',  {'key':'e'}));
input.dispatchEvent(new KeyboardEvent('keyup', {'key':'y'}));
<input type="text" placeholder="foo" />

MDN dispatchEvent

MDN KeyboardEvent

JSON C11
  • 11,272
  • 7
  • 78
  • 65
28

Here's a vanilla js example to trigger any event:

function triggerEvent(el, type){
if ('createEvent' in document) {
        // modern browsers, IE9+
        var e = document.createEvent('HTMLEvents');
        e.initEvent(type, false, true);
        el.dispatchEvent(e);
    } else {
        // IE 8
        var e = document.createEventObject();
        e.eventType = type;
        el.fireEvent('on'+e.eventType, e);
    }
}
Sionnach733
  • 4,686
  • 4
  • 36
  • 51
  • 10
    Can you furnish a few examples of usage? How would your function be used to send a keycode? – Mac Feb 14 '17 at 14:52
  • 10
    The source code for this post can be found at the following link which includes documentation: https://plainjs.com/javascript/events/trigger-an-event-11/ – Kieren Dixon Sep 12 '17 at 06:48
11

You're now able to do:

var e = $.Event("keydown", {keyCode: 64});
simonzack
  • 19,729
  • 13
  • 73
  • 118
3

First of all, I need to say that sample from Sionnach733 worked flawlessly. Some users complain about absent of actual examples. Here is my two cents. I've been working on mouse click simulation when using this site: https://www.youtube.com/tv. You can open any video and try run this code. It performs switch to next video.

function triggerEvent(el, type, keyCode) {
    if ('createEvent' in document) {
            // modern browsers, IE9+
            var e = document.createEvent('HTMLEvents');
            e.keyCode = keyCode;
            e.initEvent(type, false, true);
            el.dispatchEvent(e);
    } else {
        // IE 8
        var e = document.createEventObject();
        e.keyCode = keyCode;
        e.eventType = type;
        el.fireEvent('on'+e.eventType, e);
    }
}

var nextButton = document.getElementsByClassName('icon-player-next')[0];
triggerEvent(nextButton, 'keyup', 13); // simulate mouse/enter key press
yuliskov
  • 1,379
  • 15
  • 16
3

For typescript cast to KeyboardEventInit and provide the correct keyCode integer

const event = new KeyboardEvent("keydown", {
          keyCode: 38,
        } as KeyboardEventInit);
EugenSunic
  • 13,162
  • 13
  • 64
  • 86
2

I thought I would draw your attention that in the specific context where a listener was defined within a jQuery plugin, then the only thing that successfully simulated the keypress event for me, eventually caught by that listener, was to use setTimeout(). e.g.

setTimeout(function() { $("#txtName").keypress() } , 1000);

Any use of $("#txtName").keypress() was ignored, although placed at the end of the .ready() function. No particular DOM supplement was being created asynchronously anyway.

Fabien Haddadi
  • 1,814
  • 17
  • 22