FumadocsStoryProps
type exported by @mwillbanks/tuil-story.
type
Public type exported by @mwillbanks/tuil-story.
export type FumadocsStoryProps = Readonly<
Record<string, unknown> & {
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;
}
>;Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
terminalWidth | number | Yes | The terminalWidth member uses the number contract. | — |
terminalHeight | number | Yes | The terminalHeight member uses the number contract. | — |
terminalColorDepth | 1 | 4 | 8 | 24 | Yes | The terminalColorDepth member uses the 1 | 4 | 8 | 24 contract. | — |
terminalUnicode | boolean | Yes | The terminalUnicode member uses the boolean contract. | — |
terminalTheme | string | Yes | The terminalTheme member uses the string contract. | — |
terminalPlatform | NodeJS.Platform | Yes | The terminalPlatform member uses the NodeJS.Platform contract. | — |
terminalInteractive | boolean | Yes | The terminalInteractive member uses the boolean contract. | — |
terminalReducedMotion | boolean | Yes | The terminalReducedMotion member uses the boolean contract. | — |
terminalMouse | boolean | Yes | The terminalMouse member uses the boolean contract. | — |
terminalHyperlinks | boolean | Yes | The terminalHyperlinks member uses the boolean contract. | — |
terminalInput | string | undefined | No | The terminalInput member uses the 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
No package-local related types.
Source
View the secondary source reference