# OverlayStatus

Source: /tuil/docs/reference/packages/ink/api/overlay-status
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 OverlayStatus {
  readonly active: boolean;
  readonly count: number;
  readonly topId?: string;
  readonly getTopId: () => string | undefined;
}
```

## Members [#members]

| Member     | Type                        | Required | Description                                                          | Related types |
| ---------- | --------------------------- | -------- | -------------------------------------------------------------------- | ------------- |
| `active`   | `boolean`                   | Yes      | The `active` member uses the `boolean` contract.                     | —             |
| `count`    | `number`                    | Yes      | The `count` member uses the `number` contract.                       | —             |
| `topId`    | `string \| undefined`       | No       | The `topId` member uses the `string \| undefined` contract.          | —             |
| `getTopId` | `() => string \| undefined` | Yes      | The `getTopId` member uses the `() => string \| undefined` 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)