---
name: "up.event.onEscape"
area: "API"
kind: "JavaScript function"
parent: "up.event module"
visibility: "experimental"
url: "https://unpoly.com/api/up.event.onEscape"
---
<nav aria-label="Unpoly docs">[All docs](https://unpoly.com/index.md) · [up.event module](https://unpoly.com/api/up.event.md)</nav>

# up.event.onEscape(listener)

**This feature is experimental**. Please [share](https://github.com/unpoly/unpoly/discussions) your experiences so we know what to keep or change.

Registers an event listener to be called when the user presses the `Escape` key.

## Example {#example}

```js
up.event.onEscape(function(event) {
  console.log('Escape pressed!')
})
```

---

## Parameters {#parameters}

### listener {#listener}

(required)

The listener function that will be called when `Escape` is pressed.

Type: Function([Event](https://developer.mozilla.org/en-US/docs/Web/API/Event))