# OverlayProps

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

interface exported by @mwillbanks/tuil-ink.



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

## interface [#interface]

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

```ts
export interface OverlayProps {
  readonly id: string;
  readonly open: boolean;
  readonly dismissOnEscape?: boolean;
  readonly onDismiss?: () => void | Promise<void>;
  readonly children?: ReactNode;
}
```

## Members [#members]

| Member            | Type                                         | Required | Description                                                                            | Related types |
| ----------------- | -------------------------------------------- | -------- | -------------------------------------------------------------------------------------- | ------------- |
| `id`              | `string`                                     | Yes      | The `id` member uses the `string` contract.                                            | —             |
| `open`            | `boolean`                                    | Yes      | The `open` member uses the `boolean` contract.                                         | —             |
| `dismissOnEscape` | `boolean \| undefined`                       | No       | The `dismissOnEscape` member uses the `boolean \| undefined` contract.                 | —             |
| `onDismiss`       | `(() => void \| Promise<void>) \| undefined` | No       | The `onDismiss` member uses the `(() => void \| Promise<void>) \| undefined` contract. | —             |
| `children`        | `ReactNode`                                  | No       | The `children` member uses the `ReactNode` contract.                                   | —             |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## 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)