# useOverlayStatus

Source: /tuil/docs/reference/packages/ink/api/use-overlay-status
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 useOverlayStatus(): OverlayStatus;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

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

Related types: [`OverlayStatus`](/tuil/docs/reference/packages/ink/api/overlay-status)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`OverlayStatus`](/tuil/docs/reference/packages/ink/api/overlay-status)

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