# PlaygroundDocumentV1

Source: /tuil/docs/reference/packages/ghostty-web/api/playground-document-v1
Locale: en

export exported by @mwillbanks/tuil-ghostty-web.



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

## export [#export]

Public export exported by `@mwillbanks/tuil-ghostty-web`.

```ts
export interface PlaygroundDocumentV1 {
  readonly version: 1;
  readonly root: PlaygroundNodeV1;
  readonly terminal: {
    readonly width: number;
    readonly height: number;
    readonly theme: string;
    readonly colorDepth?: 1 | 4 | 8 | 24;
    readonly unicode?: boolean;
    readonly reducedMotion?: boolean;
  };
}
```

## Members [#members]

| Member     | Type                                                                                                                                                                                            | Required | Description                                                                                                                                                                                                                              | Related types                                                                     |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `version`  | `1`                                                                                                                                                                                             | Yes      | The `version` member uses the `1` contract.                                                                                                                                                                                              | —                                                                                 |
| `root`     | `PlaygroundNodeV1`                                                                                                                                                                              | Yes      | The `root` member uses the `PlaygroundNodeV1` contract.                                                                                                                                                                                  | [`PlaygroundNodeV1`](/tuil/docs/reference/packages/ghostty-web/api/playground-node-v1) |
| `terminal` | `{ readonly width: number; readonly height: number; readonly theme: string; readonly colorDepth?: 1 \| 4 \| 8 \| 24; readonly unicode?: boolean; readonly reducedMotion?: boolean; }` | Yes      | The `terminal` member uses the `{ readonly width: number; readonly height: number; readonly theme: string; readonly colorDepth?: 1 \| 4 \| 8 \| 24; readonly unicode?: boolean; readonly reducedMotion?: boolean; }` 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]

* [`PlaygroundNodeV1`](/tuil/docs/reference/packages/ghostty-web/api/playground-node-v1)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ghostty-web/src/document.tsx)

## Package [#package]

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