# Overlay

Source: /tuil/docs/reference/packages/ink/api/overlay
Locale: en

function exported by @mwillbanks/tuil-ink.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-ink`.

```ts
export function Overlay({
  id,
  open,
  dismissOnEscape = true,
  onDismiss,
  children,
}: OverlayProps): ReactNode;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member                                                                           | Type           | Required | Description                                                                                                            | Related types                                                    |
| -------------------------------------------------------------------------------- | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `{   id,   open,   dismissOnEscape = true,   onDismiss,   children, }` | `OverlayProps` | Yes      | Supplies the `{   id,   open,   dismissOnEscape = true,   onDismiss,   children, }` value as `OverlayProps`. | [`OverlayProps`](/tuil/docs/reference/packages/ink/api/overlay-props) |

## Returns [#returns]

`ReactNode` — Returns a value that satisfies `ReactNode`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`OverlayProps`](/tuil/docs/reference/packages/ink/api/overlay-props)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ink/src/overlay.tsx)

## Package [#package]

[@mwillbanks/tuil-ink](/tuil/docs/reference/packages/ink)