# TuilStory

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

interface exported by @mwillbanks/tuil-testing.



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

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-testing`.

```ts
export interface TuilStory<TProps> {
  readonly args: Partial<TProps>;
  readonly description?: string;
  readonly terminal?: Partial<TerminalStoryControls>;
}
```

## Members [#members]

| Member        | Type                                          | Required | Description                                                                            | Related types                                                                           |
| ------------- | --------------------------------------------- | -------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `args`        | `Partial<TProps>`                             | Yes      | The `args` member uses the `Partial<TProps>` contract.                                 | —                                                                                       |
| `description` | `string \| undefined`                         | No       | The `description` member uses the `string \| undefined` contract.                      | —                                                                                       |
| `terminal`    | `Partial<TerminalStoryControls> \| undefined` | No       | The `terminal` member uses the `Partial<TerminalStoryControls> \| undefined` contract. | [`TerminalStoryControls`](/tuil/docs/reference/packages/testing/api/terminal-story-controls) |

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

* [`TerminalStoryControls`](/tuil/docs/reference/packages/testing/api/terminal-story-controls)

## Source [#source]

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

## Package [#package]

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