# FumadocsStoryConfig

Source: /tuil/docs/reference/packages/story/api/fumadocs-story-config
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 FumadocsStoryConfig {
  readonly Component: FunctionComponent<FumadocsStoryProps>;
  readonly args: {
    readonly initial: FumadocsStoryProps;
  };
}
```

## Members [#members]

| Member      | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Related types                                                                   |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `Component` | `FunctionComponent<Readonly<Record<string, unknown> & &#123; readonly terminalWidth: number; readonly terminalHeight: number; readonly terminalColorDepth: 1 \| 4 \| 8 \| 24; readonly terminalUnicode: boolean; readonly terminalTheme: string; readonly terminalPlatform: NodeJS.Platform; readonly terminalInteractive: boolean; readonly terminalReducedMotion: boolean; readonly terminalMouse: boolean; readonly terminalHyperlinks: boolean; readonly terminalInput?: string; &#125;>>` | Yes      | The `Component` member uses the `FunctionComponent<Readonly<Record<string, unknown> & &#123; readonly terminalWidth: number; readonly terminalHeight: number; readonly terminalColorDepth: 1 \| 4 \| 8 \| 24; readonly terminalUnicode: boolean; readonly terminalTheme: string; readonly terminalPlatform: NodeJS.Platform; readonly terminalInteractive: boolean; readonly terminalReducedMotion: boolean; readonly terminalMouse: boolean; readonly terminalHyperlinks: boolean; readonly terminalInput?: string; &#125;>>` contract. | —                                                                               |
| `args`      | `&#123; readonly initial: FumadocsStoryProps; &#125;`                                                                                                                                                                                                                                                                                                                                                                                                                                          | Yes      | The `args` member uses the `&#123; readonly initial: FumadocsStoryProps; &#125;` contract.                                                                                                                                                                                                                                                                                                                                                                                                                                               | [`FumadocsStoryProps`](/tuil/docs/reference/packages/story/api/fumadocs-story-props) |

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

* [`FumadocsStoryProps`](/tuil/docs/reference/packages/story/api/fumadocs-story-props)

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