---
permalink: "pat/backdrop/"
title: Backdrop
---

# Backdrop pattern.

Renders a dark background.

---
**Deprecated**

This pattern is deprecated. Just use plain CSS instead.

---

## Configuration

|     Option      |  Type   |      Default      |                  Description                   |
| :-------------: | :-----: | :---------------: | :--------------------------------------------: |
|     zIndex      | integer |       null        |          z-index of backdrop element.          |
|     opacity     |  float  |        0.8        |       opacity level of backdrop element.       |
|    className    | string  |    'backdrop'     |        class name of backdrop element.         |
| classActiveName | string  | 'backdrop-active' |      class name when backdrop is active.       |
|   closeOnEsc    | boolean |       true        | should backdrop close when ESC key is pressed. |
|  closeOnClick   | boolean |       true        |   should backdrop close when clicked on it.    |