FumadocsStoryConfig
interface exported by @mwillbanks/tuil-story.
interface
Public interface exported by @mwillbanks/tuil-story.
export interface FumadocsStoryConfig {
readonly Component: FunctionComponent<FumadocsStoryProps>;
readonly args: {
readonly initial: FumadocsStoryProps;
};
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
Component | FunctionComponent<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; }>> | Yes | The Component member uses the FunctionComponent<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; }>> contract. | — |
args | { readonly initial: FumadocsStoryProps; } | Yes | The args member uses the { readonly initial: FumadocsStoryProps; } contract. | FumadocsStoryProps |
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