# OpenStoryOptions

Source: /tuil/docs/reference/packages/story/api/open-story-options
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 OpenStoryOptions {
  readonly storyId: string;
  readonly variant: string;
  readonly args?: Readonly<Record<string, unknown>>;
  readonly controls?: Partial<TerminalStoryControls>;
  readonly themeRegistry?: ThemeRegistry;
  readonly signal?: AbortSignal;
}
```

## Members [#members]

| Member          | Type                                             | Required | Description                                                                            | Related types                                                                         |
| --------------- | ------------------------------------------------ | -------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `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) |
| `themeRegistry` | `ThemeRegistry \| undefined`                     | No       | The `themeRegistry` member uses the `ThemeRegistry \| undefined` contract.             | [`ThemeRegistry`](/tuil/docs/reference/packages/theme/api/theme-registry)                  |
| `signal`        | `AbortSignal \| undefined`                       | No       | The `signal` member uses the `AbortSignal \| 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]

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

## Source [#source]

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

## Package [#package]

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