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

# up:layer:dismiss

This event is emitted _before_ a layer is [dismissed](https://unpoly.com/learn/closing-overlays.md).

The event is emitted on the [element of the layer](https://unpoly.com/api/up.layer.element.md) that is about to close.

<nav aria-label="Guides">

- [Learn: Closing overlays](https://unpoly.com/learn/closing-overlays.md)

</nav>

---

## Event properties {#properties}

### event.layer {#event.layer}

(required)

The layer that is about to close.

Type: [up.Layer](https://unpoly.com/api/up.Layer.md)

### [event.value] {#event.value}

(optional)

The overlay's [dismissal value](https://unpoly.com/learn/closing-overlays.md#dismissal-values).

Listeners can replace or mutate this value.

Type: any

### [event.origin] {#event.origin}

(optional)

The element that is causing the layer to close.

Will be `undefined` if the overlay is not closing due to a user interacting with an element.

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

### [event.response] {#event.response}

(optional)

The server response that is causing this overlay to close.

Will be `undefined` if the overlay is not closing in reaction to a server response.

See [Using the discarded response](https://unpoly.com/learn/closing-overlays.md#using-the-discarded-response).

Type: [up.Response](https://unpoly.com/api/up.Response.md)

### event.preventDefault() {#event.preventDefault}

(required)

Event listeners can call this method to prevent the overlay from closing.

This has no effect when the overlay is closed because a background layer is being [updated](https://unpoly.com/learn/closing-overlays.md#peeling). In that case `event.value` is `':peel'`.

To prevent closing for a single overlay, pass an [`{ onDismiss }`](https://unpoly.com/api/up.layer.open.md#options.onDismiss) option or set an [`[up-on-dismiss]`](https://unpoly.com/api/up-layer-new.md#up-on-dismiss) attribute when opening it.

