UNPKG

1.07 kBTypeScriptView Raw
1import { MethodDescriptor, PropDescriptor, TagProps } from 'react-docgen';
2import { RequireItResult } from './RsgRequireItResult';
3import { Example } from './RsgExample';
4export declare type ExpandMode = 'expand' | 'collapse' | 'hide';
5export interface BaseComponent {
6 hasExamples?: boolean;
7 name?: string;
8 slug?: string;
9 href?: string;
10 filepath?: string;
11 pathLine?: string;
12 description?: string;
13 exampleMode?: ExpandMode;
14 usageMode?: ExpandMode;
15}
16export interface Component extends BaseComponent {
17 visibleName?: string;
18 props?: {
19 displayName?: string;
20 visibleName?: string;
21 description?: string;
22 methods?: MethodDescriptor[];
23 props?: PropDescriptor[];
24 tags?: TagProps;
25 example?: Example[];
26 examples?: Example[];
27 };
28 module?: number;
29 metadata?: {
30 tags?: string[];
31 };
32}
33export interface LoaderComponent extends BaseComponent {
34 module: RequireItResult;
35 props: RequireItResult;
36 metadata: RequireItResult | Record<string, unknown>;
37}