# OverlayProvider

Source: /tuil/docs/reference/packages/ink/api/overlay-provider
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 OverlayProvider(props: {
  readonly children?: ReactNode;
}): ReactNode;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member  | Type                                             | Required | Description                                                                     | Related types |
| ------- | ------------------------------------------------ | -------- | ------------------------------------------------------------------------------- | ------------- |
| `props` | `{   readonly children?: ReactNode; }` | Yes      | Supplies the `props` value as `{   readonly children?: ReactNode; }`. | —             |

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

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)