# UseGridOverlayOptions

> _Since v1.4.0_

Options for useGridOverlay.

## Properties

| Property | Type | Description |
| -------- | ---- | ----------- |
| `open?` | <code>MaybeRef&lt;boolean&gt;</code> | Whether the overlay is currently open. Accepts a plain boolean, a `ref`, or a `computed`. |
| `gridElement?` | <code>MaybeRef&lt;<a href="/grid/api/core/classes/datagridelement/">DataGridElement</a>&lt;any&gt; &#124; unknown &#124; undefined&gt;</code> | Optional explicit grid element. When omitted, the hook resolves the grid by: |

### Property Details

#### `open`

Whether the overlay is currently open. Accepts a plain boolean, a `ref`,
or a `computed`.

Set to `false` to unregister the panel without unmounting it (e.g. when
the consumer toggles visibility via CSS rather than `v-if`). Defaults to
`true`.

---

#### `gridElement`

Optional explicit grid element. When omitted, the hook resolves the
grid by:

1. Walking up the DOM from `panelRef.value` via `closest('tbw-grid, [data-tbw-grid]')`
   (works for inline overlays).
2. Falling back to the GRID_ELEMENT_KEY ref provided by
   `<TbwGrid>` (works for `<Teleport>`-rendered overlays whose DOM is
   detached from the grid subtree).

---