Phaser API Documentation

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord
Event: KEY_UP


The Key Up Event.

This event is dispatched by the Keyboard Plugin when any key on the keyboard is released.

Unlike the ANY_KEY_UP event, this one has a special dynamic event name. For example, to listen for the A key being released use the following from within a Scene: this.input.keyboard.on('keyup-A', listener). You can replace the -A part of the event name with any valid Key Code string. For example, this will listen for the space bar: this.input.keyboard.on('keyup-SPACE', listener).

You can also create a generic 'global' listener. See Keyboard.Events.ANY_KEY_UP for details.

Finally, you can create Key objects, which you can also listen for events from. See Keyboard.Events.UP for details.


name type description
event KeyboardEvent

The native DOM Keyboard Event. You can inspect this to learn more about the key that was released, any modifiers, etc.

Since: 3.0.0