# TerminalStoryFrameProps

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

interface exported by @mwillbanks/tuil-story.



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

## interface [#interface]

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

```ts
export interface TerminalStoryFrameProps extends StoryBridgeRequest {
  readonly endpoint?: string;
  readonly className?: string;
  readonly inspector?: boolean;
}
```

## Members [#members]

| Member      | Type                                             | Required | Description                                                                            | Related types                                                                         |
| ----------- | ------------------------------------------------ | -------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `endpoint`  | `string \| undefined`                            | No       | The `endpoint` member uses the `string \| undefined` contract.                         | —                                                                                     |
| `className` | `string \| undefined`                            | No       | The `className` member uses the `string \| undefined` contract.                        | —                                                                                     |
| `inspector` | `boolean \| undefined`                           | No       | The `inspector` member uses the `boolean \| undefined` contract.                       | —                                                                                     |
| `storyId`   | `string`                                         | Yes      | The `storyId` member uses the `string` contract.                                       | —                                                                                     |
| `variant`   | `string`                                         | Yes      | The `variant` member uses the `string` contract.                                       | —                                                                                     |
| `args`      | `Readonly<Record<string, unknown>> \| undefined` | No       | The `args` member uses the `Readonly<Record<string, unknown>> \| undefined` contract.  | —                                                                                     |
| `controls`  | `Partial<TerminalStoryControls> \| undefined`    | No       | The `controls` member uses the `Partial<TerminalStoryControls> \| undefined` contract. | [`TerminalStoryControls`](/tuil/docs/reference/packages/story/api/terminal-story-controls) |
| `inputs`    | `readonly string[] \| undefined`                 | No       | The `inputs` member uses the `readonly 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]

* [`StoryBridgeRequest`](/tuil/docs/reference/packages/story/api/story-bridge-request)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/story/src/browser.tsx)

## Package [#package]

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