# TerminalStoryControls

Source: /tuil/docs/reference/packages/story/api/terminal-story-controls
Locale: en

export exported by @mwillbanks/tuil-story.



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

## export [#export]

Public export exported by `@mwillbanks/tuil-story`.

```ts
export interface TerminalStoryControls {
  readonly width: number;
  readonly height: number;
  readonly colorDepth: 1 | 4 | 8 | 24;
  readonly unicode: boolean;
  readonly theme: string;
  readonly platform: NodeJS.Platform;
  readonly interactive: boolean;
  readonly reducedMotion: boolean;
  readonly mouse: boolean;
  readonly hyperlinks: boolean;
}
```

## Members [#members]

| Member          | Type                | Required | Description                                                    | Related types |
| --------------- | ------------------- | -------- | -------------------------------------------------------------- | ------------- |
| `width`         | `number`            | Yes      | The `width` member uses the `number` contract.                 | —             |
| `height`        | `number`            | Yes      | The `height` member uses the `number` contract.                | —             |
| `colorDepth`    | `1 \| 4 \| 8 \| 24` | Yes      | The `colorDepth` member uses the `1 \| 4 \| 8 \| 24` contract. | —             |
| `unicode`       | `boolean`           | Yes      | The `unicode` member uses the `boolean` contract.              | —             |
| `theme`         | `string`            | Yes      | The `theme` member uses the `string` contract.                 | —             |
| `platform`      | `NodeJS.Platform`   | Yes      | The `platform` member uses the `NodeJS.Platform` contract.     | —             |
| `interactive`   | `boolean`           | Yes      | The `interactive` member uses the `boolean` contract.          | —             |
| `reducedMotion` | `boolean`           | Yes      | The `reducedMotion` member uses the `boolean` contract.        | —             |
| `mouse`         | `boolean`           | Yes      | The `mouse` member uses the `boolean` contract.                | —             |
| `hyperlinks`    | `boolean`           | Yes      | The `hyperlinks` member uses the `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]

No package-local related types.

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/testing/src/index.ts)

## Package [#package]

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