TerminalStoryFrameProps
interface exported by @mwillbanks/tuil-story.
interface
Public interface exported by @mwillbanks/tuil-story.
export interface TerminalStoryFrameProps extends StoryBridgeRequest {
readonly endpoint?: string;
readonly className?: string;
readonly inspector?: boolean;
}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 |
inputs | readonly string[] | undefined | No | The inputs member uses the readonly string[] | undefined contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference